List
|
|||||
|
|
Enumerate ManagedZones that have been created but not yet deleted
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- View and manage your data across Google Cloud Platform services
- View your data across Google Cloud Platform services
- View your DNS records hosted by Google Cloud DNS
- View and manage your DNS records hosted by Google Cloud DNS
Input
This building block consumes 4 input parameters
Name | Format | Description |
---|---|---|
project Required |
STRING |
Identifies the project addressed by this request |
dnsName |
STRING |
Restricts the list to return only zones with this domain name |
maxResults |
INTEGER |
Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return |
pageToken |
STRING |
Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request |
= Parameter name
= Format
project STRING Required Identifies the project addressed by this request |
dnsName STRING Restricts the list to return only zones with this domain name |
maxResults INTEGER Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return |
pageToken STRING Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request |
Output
This building block provides 24 output parameters
Name | Format | Description |
---|---|---|
header |
OBJECT |
Elements common to every response |
header.operationId |
STRING |
For mutating operation requests that completed successfully. This is the client_operation_id if the client specified it, otherwise it is generated by the server (output only) |
kind |
STRING |
Type of resource |
managedZones[] |
OBJECT |
A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service |
managedZones[].creationTime |
STRING |
The time that this resource was created on the server. This is in RFC3339 text format. Output only |
managedZones[].description |
STRING |
A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function |
managedZones[].dnsName |
STRING |
The DNS name of this managed zone, for instance "example.com." |
managedZones[].dnssecConfig |
OBJECT |
|
managedZones[].dnssecConfig.defaultKeySpecs[] |
OBJECT |
Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey |
managedZones[].dnssecConfig.kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneDnsSecConfig" |
managedZones[].dnssecConfig.nonExistence |
ENUMERATION |
Specifies the mechanism used to provide authenticated denial-of-existence responses. Output only while state is not OFF |
managedZones[].dnssecConfig.state |
ENUMERATION |
Specifies whether DNSSEC is enabled, and what mode it is in |
managedZones[].id |
INTEGER |
Unique identifier for the resource; defined by the server (output only) |
managedZones[].kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dns#managedZone" |
managedZones[].labels |
OBJECT |
User labels |
managedZones[].labels.customKey.value |
STRING |
User labels |
managedZones[].name |
STRING |
User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes |
managedZones[].nameServerSet |
STRING |
Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users will leave this field unset |
managedZones[].nameServers[] |
STRING |
|
managedZones[].privateVisibilityConfig |
OBJECT |
|
managedZones[].privateVisibilityConfig.kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePrivateVisibilityConfig" |
managedZones[].privateVisibilityConfig.networks[] |
OBJECT |
|
managedZones[].visibility |
ENUMERATION |
The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources |
nextPageToken |
STRING |
The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your page token. In this way you can retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned will be an inconsistent view of the collection. There is no way to retrieve a consistent snapshot of a collection larger than the maximum page size |
= Parameter name
= Format
header OBJECT Elements common to every response |
header.operationId STRING For mutating operation requests that completed successfully. This is the client_operation_id if the client specified it, otherwise it is generated by the server (output only) |
kind STRING Type of resource |
managedZones[] OBJECT A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service |
managedZones[].creationTime STRING The time that this resource was created on the server. This is in RFC3339 text format. Output only |
managedZones[].description STRING A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function |
managedZones[].dnsName STRING The DNS name of this managed zone, for instance "example.com." |
managedZones[].dnssecConfig OBJECT |
managedZones[].dnssecConfig.defaultKeySpecs[] OBJECT Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey |
managedZones[].dnssecConfig.kind STRING Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneDnsSecConfig" |
managedZones[].dnssecConfig.nonExistence ENUMERATION Specifies the mechanism used to provide authenticated denial-of-existence responses. Output only while state is not OFF |
managedZones[].dnssecConfig.state ENUMERATION Specifies whether DNSSEC is enabled, and what mode it is in |
managedZones[].id INTEGER Unique identifier for the resource; defined by the server (output only) |
managedZones[].kind STRING Identifies what kind of resource this is. Value: the fixed string "dns#managedZone" |
managedZones[].labels OBJECT User labels |
managedZones[].labels.customKey.value STRING User labels |
managedZones[].name STRING User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes |
managedZones[].nameServerSet STRING Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users will leave this field unset |
managedZones[].nameServers[] STRING |
managedZones[].privateVisibilityConfig OBJECT |
managedZones[].privateVisibilityConfig.kind STRING Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePrivateVisibilityConfig" |
managedZones[].privateVisibilityConfig.networks[] OBJECT |
managedZones[].visibility ENUMERATION The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources |
nextPageToken STRING The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your page token. In this way you can retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned will be an inconsistent view of the collection. There is no way to retrieve a consistent snapshot of a collection larger than the maximum page size |