Fetch the representation of an existing Change.
Name | Data Type | Description |
---|---|---|
changeId
|
string |
The identifier of the requested change, from a previous ResourceRecordSetsChangeResponse. |
managedZone
|
string |
Identifies the managed zone addressed by this request. Can be the managed zone name or id. |
project
|
string |
Identifies the project addressed by this request. |
Name | Data Type | Description |
---|---|---|
clientOperationId
|
string |
For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Change | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Enumerate Changes to a ResourceRecordSet collection.
Name | Data Type | Description |
---|---|---|
managedZone
|
string |
Identifies the managed zone addressed by this request. Can be the managed zone name or id. |
project
|
string |
Identifies the project addressed by this request. |
Name | Data Type | Description |
---|---|---|
sortOrder
|
string |
Sorting order direction: 'ascending' or 'descending'. |
sortBy
|
string Default value: changeSequence Allowed values: - changeSequence |
Sorting criterion. The only supported value is change sequence. |
pageToken
|
string |
Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request. |
maxResults
|
integer |
Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return. |
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
ChangesListResponse | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Atomically update the ResourceRecordSet collection.
Name | Data Type | Description |
---|---|---|
managedZone
|
string |
Identifies the managed zone addressed by this request. Can be the managed zone name or id. |
project
|
string |
Identifies the project addressed by this request. |
Name | Data Type | Description |
---|---|---|
clientOperationId
|
string |
For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Change | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Change | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Fetch the representation of an existing DnsKey.
Name | Data Type | Description |
---|---|---|
dnsKeyId
|
string |
The identifier of the requested DnsKey. |
managedZone
|
string |
Identifies the managed zone addressed by this request. Can be the managed zone name or id. |
project
|
string |
Identifies the project addressed by this request. |
Name | Data Type | Description |
---|---|---|
digestType
|
string |
An optional comma-separated list of digest types to compute and display for key signing keys. If omitted, the recommended digest type will be computed and displayed. |
clientOperationId
|
string |
For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. |
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
DnsKey | |||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Enumerate DnsKeys to a ResourceRecordSet collection.
Name | Data Type | Description |
---|---|---|
managedZone
|
string |
Identifies the managed zone addressed by this request. Can be the managed zone name or id. |
project
|
string |
Identifies the project addressed by this request. |
Name | Data Type | Description |
---|---|---|
pageToken
|
string |
Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request. |
maxResults
|
integer |
Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return. |
digestType
|
string |
An optional comma-separated list of digest types to compute and display for key signing keys. If omitted, the recommended digest type will be computed and displayed. |
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
DnsKeysListResponse | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Fetch the representation of an existing Operation.
Name | Data Type | Description |
---|---|---|
operation
|
string |
Identifies the operation addressed by this request. |
managedZone
|
string |
Identifies the managed zone addressed by this request. |
project
|
string |
Identifies the project addressed by this request. |
Name | Data Type | Description |
---|---|---|
clientOperationId
|
string |
For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. |
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Operation | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Enumerate Operations for the given ManagedZone.
Name | Data Type | Description |
---|---|---|
managedZone
|
string |
Identifies the managed zone addressed by this request. |
project
|
string |
Identifies the project addressed by this request. |
Name | Data Type | Description |
---|---|---|
sortBy
|
string Default value: startTime Allowed values: - id - startTime |
Sorting criterion. The only supported values are START_TIME and ID. |
pageToken
|
string |
Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request. |
maxResults
|
integer |
Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return. |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
ManagedZoneOperationsListResponse | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Delete a previously created ManagedZone.
Name | Data Type | Description |
---|---|---|
managedZone
|
string |
Identifies the managed zone addressed by this request. Can be the managed zone name or id. |
project
|
string |
Identifies the project addressed by this request. |
Name | Data Type | Description |
---|---|---|
clientOperationId
|
string |
For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. |
Fetch the representation of an existing ManagedZone.
Name | Data Type | Description |
---|---|---|
managedZone
|
string |
Identifies the managed zone addressed by this request. Can be the managed zone name or id. |
project
|
string |
Identifies the project addressed by this request. |
Name | Data Type | Description |
---|---|---|
clientOperationId
|
string |
For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. |
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
ManagedZone | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Apply a partial update to an existing ManagedZone.
Name | Data Type | Description |
---|---|---|
managedZone
|
string |
Identifies the managed zone addressed by this request. Can be the managed zone name or id. |
project
|
string |
Identifies the project addressed by this request. |
Name | Data Type | Description |
---|---|---|
clientOperationId
|
string |
For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. |
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
ManagedZone | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Operation | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Update an existing ManagedZone.
Name | Data Type | Description |
---|---|---|
managedZone
|
string |
Identifies the managed zone addressed by this request. Can be the managed zone name or id. |
project
|
string |
Identifies the project addressed by this request. |
Name | Data Type | Description |
---|---|---|
clientOperationId
|
string |
For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. |
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
ManagedZone | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Operation | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Enumerate ManagedZones that have been created but not yet deleted.
Name | Data Type | Description |
---|---|---|
project
|
string |
Identifies the project addressed by this request. |
Name | Data Type | Description |
---|---|---|
pageToken
|
string |
Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request. |
maxResults
|
integer |
Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return. |
dnsName
|
string |
Restricts the list to return only zones with this domain name. |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
ManagedZonesListResponse | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Create a new ManagedZone.
Name | Data Type | Description |
---|---|---|
project
|
string |
Identifies the project addressed by this request. |
Name | Data Type | Description |
---|---|---|
clientOperationId
|
string |
For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. |
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
ManagedZone | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
ManagedZone | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Delete a previously created Policy. Will fail if the policy is still being referenced by a network.
Name | Data Type | Description |
---|---|---|
policy
|
string |
User given friendly name of the policy addressed by this request. |
project
|
string |
Identifies the project addressed by this request. |
Name | Data Type | Description |
---|---|---|
clientOperationId
|
string |
For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. |
Fetch the representation of an existing Policy.
Name | Data Type | Description |
---|---|---|
policy
|
string |
User given friendly name of the policy addressed by this request. |
project
|
string |
Identifies the project addressed by this request. |
Name | Data Type | Description |
---|---|---|
clientOperationId
|
string |
For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. |
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Policy | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Apply a partial update to an existing Policy.
Name | Data Type | Description |
---|---|---|
policy
|
string |
User given friendly name of the policy addressed by this request. |
project
|
string |
Identifies the project addressed by this request. |
Name | Data Type | Description |
---|---|---|
clientOperationId
|
string |
For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. |
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Policy | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
PoliciesPatchResponse | ||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Update an existing Policy.
Name | Data Type | Description |
---|---|---|
policy
|
string |
User given friendly name of the policy addressed by this request. |
project
|
string |
Identifies the project addressed by this request. |
Name | Data Type | Description |
---|---|---|
clientOperationId
|
string |
For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. |
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Policy | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
PoliciesUpdateResponse | ||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Enumerate all Policies associated with a project.
Name | Data Type | Description |
---|---|---|
project
|
string |
Identifies the project addressed by this request. |
Name | Data Type | Description |
---|---|---|
pageToken
|
string |
Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request. |
maxResults
|
integer |
Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return. |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
PoliciesListResponse | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Create a new Policy
Name | Data Type | Description |
---|---|---|
project
|
string |
Identifies the project addressed by this request. |
Name | Data Type | Description |
---|---|---|
clientOperationId
|
string |
For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. |
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Policy | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Policy | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Fetch the representation of an existing Project.
Name | Data Type | Description |
---|---|---|
project
|
string |
Identifies the project addressed by this request. |
Name | Data Type | Description |
---|---|---|
clientOperationId
|
string |
For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. |
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Project | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Enumerate ResourceRecordSets that have been created but not yet deleted.
Name | Data Type | Description |
---|---|---|
managedZone
|
string |
Identifies the managed zone addressed by this request. Can be the managed zone name or id. |
project
|
string |
Identifies the project addressed by this request. |
Name | Data Type | Description |
---|---|---|
type
|
string |
Restricts the list to return only records of this type. If present, the "name" parameter must also be present. |
pageToken
|
string |
Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request. |
name
|
string |
Restricts the list to return only records with this fully qualified domain name. |
maxResults
|
integer |
Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return. |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
ResourceRecordSetsListResponse | ||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
A Change represents a set of ResourceRecordSet additions and deletions applied atomically to a ManagedZone. ResourceRecordSets within a ManagedZone are modified by creating a new Change element in the Changes collection. In turn the Changes collection also records the past modifications to the ResourceRecordSets in a ManagedZone. The current state of the ManagedZone is the sum effect of applying all Change elements in the Changes collection in sequence.
Name | Data Type | Description | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
status
|
string Allowed values: - done - pending |
Status of the operation (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. |
||||||||||||||||||||||
startTime
|
string |
The time that this operation was started by the server (output only). This is in RFC3339 text format. |
||||||||||||||||||||||
kind
|
string Default value: dns#change
|
Identifies what kind of resource this is. Value: the fixed string "dns#change". |
||||||||||||||||||||||
isServing
|
boolean |
If the DNS queries for the zone will be served. |
||||||||||||||||||||||
id
|
string |
Unique identifier for the resource; defined by the server (output only). |
||||||||||||||||||||||
deletions
|
array [ResourceRecordSet] |
Which ResourceRecordSets to remove? Must match existing data exactly. |
||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||
additions
|
array [ResourceRecordSet] |
Which ResourceRecordSets to add? |
||||||||||||||||||||||
Properties
|
The response to a request to enumerate Changes to a ResourceRecordSets collection.
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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 pagination 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 "snapshot" of collections larger than the maximum page size. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
kind
|
string Default value: dns#changesListResponse
|
Type of resource. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
header
|
ResponseHeader | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
changes
|
array [Change] |
The requested changes. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
A DNSSEC key pair.
Name | Data Type | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
type
|
string Allowed values: - keySigning - zoneSigning |
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. |
||||||||||
publicKey
|
string |
Base64 encoded public half of this key. Output only. |
||||||||||
kind
|
string Default value: dns#dnsKey
|
Identifies what kind of resource this is. Value: the fixed string "dns#dnsKey". |
||||||||||
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. |
||||||||||
keyLength
|
integer |
Length of the key in bits. Specified at creation time then immutable. |
||||||||||
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. |
||||||||||
id
|
string |
Unique identifier for the resource; defined by the server (output only). |
||||||||||
digests
|
array [DnsKeyDigest] |
Cryptographic hashes of the DNSKEY resource record associated with this DnsKey. These digests are needed to construct a DS record that points at this DNS key. Output only. |
||||||||||
Properties
|
||||||||||||
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. |
||||||||||
creationTime
|
string |
The time that this resource was created in the control plane. This is in RFC3339 text format. Output only. |
||||||||||
algorithm
|
string Allowed values: - ecdsap256sha256 - ecdsap384sha384 - rsasha1 - rsasha256 - rsasha512 |
String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time. |
Name | Data Type | Description |
---|---|---|
type
|
string Allowed values: - sha1 - sha256 - sha384 |
Specifies the algorithm used to calculate this digest. |
digest
|
string |
The base-16 encoded bytes of this digest. Suitable for use in a DS resource record. |
Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey.
Name | Data Type | Description |
---|---|---|
kind
|
string Default value: dns#dnsKeySpec
|
Identifies what kind of resource this is. Value: the fixed string "dns#dnsKeySpec". |
keyType
|
string Allowed values: - keySigning - zoneSigning |
Specifies whether this is a key signing key (KSK) or a zone signing key (ZSK). Key signing keys have the Secure Entry Point flag set and, when active, will only be used to sign resource record sets of type DNSKEY. Zone signing keys do not have the Secure Entry Point flag set and will be used to sign all other types of resource record sets. |
keyLength
|
integer |
Length of the keys in bits. |
algorithm
|
string Allowed values: - ecdsap256sha256 - ecdsap384sha384 - rsasha1 - rsasha256 - rsasha512 |
String mnemonic specifying the DNSSEC algorithm of this key. |
The response to a request to enumerate DnsKeys in a ManagedZone.
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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 pagination 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 "snapshot" of collections larger than the maximum page size. |
||||||||||||||||||||||||||||||||||||||||||||||||||
kind
|
string Default value: dns#dnsKeysListResponse
|
Type of resource. |
||||||||||||||||||||||||||||||||||||||||||||||||||
header
|
ResponseHeader | |||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||
dnsKeys
|
array [DnsKey] |
The requested resources. |
||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
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.
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
visibility
|
string Allowed values: - private - public |
The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources. |
|||||||||||||||||||||||||||||||||||
privateVisibilityConfig
|
ManagedZonePrivateVisibilityConfig |
For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from. |
|||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||
peeringConfig
|
ManagedZonePeeringConfig |
The presence of this field indicates that DNS Peering is enabled for this zone. The value of this field contains the network to peer with. |
|||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||
nameServers
|
array [string] |
Delegate your managed_zone to these virtual name servers; defined by the server (output only) |
|||||||||||||||||||||||||||||||||||
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. |
|||||||||||||||||||||||||||||||||||
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. |
|||||||||||||||||||||||||||||||||||
labels
|
object |
User labels. |
|||||||||||||||||||||||||||||||||||
kind
|
string Default value: dns#managedZone
|
Identifies what kind of resource this is. Value: the fixed string "dns#managedZone". |
|||||||||||||||||||||||||||||||||||
id
|
string |
Unique identifier for the resource; defined by the server (output only) |
|||||||||||||||||||||||||||||||||||
forwardingConfig
|
ManagedZoneForwardingConfig |
The presence for this field indicates that outbound forwarding is enabled for this zone. The value of this field contains the set of destinations to forward to. |
|||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||
dnssecConfig
|
ManagedZoneDnsSecConfig |
DNSSEC configuration. |
|||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||
dnsName
|
string |
The DNS name of this managed zone, for instance "example.com.". |
|||||||||||||||||||||||||||||||||||
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. |
|||||||||||||||||||||||||||||||||||
creationTime
|
string |
The time that this resource was created on the server. This is in RFC3339 text format. Output only. |
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
state
|
string Allowed values: - off - on - transfer |
Specifies whether DNSSEC is enabled, and what mode it is in. |
||||||||||||||||
nonExistence
|
string Allowed values: - nsec - nsec3 |
Specifies the mechanism for authenticated denial-of-existence responses. Can only be changed while the state is OFF. |
||||||||||||||||
kind
|
string Default value: dns#managedZoneDnsSecConfig
|
Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneDnsSecConfig". |
||||||||||||||||
defaultKeySpecs
|
array [DnsKeySpec] |
Specifies parameters for generating initial DnsKeys for this ManagedZone. Can only be changed while the state is OFF. |
||||||||||||||||
Properties
|
Name | Data Type | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
targetNameServers
|
array [ManagedZoneForwardingConfigNameServerTarget] |
List of target name servers to forward to. Cloud DNS will select the best available name server if more than one target is given. |
||||||||||
Properties
|
||||||||||||
kind
|
string Default value: dns#managedZoneForwardingConfig
|
Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneForwardingConfig". |
Name | Data Type | Description |
---|---|---|
kind
|
string Default value: dns#managedZoneForwardingConfigNameServerTarget
|
Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneForwardingConfigNameServerTarget". |
ipv4Address
|
string |
IPv4 address of a target name server. |
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
operations
|
array [Operation] |
The operation resources. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
kind
|
string Default value: dns#managedZoneOperationsListResponse
|
Type of resource. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
header
|
ResponseHeader | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
targetNetwork
|
ManagedZonePeeringConfigTargetNetwork |
The network with which to peer. |
|||||||||||||
Properties
|
|||||||||||||||
kind
|
string Default value: dns#managedZonePeeringConfig
|
Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePeeringConfig". |
Name | Data Type | Description |
---|---|---|
networkUrl
|
string |
The fully qualified URL of the VPC network to forward queries to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} |
kind
|
string Default value: dns#managedZonePeeringConfigTargetNetwork
|
Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePeeringConfigTargetNetwork". |
deactivateTime
|
string |
The time at which the zone was deactivated, in RFC 3339 date-time format. An empty string indicates that the peering connection is active. The producer network can deactivate a zone. The zone is automatically deactivated if the producer network that the zone targeted is deleted. Output only. |
Name | Data Type | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
networks
|
array [ManagedZonePrivateVisibilityConfigNetwork] |
The list of VPC networks that can see this zone. |
||||||||||
Properties
|
||||||||||||
kind
|
string Default value: dns#managedZonePrivateVisibilityConfig
|
Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePrivateVisibilityConfig". |
Name | Data Type | Description |
---|---|---|
networkUrl
|
string |
The fully qualified URL of the VPC network to bind to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} |
kind
|
string Default value: dns#managedZonePrivateVisibilityConfigNetwork
|
Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePrivateVisibilityConfigNetwork". |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
managedZones
|
array [ManagedZone] |
The managed zone resources. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
kind
|
string Default value: dns#managedZonesListResponse
|
Type of resource. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
header
|
ResponseHeader | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
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.
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
zoneContext
|
OperationManagedZoneContext |
Only populated if the operation targeted a ManagedZone (output only). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
user
|
string |
User who requested the operation, for example: user@example.com. cloud-dns-system for operations automatically done by the system. (output only) |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type
|
string |
Type of the operation. Operations include insert, update, and delete (output only). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status
|
string Allowed values: - done - pending |
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. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
startTime
|
string |
The time that this operation was started by the server. This is in RFC3339 text format (output only). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
kind
|
string Default value: dns#operation
|
Identifies what kind of resource this is. Value: the fixed string "dns#operation". |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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) |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
dnsKeyContext
|
OperationDnsKeyContext |
Only populated if the operation targeted a DnsKey (output only). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
oldValue
|
DnsKey |
The pre-operation DnsKey resource. |
||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||
newValue
|
DnsKey |
The post-operation DnsKey resource. |
||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
oldValue
|
ManagedZone |
The pre-operation ManagedZone resource. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
newValue
|
ManagedZone |
The post-operation ManagedZone resource. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
policies
|
array [Policy] |
The policy resources. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
kind
|
string Default value: dns#policiesListResponse
|
Type of resource. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
header
|
ResponseHeader | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
policy
|
Policy | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
header
|
ResponseHeader | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
policy
|
Policy | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
header
|
ResponseHeader | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
A policy is a collection of DNS rules applied to one or more Virtual Private Cloud resources.
Name | Data Type | Description | |||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
networks
|
array [PolicyNetwork] |
List of network names specifying networks to which this policy is applied. |
|||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||
name
|
string |
User assigned name for this policy. |
|||||||||||||||||||||||
kind
|
string Default value: dns#policy
|
Identifies what kind of resource this is. Value: the fixed string "dns#policy". |
|||||||||||||||||||||||
id
|
string |
Unique identifier for the resource; defined by the server (output only). |
|||||||||||||||||||||||
enableLogging
|
boolean |
Controls whether logging is enabled for the networks bound to this policy. Defaults to no logging if not set. |
|||||||||||||||||||||||
enableInboundForwarding
|
boolean |
Allows networks bound to this policy to receive DNS queries sent by VMs or applications over VPN connections. When enabled, a virtual IP address will be allocated from each of the sub-networks that are bound to this policy. |
|||||||||||||||||||||||
description
|
string |
A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the policy's function. |
|||||||||||||||||||||||
alternativeNameServerConfig
|
PolicyAlternativeNameServerConfig |
Sets an alternative name server for the associated networks. When specified, all DNS queries are forwarded to a name server that you choose. Names such as .internal are not available when an alternative name server is specified. |
|||||||||||||||||||||||
Properties
|
Name | Data Type | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
targetNameServers
|
array [PolicyAlternativeNameServerConfigTargetNameServer] |
Sets an alternative name server for the associated networks. When specified, all DNS queries are forwarded to a name server that you choose. Names such as .internal are not available when an alternative name server is specified. |
||||||||||
Properties
|
||||||||||||
kind
|
string Default value: dns#policyAlternativeNameServerConfig
|
Identifies what kind of resource this is. Value: the fixed string "dns#policyAlternativeNameServerConfig". |
Name | Data Type | Description |
---|---|---|
kind
|
string Default value: dns#policyAlternativeNameServerConfigTargetNameServer
|
Identifies what kind of resource this is. Value: the fixed string "dns#policyAlternativeNameServerConfigTargetNameServer". |
ipv4Address
|
string |
IPv4 address to forward to. |
Name | Data Type | Description |
---|---|---|
networkUrl
|
string |
The fully qualified URL of the VPC network to bind to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} |
kind
|
string Default value: dns#policyNetwork
|
Identifies what kind of resource this is. Value: the fixed string "dns#policyNetwork". |
A project resource. The project is a top level container for resources including Cloud DNS ManagedZones. Projects can be created only in the APIs console.
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
quota
|
Quota |
Quotas assigned to this project (output only). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
number
|
string |
Unique numeric identifier for the resource; defined by the server (output only). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
kind
|
string Default value: dns#project
|
Identifies what kind of resource this is. Value: the fixed string "dns#project". |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id
|
string |
User assigned unique identifier for the resource (output only). |
Limits associated with a Project.
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
whitelistedKeySpecs
|
array [DnsKeySpec] |
DNSSEC algorithm and key length types that can be used for DnsKeys. |
||||||||||||||||
Properties
|
||||||||||||||||||
totalRrdataSizePerChange
|
integer |
Maximum allowed size for total rrdata in one ChangesCreateRequest in bytes. |
||||||||||||||||
targetNameServersPerPolicy
|
integer |
Maximum allowed number of alternative target name servers per policy. |
||||||||||||||||
targetNameServersPerManagedZone
|
integer |
Maximum allowed number of target name servers per managed forwarding zone. |
||||||||||||||||
rrsetsPerManagedZone
|
integer |
Maximum allowed number of ResourceRecordSets per zone in the project. |
||||||||||||||||
rrsetDeletionsPerChange
|
integer |
Maximum allowed number of ResourceRecordSets to delete per ChangesCreateRequest. |
||||||||||||||||
rrsetAdditionsPerChange
|
integer |
Maximum allowed number of ResourceRecordSets to add per ChangesCreateRequest. |
||||||||||||||||
resourceRecordsPerRrset
|
integer |
Maximum allowed number of ResourceRecords per ResourceRecordSet. |
||||||||||||||||
policies
|
integer |
Maximum allowed number of policies per project. |
||||||||||||||||
networksPerPolicy
|
integer |
Maximum allowed number of networks per policy. |
||||||||||||||||
networksPerManagedZone
|
integer |
Maximum allowed number of networks to which a privately scoped zone can be attached. |
||||||||||||||||
managedZonesPerNetwork
|
integer |
Maximum allowed number of managed zones which can be attached to a network. |
||||||||||||||||
managedZones
|
integer |
Maximum allowed number of managed zones in the project. |
||||||||||||||||
kind
|
string Default value: dns#quota
|
Identifies what kind of resource this is. Value: the fixed string "dns#quota". |
||||||||||||||||
dnsKeysPerManagedZone
|
integer |
Maximum allowed number of DnsKeys per ManagedZone. |
A unit of data that will be returned by the DNS servers.
Name | Data Type | Description |
---|---|---|
type
|
string |
The identifier of a supported record type. See the list of Supported DNS record types. |
ttl
|
integer |
Number of seconds that this ResourceRecordSet can be cached by resolvers. |
signatureRrdatas
|
array [string] |
As defined in RFC 4034 (section 3.2). |
rrdatas
|
array [string] |
As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples. |
name
|
string |
For example, www.example.com. |
kind
|
string Default value: dns#resourceRecordSet
|
Identifies what kind of resource this is. Value: the fixed string "dns#resourceRecordSet". |
Name | Data Type | Description | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
rrsets
|
array [ResourceRecordSet] |
The resource record set resources. |
||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||
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 pagination 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. |
||||||||||||||||||||||
kind
|
string Default value: dns#resourceRecordSetsListResponse
|
Type of resource. |
||||||||||||||||||||||
header
|
ResponseHeader | |||||||||||||||||||||||
Properties
|
Elements common to every response.
Name | Data Type | Description |
---|---|---|
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). |
'OAuth' Authentication Scheme
Reference: RFC5849, Section 3.5.1
Oauth 2.0 accessCode authentication
Flow:authorizationCode
https://accounts.google.com/o/oauth2/auth
https://accounts.google.com/o/oauth2/token
https://www.googleapis.com/auth/cloud-platform
: View and manage your data across Google Cloud Platform serviceshttps://www.googleapis.com/auth/ndev.clouddns.readonly
: View your DNS records hosted by Google Cloud DNShttps://www.googleapis.com/auth/ndev.clouddns.readwrite
: View and manage your DNS records hosted by Google Cloud DNShttps://www.googleapis.com/auth/cloud-platform.read-only
: View your data across Google Cloud Platform services
'OAuth' Authentication Scheme
Reference: RFC5849, Section 3.5.1
Oauth 2.0 implicit authentication
Flow:implicit
https://accounts.google.com/o/oauth2/auth
https://www.googleapis.com/auth/cloud-platform
: View and manage your data across Google Cloud Platform serviceshttps://www.googleapis.com/auth/ndev.clouddns.readonly
: View your DNS records hosted by Google Cloud DNShttps://www.googleapis.com/auth/ndev.clouddns.readwrite
: View and manage your DNS records hosted by Google Cloud DNShttps://www.googleapis.com/auth/cloud-platform.read-only
: View your data across Google Cloud Platform servicesName | Google |
External URL | https://google.com |
OAS (OpenAPI Specification) | v3.0.0 |