List
|
|||||
|
|
||||
Enumerate Operations for the given ManagedZone
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 5 input parameters
| Name | Format | Description |
|---|---|---|
project Required |
STRING |
Identifies the project addressed by this request |
managedZone Required |
STRING |
Identifies the managed zone addressed by this request |
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 |
sortBy |
ENUMERATION |
Sorting criterion. The only supported values are START_TIME and ID |
= Parameter name
= Format
|
project STRING Required Identifies the project addressed by this request |
|
managedZone STRING Required Identifies the managed zone addressed by this request |
|
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 |
|
sortBy ENUMERATION Sorting criterion. The only supported values are START_TIME and ID |
Output
This building block provides 59 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 |
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 |
operations[] |
OBJECT |
An operation represents a successful mutation performed on a Cloud DNS resource. Operations provide: - An audit log of server resource mutations. - A way to recover/retry API calls in the case where the response is never received by the caller. Use the caller specified client_operation_id |
operations[].dnsKeyContext |
OBJECT |
|
operations[].dnsKeyContext.newValue |
OBJECT |
A DNSSEC key pair |
operations[].dnsKeyContext.newValue.algorithm |
ENUMERATION |
String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time |
operations[].dnsKeyContext.newValue.creationTime |
STRING |
The time that this resource was created in the control plane. This is in RFC3339 text format. Output only |
operations[].dnsKeyContext.newValue.description |
STRING |
A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the resource's function |
operations[].dnsKeyContext.newValue.id |
STRING |
Unique identifier for the resource; defined by the server (output only) |
operations[].dnsKeyContext.newValue.isActive |
BOOLEAN |
Active keys will be used to sign subsequent changes to the ManagedZone. Inactive keys will still be present as DNSKEY Resource Records for the use of resolvers validating existing signatures |
operations[].dnsKeyContext.newValue.keyLength |
INTEGER |
Length of the key in bits. Specified at creation time then immutable |
operations[].dnsKeyContext.newValue.keyTag |
INTEGER |
The key tag is a non-cryptographic hash of the a DNSKEY resource record associated with this DnsKey. The key tag can be used to identify a DNSKEY more quickly (but it is not a unique identifier). In particular, the key tag is used in a parent zone's DS record to point at the DNSKEY in this child ManagedZone. The key tag is a number in the range [0, 65535] and the algorithm to calculate it is specified in RFC4034 Appendix B. Output only |
operations[].dnsKeyContext.newValue.kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dns#dnsKey" |
operations[].dnsKeyContext.newValue.publicKey |
STRING |
Base64 encoded public half of this key. Output only |
operations[].dnsKeyContext.newValue.type |
ENUMERATION |
One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types. Immutable after creation time |
operations[].dnsKeyContext.oldValue |
OBJECT |
A DNSSEC key pair |
operations[].dnsKeyContext.oldValue.algorithm |
ENUMERATION |
String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time |
operations[].dnsKeyContext.oldValue.creationTime |
STRING |
The time that this resource was created in the control plane. This is in RFC3339 text format. Output only |
operations[].dnsKeyContext.oldValue.description |
STRING |
A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the resource's function |
operations[].dnsKeyContext.oldValue.id |
STRING |
Unique identifier for the resource; defined by the server (output only) |
operations[].dnsKeyContext.oldValue.isActive |
BOOLEAN |
Active keys will be used to sign subsequent changes to the ManagedZone. Inactive keys will still be present as DNSKEY Resource Records for the use of resolvers validating existing signatures |
operations[].dnsKeyContext.oldValue.keyLength |
INTEGER |
Length of the key in bits. Specified at creation time then immutable |
operations[].dnsKeyContext.oldValue.keyTag |
INTEGER |
The key tag is a non-cryptographic hash of the a DNSKEY resource record associated with this DnsKey. The key tag can be used to identify a DNSKEY more quickly (but it is not a unique identifier). In particular, the key tag is used in a parent zone's DS record to point at the DNSKEY in this child ManagedZone. The key tag is a number in the range [0, 65535] and the algorithm to calculate it is specified in RFC4034 Appendix B. Output only |
operations[].dnsKeyContext.oldValue.kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dns#dnsKey" |
operations[].dnsKeyContext.oldValue.publicKey |
STRING |
Base64 encoded public half of this key. Output only |
operations[].dnsKeyContext.oldValue.type |
ENUMERATION |
One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types. Immutable after creation time |
operations[].id |
STRING |
Unique identifier for the resource. This is the client_operation_id if the client specified it when the mutation was initiated, otherwise, it is generated by the server. The name must be 1-63 characters long and match the regular expression [-a-z0-9]? (output only) |
operations[].kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dns#operation" |
operations[].startTime |
STRING |
The time that this operation was started by the server. This is in RFC3339 text format (output only) |
operations[].status |
ENUMERATION |
Status of the operation. Can be one of the following: "PENDING" or "DONE" (output only). A status of "DONE" means that the request to update the authoritative servers has been sent, but the servers might not be updated yet |
operations[].type |
STRING |
Type of the operation. Operations include insert, update, and delete (output only) |
operations[].user |
STRING |
User who requested the operation, for example: user@example.com. cloud-dns-system for operations automatically done by the system. (output only) |
operations[].zoneContext |
OBJECT |
|
operations[].zoneContext.newValue |
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 |
operations[].zoneContext.newValue.creationTime |
STRING |
The time that this resource was created on the server. This is in RFC3339 text format. Output only |
operations[].zoneContext.newValue.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 |
operations[].zoneContext.newValue.dnsName |
STRING |
The DNS name of this managed zone, for instance "example.com." |
operations[].zoneContext.newValue.id |
INTEGER |
Unique identifier for the resource; defined by the server (output only) |
operations[].zoneContext.newValue.kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dns#managedZone" |
operations[].zoneContext.newValue.labels |
OBJECT |
User labels |
operations[].zoneContext.newValue.labels.customKey.value |
STRING |
User labels |
operations[].zoneContext.newValue.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 |
operations[].zoneContext.newValue.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 |
operations[].zoneContext.newValue.nameServers[] |
STRING |
|
operations[].zoneContext.newValue.visibility |
ENUMERATION |
The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources |
operations[].zoneContext.oldValue |
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 |
operations[].zoneContext.oldValue.creationTime |
STRING |
The time that this resource was created on the server. This is in RFC3339 text format. Output only |
operations[].zoneContext.oldValue.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 |
operations[].zoneContext.oldValue.dnsName |
STRING |
The DNS name of this managed zone, for instance "example.com." |
operations[].zoneContext.oldValue.id |
INTEGER |
Unique identifier for the resource; defined by the server (output only) |
operations[].zoneContext.oldValue.kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dns#managedZone" |
operations[].zoneContext.oldValue.labels |
OBJECT |
User labels |
operations[].zoneContext.oldValue.labels.customKey.value |
STRING |
User labels |
operations[].zoneContext.oldValue.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 |
operations[].zoneContext.oldValue.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 |
operations[].zoneContext.oldValue.nameServers[] |
STRING |
|
operations[].zoneContext.oldValue.visibility |
ENUMERATION |
The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources |
= 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 |
|
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 |
|
operations[] OBJECT An operation represents a successful mutation performed on a Cloud DNS resource. Operations provide: - An audit log of server resource mutations. - A way to recover/retry API calls in the case where the response is never received by the caller. Use the caller specified client_operation_id |
|
operations[].dnsKeyContext OBJECT |
|
operations[].dnsKeyContext.newValue OBJECT A DNSSEC key pair |
|
operations[].dnsKeyContext.newValue.algorithm ENUMERATION String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time |
|
operations[].dnsKeyContext.newValue.creationTime STRING The time that this resource was created in the control plane. This is in RFC3339 text format. Output only |
|
operations[].dnsKeyContext.newValue.description STRING A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the resource's function |
|
operations[].dnsKeyContext.newValue.id STRING Unique identifier for the resource; defined by the server (output only) |
|
operations[].dnsKeyContext.newValue.isActive BOOLEAN Active keys will be used to sign subsequent changes to the ManagedZone. Inactive keys will still be present as DNSKEY Resource Records for the use of resolvers validating existing signatures |
|
operations[].dnsKeyContext.newValue.keyLength INTEGER Length of the key in bits. Specified at creation time then immutable |
|
operations[].dnsKeyContext.newValue.keyTag INTEGER The key tag is a non-cryptographic hash of the a DNSKEY resource record associated with this DnsKey. The key tag can be used to identify a DNSKEY more quickly (but it is not a unique identifier). In particular, the key tag is used in a parent zone's DS record to point at the DNSKEY in this child ManagedZone. The key tag is a number in the range [0, 65535] and the algorithm to calculate it is specified in RFC4034 Appendix B. Output only |
|
operations[].dnsKeyContext.newValue.kind STRING Identifies what kind of resource this is. Value: the fixed string "dns#dnsKey" |
|
operations[].dnsKeyContext.newValue.publicKey STRING Base64 encoded public half of this key. Output only |
|
operations[].dnsKeyContext.newValue.type ENUMERATION One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types. Immutable after creation time |
|
operations[].dnsKeyContext.oldValue OBJECT A DNSSEC key pair |
|
operations[].dnsKeyContext.oldValue.algorithm ENUMERATION String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time |
|
operations[].dnsKeyContext.oldValue.creationTime STRING The time that this resource was created in the control plane. This is in RFC3339 text format. Output only |
|
operations[].dnsKeyContext.oldValue.description STRING A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the resource's function |
|
operations[].dnsKeyContext.oldValue.id STRING Unique identifier for the resource; defined by the server (output only) |
|
operations[].dnsKeyContext.oldValue.isActive BOOLEAN Active keys will be used to sign subsequent changes to the ManagedZone. Inactive keys will still be present as DNSKEY Resource Records for the use of resolvers validating existing signatures |
|
operations[].dnsKeyContext.oldValue.keyLength INTEGER Length of the key in bits. Specified at creation time then immutable |
|
operations[].dnsKeyContext.oldValue.keyTag INTEGER The key tag is a non-cryptographic hash of the a DNSKEY resource record associated with this DnsKey. The key tag can be used to identify a DNSKEY more quickly (but it is not a unique identifier). In particular, the key tag is used in a parent zone's DS record to point at the DNSKEY in this child ManagedZone. The key tag is a number in the range [0, 65535] and the algorithm to calculate it is specified in RFC4034 Appendix B. Output only |
|
operations[].dnsKeyContext.oldValue.kind STRING Identifies what kind of resource this is. Value: the fixed string "dns#dnsKey" |
|
operations[].dnsKeyContext.oldValue.publicKey STRING Base64 encoded public half of this key. Output only |
|
operations[].dnsKeyContext.oldValue.type ENUMERATION One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types. Immutable after creation time |
|
operations[].id STRING Unique identifier for the resource. This is the client_operation_id if the client specified it when the mutation was initiated, otherwise, it is generated by the server. The name must be 1-63 characters long and match the regular expression [-a-z0-9]? (output only) |
|
operations[].kind STRING Identifies what kind of resource this is. Value: the fixed string "dns#operation" |
|
operations[].startTime STRING The time that this operation was started by the server. This is in RFC3339 text format (output only) |
|
operations[].status ENUMERATION Status of the operation. Can be one of the following: "PENDING" or "DONE" (output only). A status of "DONE" means that the request to update the authoritative servers has been sent, but the servers might not be updated yet |
|
operations[].type STRING Type of the operation. Operations include insert, update, and delete (output only) |
|
operations[].user STRING User who requested the operation, for example: user@example.com. cloud-dns-system for operations automatically done by the system. (output only) |
|
operations[].zoneContext OBJECT |
|
operations[].zoneContext.newValue 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 |
|
operations[].zoneContext.newValue.creationTime STRING The time that this resource was created on the server. This is in RFC3339 text format. Output only |
|
operations[].zoneContext.newValue.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 |
|
operations[].zoneContext.newValue.dnsName STRING The DNS name of this managed zone, for instance "example.com." |
|
operations[].zoneContext.newValue.id INTEGER Unique identifier for the resource; defined by the server (output only) |
|
operations[].zoneContext.newValue.kind STRING Identifies what kind of resource this is. Value: the fixed string "dns#managedZone" |
|
operations[].zoneContext.newValue.labels OBJECT User labels |
|
operations[].zoneContext.newValue.labels.customKey.value STRING User labels |
|
operations[].zoneContext.newValue.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 |
|
operations[].zoneContext.newValue.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 |
|
operations[].zoneContext.newValue.nameServers[] STRING |
|
operations[].zoneContext.newValue.visibility ENUMERATION The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources |
|
operations[].zoneContext.oldValue 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 |
|
operations[].zoneContext.oldValue.creationTime STRING The time that this resource was created on the server. This is in RFC3339 text format. Output only |
|
operations[].zoneContext.oldValue.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 |
|
operations[].zoneContext.oldValue.dnsName STRING The DNS name of this managed zone, for instance "example.com." |
|
operations[].zoneContext.oldValue.id INTEGER Unique identifier for the resource; defined by the server (output only) |
|
operations[].zoneContext.oldValue.kind STRING Identifies what kind of resource this is. Value: the fixed string "dns#managedZone" |
|
operations[].zoneContext.oldValue.labels OBJECT User labels |
|
operations[].zoneContext.oldValue.labels.customKey.value STRING User labels |
|
operations[].zoneContext.oldValue.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 |
|
operations[].zoneContext.oldValue.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 |
|
operations[].zoneContext.oldValue.nameServers[] STRING |
|
operations[].zoneContext.oldValue.visibility ENUMERATION The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources |