| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| 75 | <h1><a href="dns_v1.html">Google Cloud DNS API</a> . <a href="dns_v1.managedZones.html">managedZones</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 78 | <code><a href="#create">create(project, body=None, clientOperationId=None)</a></code></p> |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 79 | <p class="firstline">Create a new ManagedZone.</p> |
| 80 | <p class="toc_element"> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 81 | <code><a href="#delete">delete(project, managedZone, clientOperationId=None)</a></code></p> |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 82 | <p class="firstline">Delete a previously created ManagedZone.</p> |
| 83 | <p class="toc_element"> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 84 | <code><a href="#get">get(project, managedZone, clientOperationId=None)</a></code></p> |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 85 | <p class="firstline">Fetch the representation of an existing ManagedZone.</p> |
| 86 | <p class="toc_element"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 87 | <code><a href="#list">list(project, dnsName=None, maxResults=None, pageToken=None)</a></code></p> |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 88 | <p class="firstline">Enumerate ManagedZones that have been created but not yet deleted.</p> |
| 89 | <p class="toc_element"> |
| 90 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 91 | <p class="firstline">Retrieves the next page of results.</p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 92 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 93 | <code><a href="#patch">patch(project, managedZone, body=None, clientOperationId=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 94 | <p class="firstline">Apply a partial update to an existing ManagedZone.</p> |
| 95 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 96 | <code><a href="#update">update(project, managedZone, body=None, clientOperationId=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 97 | <p class="firstline">Update an existing ManagedZone.</p> |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 98 | <h3>Method Details</h3> |
| 99 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 100 | <code class="details" id="create">create(project, body=None, clientOperationId=None)</code> |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 101 | <pre>Create a new ManagedZone. |
| 102 | |
| 103 | Args: |
| 104 | project: string, Identifies the project addressed by this request. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 105 | body: object, The request body. |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 106 | The object takes the form of: |
| 107 | |
| 108 | { # 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. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 109 | "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only. |
| 110 | "description": "A 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. |
| 111 | "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.". |
| 112 | "dnssecConfig": { # DNSSEC configuration. |
| 113 | "defaultKeySpecs": [ # Specifies parameters for generating initial DnsKeys for this ManagedZone. Can only be changed while the state is OFF. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 114 | { # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 115 | "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. |
| 116 | "keyLength": 42, # Length of the keys in bits. |
| 117 | "keyType": "A String", # 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. |
| 118 | "kind": "dns#dnsKeySpec", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKeySpec". |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 119 | }, |
| 120 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 121 | "kind": "dns#managedZoneDnsSecConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneDnsSecConfig". |
| 122 | "nonExistence": "A String", # Specifies the mechanism for authenticated denial-of-existence responses. Can only be changed while the state is OFF. |
| 123 | "state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 124 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 125 | "forwardingConfig": { # 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. |
| 126 | "kind": "dns#managedZoneForwardingConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneForwardingConfig". |
| 127 | "targetNameServers": [ # List of target name servers to forward to. Cloud DNS will select the best available name server if more than one target is given. |
| 128 | { |
| 129 | "ipv4Address": "A String", # IPv4 address of a target name server. |
| 130 | "kind": "dns#managedZoneForwardingConfigNameServerTarget", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneForwardingConfigNameServerTarget". |
| 131 | }, |
| 132 | ], |
| 133 | }, |
| 134 | "id": "A String", # Unique identifier for the resource; defined by the server (output only) |
| 135 | "kind": "dns#managedZone", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZone". |
| 136 | "labels": { # User labels. |
| 137 | "a_key": "A String", |
| 138 | }, |
| 139 | "name": "A 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. |
| 140 | "nameServerSet": "A 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. |
| 141 | "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only) |
| 142 | "A String", |
| 143 | ], |
| 144 | "peeringConfig": { # 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. |
| 145 | "kind": "dns#managedZonePeeringConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePeeringConfig". |
| 146 | "targetNetwork": { # The network with which to peer. |
| 147 | "deactivateTime": "A 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. |
| 148 | "kind": "dns#managedZonePeeringConfigTargetNetwork", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePeeringConfigTargetNetwork". |
| 149 | "networkUrl": "A 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} |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 150 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 151 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 152 | "privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from. |
| 153 | "kind": "dns#managedZonePrivateVisibilityConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePrivateVisibilityConfig". |
| 154 | "networks": [ # The list of VPC networks that can see this zone. |
| 155 | { |
| 156 | "kind": "dns#managedZonePrivateVisibilityConfigNetwork", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePrivateVisibilityConfigNetwork". |
| 157 | "networkUrl": "A 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} |
| 158 | }, |
| 159 | ], |
| 160 | }, |
| 161 | "visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 162 | } |
| 163 | |
| 164 | clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. |
| 165 | |
| 166 | Returns: |
| 167 | An object of the form: |
| 168 | |
| 169 | { # 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. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 170 | "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only. |
| 171 | "description": "A 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. |
| 172 | "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.". |
| 173 | "dnssecConfig": { # DNSSEC configuration. |
| 174 | "defaultKeySpecs": [ # Specifies parameters for generating initial DnsKeys for this ManagedZone. Can only be changed while the state is OFF. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 175 | { # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 176 | "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. |
| 177 | "keyLength": 42, # Length of the keys in bits. |
| 178 | "keyType": "A String", # 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. |
| 179 | "kind": "dns#dnsKeySpec", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKeySpec". |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 180 | }, |
| 181 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 182 | "kind": "dns#managedZoneDnsSecConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneDnsSecConfig". |
| 183 | "nonExistence": "A String", # Specifies the mechanism for authenticated denial-of-existence responses. Can only be changed while the state is OFF. |
| 184 | "state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 185 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 186 | "forwardingConfig": { # 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. |
| 187 | "kind": "dns#managedZoneForwardingConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneForwardingConfig". |
| 188 | "targetNameServers": [ # List of target name servers to forward to. Cloud DNS will select the best available name server if more than one target is given. |
| 189 | { |
| 190 | "ipv4Address": "A String", # IPv4 address of a target name server. |
| 191 | "kind": "dns#managedZoneForwardingConfigNameServerTarget", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneForwardingConfigNameServerTarget". |
| 192 | }, |
| 193 | ], |
| 194 | }, |
| 195 | "id": "A String", # Unique identifier for the resource; defined by the server (output only) |
| 196 | "kind": "dns#managedZone", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZone". |
| 197 | "labels": { # User labels. |
| 198 | "a_key": "A String", |
| 199 | }, |
| 200 | "name": "A 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. |
| 201 | "nameServerSet": "A 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. |
| 202 | "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only) |
| 203 | "A String", |
| 204 | ], |
| 205 | "peeringConfig": { # 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. |
| 206 | "kind": "dns#managedZonePeeringConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePeeringConfig". |
| 207 | "targetNetwork": { # The network with which to peer. |
| 208 | "deactivateTime": "A 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. |
| 209 | "kind": "dns#managedZonePeeringConfigTargetNetwork", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePeeringConfigTargetNetwork". |
| 210 | "networkUrl": "A 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} |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 211 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 212 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 213 | "privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from. |
| 214 | "kind": "dns#managedZonePrivateVisibilityConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePrivateVisibilityConfig". |
| 215 | "networks": [ # The list of VPC networks that can see this zone. |
| 216 | { |
| 217 | "kind": "dns#managedZonePrivateVisibilityConfigNetwork", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePrivateVisibilityConfigNetwork". |
| 218 | "networkUrl": "A 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} |
| 219 | }, |
| 220 | ], |
| 221 | }, |
| 222 | "visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 223 | }</pre> |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 224 | </div> |
| 225 | |
| 226 | <div class="method"> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 227 | <code class="details" id="delete">delete(project, managedZone, clientOperationId=None)</code> |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 228 | <pre>Delete a previously created ManagedZone. |
| 229 | |
| 230 | Args: |
| 231 | project: string, Identifies the project addressed by this request. (required) |
| 232 | managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or id. (required) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 233 | clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 234 | </pre> |
| 235 | </div> |
| 236 | |
| 237 | <div class="method"> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 238 | <code class="details" id="get">get(project, managedZone, clientOperationId=None)</code> |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 239 | <pre>Fetch the representation of an existing ManagedZone. |
| 240 | |
| 241 | Args: |
| 242 | project: string, Identifies the project addressed by this request. (required) |
| 243 | managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or id. (required) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 244 | clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 245 | |
| 246 | Returns: |
| 247 | An object of the form: |
| 248 | |
| 249 | { # 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. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 250 | "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only. |
| 251 | "description": "A 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. |
| 252 | "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.". |
| 253 | "dnssecConfig": { # DNSSEC configuration. |
| 254 | "defaultKeySpecs": [ # Specifies parameters for generating initial DnsKeys for this ManagedZone. Can only be changed while the state is OFF. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 255 | { # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 256 | "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. |
| 257 | "keyLength": 42, # Length of the keys in bits. |
| 258 | "keyType": "A String", # 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. |
| 259 | "kind": "dns#dnsKeySpec", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKeySpec". |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 260 | }, |
| 261 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 262 | "kind": "dns#managedZoneDnsSecConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneDnsSecConfig". |
| 263 | "nonExistence": "A String", # Specifies the mechanism for authenticated denial-of-existence responses. Can only be changed while the state is OFF. |
| 264 | "state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 265 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 266 | "forwardingConfig": { # 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. |
| 267 | "kind": "dns#managedZoneForwardingConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneForwardingConfig". |
| 268 | "targetNameServers": [ # List of target name servers to forward to. Cloud DNS will select the best available name server if more than one target is given. |
| 269 | { |
| 270 | "ipv4Address": "A String", # IPv4 address of a target name server. |
| 271 | "kind": "dns#managedZoneForwardingConfigNameServerTarget", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneForwardingConfigNameServerTarget". |
| 272 | }, |
| 273 | ], |
| 274 | }, |
| 275 | "id": "A String", # Unique identifier for the resource; defined by the server (output only) |
| 276 | "kind": "dns#managedZone", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZone". |
| 277 | "labels": { # User labels. |
| 278 | "a_key": "A String", |
| 279 | }, |
| 280 | "name": "A 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. |
| 281 | "nameServerSet": "A 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. |
| 282 | "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only) |
| 283 | "A String", |
| 284 | ], |
| 285 | "peeringConfig": { # 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. |
| 286 | "kind": "dns#managedZonePeeringConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePeeringConfig". |
| 287 | "targetNetwork": { # The network with which to peer. |
| 288 | "deactivateTime": "A 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. |
| 289 | "kind": "dns#managedZonePeeringConfigTargetNetwork", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePeeringConfigTargetNetwork". |
| 290 | "networkUrl": "A 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} |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 291 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 292 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 293 | "privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from. |
| 294 | "kind": "dns#managedZonePrivateVisibilityConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePrivateVisibilityConfig". |
| 295 | "networks": [ # The list of VPC networks that can see this zone. |
| 296 | { |
| 297 | "kind": "dns#managedZonePrivateVisibilityConfigNetwork", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePrivateVisibilityConfigNetwork". |
| 298 | "networkUrl": "A 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} |
| 299 | }, |
| 300 | ], |
| 301 | }, |
| 302 | "visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 303 | }</pre> |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 304 | </div> |
| 305 | |
| 306 | <div class="method"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 307 | <code class="details" id="list">list(project, dnsName=None, maxResults=None, pageToken=None)</code> |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 308 | <pre>Enumerate ManagedZones that have been created but not yet deleted. |
| 309 | |
| 310 | Args: |
| 311 | project: string, Identifies the project addressed by this request. (required) |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 312 | dnsName: string, Restricts the list to return only zones with this domain name. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 313 | maxResults: integer, Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return. |
| 314 | pageToken: string, Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request. |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 315 | |
| 316 | Returns: |
| 317 | An object of the form: |
| 318 | |
| 319 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 320 | "header": { # Elements common to every response. |
| 321 | "operationId": "A 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). |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 322 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 323 | "kind": "dns#managedZonesListResponse", # Type of resource. |
| 324 | "managedZones": [ # The managed zone resources. |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 325 | { # 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. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 326 | "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only. |
| 327 | "description": "A 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. |
| 328 | "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.". |
| 329 | "dnssecConfig": { # DNSSEC configuration. |
| 330 | "defaultKeySpecs": [ # Specifies parameters for generating initial DnsKeys for this ManagedZone. Can only be changed while the state is OFF. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 331 | { # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 332 | "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. |
| 333 | "keyLength": 42, # Length of the keys in bits. |
| 334 | "keyType": "A String", # 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. |
| 335 | "kind": "dns#dnsKeySpec", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKeySpec". |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 336 | }, |
| 337 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 338 | "kind": "dns#managedZoneDnsSecConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneDnsSecConfig". |
| 339 | "nonExistence": "A String", # Specifies the mechanism for authenticated denial-of-existence responses. Can only be changed while the state is OFF. |
| 340 | "state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 341 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 342 | "forwardingConfig": { # 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. |
| 343 | "kind": "dns#managedZoneForwardingConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneForwardingConfig". |
| 344 | "targetNameServers": [ # List of target name servers to forward to. Cloud DNS will select the best available name server if more than one target is given. |
| 345 | { |
| 346 | "ipv4Address": "A String", # IPv4 address of a target name server. |
| 347 | "kind": "dns#managedZoneForwardingConfigNameServerTarget", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneForwardingConfigNameServerTarget". |
| 348 | }, |
| 349 | ], |
| 350 | }, |
| 351 | "id": "A String", # Unique identifier for the resource; defined by the server (output only) |
| 352 | "kind": "dns#managedZone", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZone". |
| 353 | "labels": { # User labels. |
| 354 | "a_key": "A String", |
| 355 | }, |
| 356 | "name": "A 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. |
| 357 | "nameServerSet": "A 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. |
| 358 | "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only) |
| 359 | "A String", |
| 360 | ], |
| 361 | "peeringConfig": { # 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. |
| 362 | "kind": "dns#managedZonePeeringConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePeeringConfig". |
| 363 | "targetNetwork": { # The network with which to peer. |
| 364 | "deactivateTime": "A 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. |
| 365 | "kind": "dns#managedZonePeeringConfigTargetNetwork", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePeeringConfigTargetNetwork". |
| 366 | "networkUrl": "A 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} |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 367 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 368 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 369 | "privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from. |
| 370 | "kind": "dns#managedZonePrivateVisibilityConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePrivateVisibilityConfig". |
| 371 | "networks": [ # The list of VPC networks that can see this zone. |
| 372 | { |
| 373 | "kind": "dns#managedZonePrivateVisibilityConfigNetwork", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePrivateVisibilityConfigNetwork". |
| 374 | "networkUrl": "A 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} |
| 375 | }, |
| 376 | ], |
| 377 | }, |
| 378 | "visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 379 | }, |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 380 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 381 | "nextPageToken": "A 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. |
| 382 | # |
| 383 | # 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. |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 384 | }</pre> |
| 385 | </div> |
| 386 | |
| 387 | <div class="method"> |
| 388 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 389 | <pre>Retrieves the next page of results. |
| 390 | |
| 391 | Args: |
| 392 | previous_request: The request for the previous page. (required) |
| 393 | previous_response: The response from the request for the previous page. (required) |
| 394 | |
| 395 | Returns: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 396 | A request object that you can call 'execute()' on to request the next |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 397 | page. Returns None if there are no more items in the collection. |
| 398 | </pre> |
| 399 | </div> |
| 400 | |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 401 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 402 | <code class="details" id="patch">patch(project, managedZone, body=None, clientOperationId=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 403 | <pre>Apply a partial update to an existing ManagedZone. |
| 404 | |
| 405 | Args: |
| 406 | project: string, Identifies the project addressed by this request. (required) |
| 407 | managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or id. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 408 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 409 | The object takes the form of: |
| 410 | |
| 411 | { # 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. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 412 | "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only. |
| 413 | "description": "A 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. |
| 414 | "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.". |
| 415 | "dnssecConfig": { # DNSSEC configuration. |
| 416 | "defaultKeySpecs": [ # Specifies parameters for generating initial DnsKeys for this ManagedZone. Can only be changed while the state is OFF. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 417 | { # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 418 | "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. |
| 419 | "keyLength": 42, # Length of the keys in bits. |
| 420 | "keyType": "A String", # 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. |
| 421 | "kind": "dns#dnsKeySpec", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKeySpec". |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 422 | }, |
| 423 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 424 | "kind": "dns#managedZoneDnsSecConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneDnsSecConfig". |
| 425 | "nonExistence": "A String", # Specifies the mechanism for authenticated denial-of-existence responses. Can only be changed while the state is OFF. |
| 426 | "state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 427 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 428 | "forwardingConfig": { # 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. |
| 429 | "kind": "dns#managedZoneForwardingConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneForwardingConfig". |
| 430 | "targetNameServers": [ # List of target name servers to forward to. Cloud DNS will select the best available name server if more than one target is given. |
| 431 | { |
| 432 | "ipv4Address": "A String", # IPv4 address of a target name server. |
| 433 | "kind": "dns#managedZoneForwardingConfigNameServerTarget", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneForwardingConfigNameServerTarget". |
| 434 | }, |
| 435 | ], |
| 436 | }, |
| 437 | "id": "A String", # Unique identifier for the resource; defined by the server (output only) |
| 438 | "kind": "dns#managedZone", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZone". |
| 439 | "labels": { # User labels. |
| 440 | "a_key": "A String", |
| 441 | }, |
| 442 | "name": "A 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. |
| 443 | "nameServerSet": "A 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. |
| 444 | "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only) |
| 445 | "A String", |
| 446 | ], |
| 447 | "peeringConfig": { # 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. |
| 448 | "kind": "dns#managedZonePeeringConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePeeringConfig". |
| 449 | "targetNetwork": { # The network with which to peer. |
| 450 | "deactivateTime": "A 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. |
| 451 | "kind": "dns#managedZonePeeringConfigTargetNetwork", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePeeringConfigTargetNetwork". |
| 452 | "networkUrl": "A 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} |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 453 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 454 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 455 | "privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from. |
| 456 | "kind": "dns#managedZonePrivateVisibilityConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePrivateVisibilityConfig". |
| 457 | "networks": [ # The list of VPC networks that can see this zone. |
| 458 | { |
| 459 | "kind": "dns#managedZonePrivateVisibilityConfigNetwork", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePrivateVisibilityConfigNetwork". |
| 460 | "networkUrl": "A 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} |
| 461 | }, |
| 462 | ], |
| 463 | }, |
| 464 | "visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 465 | } |
| 466 | |
| 467 | clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. |
| 468 | |
| 469 | Returns: |
| 470 | An object of the form: |
| 471 | |
| 472 | { # 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. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 473 | "dnsKeyContext": { # Only populated if the operation targeted a DnsKey (output only). |
| 474 | "newValue": { # A DNSSEC key pair. # The post-operation DnsKey resource. |
| 475 | "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time. |
| 476 | "creationTime": "A String", # The time that this resource was created in the control plane. This is in RFC3339 text format. Output only. |
| 477 | "description": "A 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. |
| 478 | "digests": [ # 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. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 479 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 480 | "digest": "A String", # The base-16 encoded bytes of this digest. Suitable for use in a DS resource record. |
| 481 | "type": "A String", # Specifies the algorithm used to calculate this digest. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 482 | }, |
| 483 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 484 | "id": "A String", # Unique identifier for the resource; defined by the server (output only). |
| 485 | "isActive": True or False, # 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. |
| 486 | "keyLength": 42, # Length of the key in bits. Specified at creation time then immutable. |
| 487 | "keyTag": 42, # 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. |
| 488 | "kind": "dns#dnsKey", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKey". |
| 489 | "publicKey": "A String", # Base64 encoded public half of this key. Output only. |
| 490 | "type": "A String", # 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. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 491 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 492 | "oldValue": { # A DNSSEC key pair. # The pre-operation DnsKey resource. |
| 493 | "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time. |
| 494 | "creationTime": "A String", # The time that this resource was created in the control plane. This is in RFC3339 text format. Output only. |
| 495 | "description": "A 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. |
| 496 | "digests": [ # 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. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 497 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 498 | "digest": "A String", # The base-16 encoded bytes of this digest. Suitable for use in a DS resource record. |
| 499 | "type": "A String", # Specifies the algorithm used to calculate this digest. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 500 | }, |
| 501 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 502 | "id": "A String", # Unique identifier for the resource; defined by the server (output only). |
| 503 | "isActive": True or False, # 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. |
| 504 | "keyLength": 42, # Length of the key in bits. Specified at creation time then immutable. |
| 505 | "keyTag": 42, # 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. |
| 506 | "kind": "dns#dnsKey", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKey". |
| 507 | "publicKey": "A String", # Base64 encoded public half of this key. Output only. |
| 508 | "type": "A String", # 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. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 509 | }, |
| 510 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 511 | "id": "A 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) |
| 512 | "kind": "dns#operation", # Identifies what kind of resource this is. Value: the fixed string "dns#operation". |
| 513 | "startTime": "A String", # The time that this operation was started by the server. This is in RFC3339 text format (output only). |
| 514 | "status": "A String", # 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. |
| 515 | "type": "A String", # Type of the operation. Operations include insert, update, and delete (output only). |
| 516 | "user": "A String", # User who requested the operation, for example: user@example.com. cloud-dns-system for operations automatically done by the system. (output only) |
| 517 | "zoneContext": { # Only populated if the operation targeted a ManagedZone (output only). |
| 518 | "newValue": { # 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. # The post-operation ManagedZone resource. |
| 519 | "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only. |
| 520 | "description": "A 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. |
| 521 | "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.". |
| 522 | "dnssecConfig": { # DNSSEC configuration. |
| 523 | "defaultKeySpecs": [ # Specifies parameters for generating initial DnsKeys for this ManagedZone. Can only be changed while the state is OFF. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 524 | { # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 525 | "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. |
| 526 | "keyLength": 42, # Length of the keys in bits. |
| 527 | "keyType": "A String", # 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. |
| 528 | "kind": "dns#dnsKeySpec", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKeySpec". |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 529 | }, |
| 530 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 531 | "kind": "dns#managedZoneDnsSecConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneDnsSecConfig". |
| 532 | "nonExistence": "A String", # Specifies the mechanism for authenticated denial-of-existence responses. Can only be changed while the state is OFF. |
| 533 | "state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 534 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 535 | "forwardingConfig": { # 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. |
| 536 | "kind": "dns#managedZoneForwardingConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneForwardingConfig". |
| 537 | "targetNameServers": [ # List of target name servers to forward to. Cloud DNS will select the best available name server if more than one target is given. |
| 538 | { |
| 539 | "ipv4Address": "A String", # IPv4 address of a target name server. |
| 540 | "kind": "dns#managedZoneForwardingConfigNameServerTarget", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneForwardingConfigNameServerTarget". |
| 541 | }, |
| 542 | ], |
| 543 | }, |
| 544 | "id": "A String", # Unique identifier for the resource; defined by the server (output only) |
| 545 | "kind": "dns#managedZone", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZone". |
| 546 | "labels": { # User labels. |
| 547 | "a_key": "A String", |
| 548 | }, |
| 549 | "name": "A 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. |
| 550 | "nameServerSet": "A 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. |
| 551 | "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only) |
| 552 | "A String", |
| 553 | ], |
| 554 | "peeringConfig": { # 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. |
| 555 | "kind": "dns#managedZonePeeringConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePeeringConfig". |
| 556 | "targetNetwork": { # The network with which to peer. |
| 557 | "deactivateTime": "A 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. |
| 558 | "kind": "dns#managedZonePeeringConfigTargetNetwork", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePeeringConfigTargetNetwork". |
| 559 | "networkUrl": "A 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} |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 560 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 561 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 562 | "privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from. |
| 563 | "kind": "dns#managedZonePrivateVisibilityConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePrivateVisibilityConfig". |
| 564 | "networks": [ # The list of VPC networks that can see this zone. |
| 565 | { |
| 566 | "kind": "dns#managedZonePrivateVisibilityConfigNetwork", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePrivateVisibilityConfigNetwork". |
| 567 | "networkUrl": "A 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} |
| 568 | }, |
| 569 | ], |
| 570 | }, |
| 571 | "visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 572 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 573 | "oldValue": { # 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. # The pre-operation ManagedZone resource. |
| 574 | "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only. |
| 575 | "description": "A 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. |
| 576 | "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.". |
| 577 | "dnssecConfig": { # DNSSEC configuration. |
| 578 | "defaultKeySpecs": [ # Specifies parameters for generating initial DnsKeys for this ManagedZone. Can only be changed while the state is OFF. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 579 | { # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 580 | "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. |
| 581 | "keyLength": 42, # Length of the keys in bits. |
| 582 | "keyType": "A String", # 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. |
| 583 | "kind": "dns#dnsKeySpec", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKeySpec". |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 584 | }, |
| 585 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 586 | "kind": "dns#managedZoneDnsSecConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneDnsSecConfig". |
| 587 | "nonExistence": "A String", # Specifies the mechanism for authenticated denial-of-existence responses. Can only be changed while the state is OFF. |
| 588 | "state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 589 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 590 | "forwardingConfig": { # 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. |
| 591 | "kind": "dns#managedZoneForwardingConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneForwardingConfig". |
| 592 | "targetNameServers": [ # List of target name servers to forward to. Cloud DNS will select the best available name server if more than one target is given. |
| 593 | { |
| 594 | "ipv4Address": "A String", # IPv4 address of a target name server. |
| 595 | "kind": "dns#managedZoneForwardingConfigNameServerTarget", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneForwardingConfigNameServerTarget". |
| 596 | }, |
| 597 | ], |
| 598 | }, |
| 599 | "id": "A String", # Unique identifier for the resource; defined by the server (output only) |
| 600 | "kind": "dns#managedZone", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZone". |
| 601 | "labels": { # User labels. |
| 602 | "a_key": "A String", |
| 603 | }, |
| 604 | "name": "A 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. |
| 605 | "nameServerSet": "A 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. |
| 606 | "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only) |
| 607 | "A String", |
| 608 | ], |
| 609 | "peeringConfig": { # 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. |
| 610 | "kind": "dns#managedZonePeeringConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePeeringConfig". |
| 611 | "targetNetwork": { # The network with which to peer. |
| 612 | "deactivateTime": "A 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. |
| 613 | "kind": "dns#managedZonePeeringConfigTargetNetwork", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePeeringConfigTargetNetwork". |
| 614 | "networkUrl": "A 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} |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 615 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 616 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 617 | "privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from. |
| 618 | "kind": "dns#managedZonePrivateVisibilityConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePrivateVisibilityConfig". |
| 619 | "networks": [ # The list of VPC networks that can see this zone. |
| 620 | { |
| 621 | "kind": "dns#managedZonePrivateVisibilityConfigNetwork", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePrivateVisibilityConfigNetwork". |
| 622 | "networkUrl": "A 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} |
| 623 | }, |
| 624 | ], |
| 625 | }, |
| 626 | "visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 627 | }, |
| 628 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 629 | }</pre> |
| 630 | </div> |
| 631 | |
| 632 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 633 | <code class="details" id="update">update(project, managedZone, body=None, clientOperationId=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 634 | <pre>Update an existing ManagedZone. |
| 635 | |
| 636 | Args: |
| 637 | project: string, Identifies the project addressed by this request. (required) |
| 638 | managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or id. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 639 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 640 | The object takes the form of: |
| 641 | |
| 642 | { # 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. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 643 | "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only. |
| 644 | "description": "A 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. |
| 645 | "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.". |
| 646 | "dnssecConfig": { # DNSSEC configuration. |
| 647 | "defaultKeySpecs": [ # Specifies parameters for generating initial DnsKeys for this ManagedZone. Can only be changed while the state is OFF. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 648 | { # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 649 | "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. |
| 650 | "keyLength": 42, # Length of the keys in bits. |
| 651 | "keyType": "A String", # 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. |
| 652 | "kind": "dns#dnsKeySpec", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKeySpec". |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 653 | }, |
| 654 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 655 | "kind": "dns#managedZoneDnsSecConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneDnsSecConfig". |
| 656 | "nonExistence": "A String", # Specifies the mechanism for authenticated denial-of-existence responses. Can only be changed while the state is OFF. |
| 657 | "state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 658 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 659 | "forwardingConfig": { # 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. |
| 660 | "kind": "dns#managedZoneForwardingConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneForwardingConfig". |
| 661 | "targetNameServers": [ # List of target name servers to forward to. Cloud DNS will select the best available name server if more than one target is given. |
| 662 | { |
| 663 | "ipv4Address": "A String", # IPv4 address of a target name server. |
| 664 | "kind": "dns#managedZoneForwardingConfigNameServerTarget", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneForwardingConfigNameServerTarget". |
| 665 | }, |
| 666 | ], |
| 667 | }, |
| 668 | "id": "A String", # Unique identifier for the resource; defined by the server (output only) |
| 669 | "kind": "dns#managedZone", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZone". |
| 670 | "labels": { # User labels. |
| 671 | "a_key": "A String", |
| 672 | }, |
| 673 | "name": "A 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. |
| 674 | "nameServerSet": "A 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. |
| 675 | "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only) |
| 676 | "A String", |
| 677 | ], |
| 678 | "peeringConfig": { # 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. |
| 679 | "kind": "dns#managedZonePeeringConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePeeringConfig". |
| 680 | "targetNetwork": { # The network with which to peer. |
| 681 | "deactivateTime": "A 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. |
| 682 | "kind": "dns#managedZonePeeringConfigTargetNetwork", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePeeringConfigTargetNetwork". |
| 683 | "networkUrl": "A 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} |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 684 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 685 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 686 | "privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from. |
| 687 | "kind": "dns#managedZonePrivateVisibilityConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePrivateVisibilityConfig". |
| 688 | "networks": [ # The list of VPC networks that can see this zone. |
| 689 | { |
| 690 | "kind": "dns#managedZonePrivateVisibilityConfigNetwork", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePrivateVisibilityConfigNetwork". |
| 691 | "networkUrl": "A 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} |
| 692 | }, |
| 693 | ], |
| 694 | }, |
| 695 | "visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 696 | } |
| 697 | |
| 698 | clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. |
| 699 | |
| 700 | Returns: |
| 701 | An object of the form: |
| 702 | |
| 703 | { # 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. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 704 | "dnsKeyContext": { # Only populated if the operation targeted a DnsKey (output only). |
| 705 | "newValue": { # A DNSSEC key pair. # The post-operation DnsKey resource. |
| 706 | "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time. |
| 707 | "creationTime": "A String", # The time that this resource was created in the control plane. This is in RFC3339 text format. Output only. |
| 708 | "description": "A 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. |
| 709 | "digests": [ # 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. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 710 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 711 | "digest": "A String", # The base-16 encoded bytes of this digest. Suitable for use in a DS resource record. |
| 712 | "type": "A String", # Specifies the algorithm used to calculate this digest. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 713 | }, |
| 714 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 715 | "id": "A String", # Unique identifier for the resource; defined by the server (output only). |
| 716 | "isActive": True or False, # 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. |
| 717 | "keyLength": 42, # Length of the key in bits. Specified at creation time then immutable. |
| 718 | "keyTag": 42, # 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. |
| 719 | "kind": "dns#dnsKey", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKey". |
| 720 | "publicKey": "A String", # Base64 encoded public half of this key. Output only. |
| 721 | "type": "A String", # 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. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 722 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 723 | "oldValue": { # A DNSSEC key pair. # The pre-operation DnsKey resource. |
| 724 | "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time. |
| 725 | "creationTime": "A String", # The time that this resource was created in the control plane. This is in RFC3339 text format. Output only. |
| 726 | "description": "A 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. |
| 727 | "digests": [ # 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. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 728 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 729 | "digest": "A String", # The base-16 encoded bytes of this digest. Suitable for use in a DS resource record. |
| 730 | "type": "A String", # Specifies the algorithm used to calculate this digest. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 731 | }, |
| 732 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 733 | "id": "A String", # Unique identifier for the resource; defined by the server (output only). |
| 734 | "isActive": True or False, # 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. |
| 735 | "keyLength": 42, # Length of the key in bits. Specified at creation time then immutable. |
| 736 | "keyTag": 42, # 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. |
| 737 | "kind": "dns#dnsKey", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKey". |
| 738 | "publicKey": "A String", # Base64 encoded public half of this key. Output only. |
| 739 | "type": "A String", # 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. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 740 | }, |
| 741 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 742 | "id": "A 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) |
| 743 | "kind": "dns#operation", # Identifies what kind of resource this is. Value: the fixed string "dns#operation". |
| 744 | "startTime": "A String", # The time that this operation was started by the server. This is in RFC3339 text format (output only). |
| 745 | "status": "A String", # 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. |
| 746 | "type": "A String", # Type of the operation. Operations include insert, update, and delete (output only). |
| 747 | "user": "A String", # User who requested the operation, for example: user@example.com. cloud-dns-system for operations automatically done by the system. (output only) |
| 748 | "zoneContext": { # Only populated if the operation targeted a ManagedZone (output only). |
| 749 | "newValue": { # 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. # The post-operation ManagedZone resource. |
| 750 | "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only. |
| 751 | "description": "A 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. |
| 752 | "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.". |
| 753 | "dnssecConfig": { # DNSSEC configuration. |
| 754 | "defaultKeySpecs": [ # Specifies parameters for generating initial DnsKeys for this ManagedZone. Can only be changed while the state is OFF. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 755 | { # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 756 | "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. |
| 757 | "keyLength": 42, # Length of the keys in bits. |
| 758 | "keyType": "A String", # 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. |
| 759 | "kind": "dns#dnsKeySpec", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKeySpec". |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 760 | }, |
| 761 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 762 | "kind": "dns#managedZoneDnsSecConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneDnsSecConfig". |
| 763 | "nonExistence": "A String", # Specifies the mechanism for authenticated denial-of-existence responses. Can only be changed while the state is OFF. |
| 764 | "state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 765 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 766 | "forwardingConfig": { # 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. |
| 767 | "kind": "dns#managedZoneForwardingConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneForwardingConfig". |
| 768 | "targetNameServers": [ # List of target name servers to forward to. Cloud DNS will select the best available name server if more than one target is given. |
| 769 | { |
| 770 | "ipv4Address": "A String", # IPv4 address of a target name server. |
| 771 | "kind": "dns#managedZoneForwardingConfigNameServerTarget", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneForwardingConfigNameServerTarget". |
| 772 | }, |
| 773 | ], |
| 774 | }, |
| 775 | "id": "A String", # Unique identifier for the resource; defined by the server (output only) |
| 776 | "kind": "dns#managedZone", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZone". |
| 777 | "labels": { # User labels. |
| 778 | "a_key": "A String", |
| 779 | }, |
| 780 | "name": "A 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. |
| 781 | "nameServerSet": "A 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. |
| 782 | "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only) |
| 783 | "A String", |
| 784 | ], |
| 785 | "peeringConfig": { # 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. |
| 786 | "kind": "dns#managedZonePeeringConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePeeringConfig". |
| 787 | "targetNetwork": { # The network with which to peer. |
| 788 | "deactivateTime": "A 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. |
| 789 | "kind": "dns#managedZonePeeringConfigTargetNetwork", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePeeringConfigTargetNetwork". |
| 790 | "networkUrl": "A 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} |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 791 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 792 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 793 | "privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from. |
| 794 | "kind": "dns#managedZonePrivateVisibilityConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePrivateVisibilityConfig". |
| 795 | "networks": [ # The list of VPC networks that can see this zone. |
| 796 | { |
| 797 | "kind": "dns#managedZonePrivateVisibilityConfigNetwork", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePrivateVisibilityConfigNetwork". |
| 798 | "networkUrl": "A 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} |
| 799 | }, |
| 800 | ], |
| 801 | }, |
| 802 | "visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 803 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 804 | "oldValue": { # 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. # The pre-operation ManagedZone resource. |
| 805 | "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only. |
| 806 | "description": "A 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. |
| 807 | "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.". |
| 808 | "dnssecConfig": { # DNSSEC configuration. |
| 809 | "defaultKeySpecs": [ # Specifies parameters for generating initial DnsKeys for this ManagedZone. Can only be changed while the state is OFF. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 810 | { # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 811 | "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. |
| 812 | "keyLength": 42, # Length of the keys in bits. |
| 813 | "keyType": "A String", # 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. |
| 814 | "kind": "dns#dnsKeySpec", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKeySpec". |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 815 | }, |
| 816 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 817 | "kind": "dns#managedZoneDnsSecConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneDnsSecConfig". |
| 818 | "nonExistence": "A String", # Specifies the mechanism for authenticated denial-of-existence responses. Can only be changed while the state is OFF. |
| 819 | "state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 820 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 821 | "forwardingConfig": { # 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. |
| 822 | "kind": "dns#managedZoneForwardingConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneForwardingConfig". |
| 823 | "targetNameServers": [ # List of target name servers to forward to. Cloud DNS will select the best available name server if more than one target is given. |
| 824 | { |
| 825 | "ipv4Address": "A String", # IPv4 address of a target name server. |
| 826 | "kind": "dns#managedZoneForwardingConfigNameServerTarget", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneForwardingConfigNameServerTarget". |
| 827 | }, |
| 828 | ], |
| 829 | }, |
| 830 | "id": "A String", # Unique identifier for the resource; defined by the server (output only) |
| 831 | "kind": "dns#managedZone", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZone". |
| 832 | "labels": { # User labels. |
| 833 | "a_key": "A String", |
| 834 | }, |
| 835 | "name": "A 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. |
| 836 | "nameServerSet": "A 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. |
| 837 | "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only) |
| 838 | "A String", |
| 839 | ], |
| 840 | "peeringConfig": { # 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. |
| 841 | "kind": "dns#managedZonePeeringConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePeeringConfig". |
| 842 | "targetNetwork": { # The network with which to peer. |
| 843 | "deactivateTime": "A 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. |
| 844 | "kind": "dns#managedZonePeeringConfigTargetNetwork", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePeeringConfigTargetNetwork". |
| 845 | "networkUrl": "A 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} |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 846 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 847 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 848 | "privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from. |
| 849 | "kind": "dns#managedZonePrivateVisibilityConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePrivateVisibilityConfig". |
| 850 | "networks": [ # The list of VPC networks that can see this zone. |
| 851 | { |
| 852 | "kind": "dns#managedZonePrivateVisibilityConfigNetwork", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePrivateVisibilityConfigNetwork". |
| 853 | "networkUrl": "A 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} |
| 854 | }, |
| 855 | ], |
| 856 | }, |
| 857 | "visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 858 | }, |
| 859 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 860 | }</pre> |
| 861 | </div> |
| 862 | |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 863 | </body></html> |