| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [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 | |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 75 | <h1><a href="dns_v1beta2.html">Cloud DNS API</a> . <a href="dns_v1beta2.managedZones.html">managedZones</a></h1> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 78 | <code><a href="#create">create(project, body=None, clientOperationId=None, x__xgafv=None)</a></code></p> |
| 79 | <p class="firstline">Create a new ManagedZone.</p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 80 | <p class="toc_element"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 81 | <code><a href="#delete">delete(project, managedZone, clientOperationId=None, x__xgafv=None)</a></code></p> |
| 82 | <p class="firstline">Delete a previously created ManagedZone.</p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 83 | <p class="toc_element"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 84 | <code><a href="#get">get(project, managedZone, clientOperationId=None, x__xgafv=None)</a></code></p> |
| 85 | <p class="firstline">Fetch the representation of an existing ManagedZone.</p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 86 | <p class="toc_element"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 87 | <code><a href="#list">list(project, pageToken=None, maxResults=None, dnsName=None, x__xgafv=None)</a></code></p> |
| 88 | <p class="firstline">Enumerate ManagedZones that have been created but not yet deleted.</p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 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> |
| 92 | <p class="toc_element"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 93 | <code><a href="#patch">patch(project, managedZone, body=None, clientOperationId=None, x__xgafv=None)</a></code></p> |
| 94 | <p class="firstline">Apply a partial update to an existing ManagedZone.</p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 95 | <p class="toc_element"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 96 | <code><a href="#update">update(project, managedZone, body=None, clientOperationId=None, x__xgafv=None)</a></code></p> |
| 97 | <p class="firstline">Update an existing ManagedZone.</p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 98 | <h3>Method Details</h3> |
| 99 | <div class="method"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 100 | <code class="details" id="create">create(project, body=None, clientOperationId=None, x__xgafv=None)</code> |
| 101 | <pre>Create a new ManagedZone. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 102 | |
| 103 | Args: |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 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. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 106 | The object takes the form of: |
| 107 | |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 108 | { # A zone is a subtree of the DNS namespace under one administrative |
| 109 | # responsibility. A ManagedZone is a resource that represents a DNS zone |
| 110 | # hosted by the Cloud DNS service. |
| 111 | "description": "A String", # A mutable string of at most 1024 characters associated with this resource |
| 112 | # for the user's convenience. Has no effect on the managed zone's function. |
| 113 | "name": "A String", # User assigned name for this resource. Must be unique within the project. |
| 114 | # The name must be 1-63 characters long, must begin with a letter, end with |
| 115 | # a letter or digit, and only contain lowercase letters, digits or dashes. |
| 116 | "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 |
| 117 | # text format. Output only. |
| 118 | "serviceDirectoryConfig": { # Contains information about Service Directory-backed zones. # This field links to the associated service directory namespace. This field |
| 119 | # should not be set for public zones or forwarding zones. |
| 120 | "kind": "dns#managedZoneServiceDirectoryConfig", |
| 121 | "namespace": { # Contains information about the namespace associated with the zone. |
| 122 | "namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. |
| 123 | # This should be formatted like |
| 124 | # https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace} |
| 125 | "deletionTime": "A String", # The time that the namespace backing this zone was deleted, empty |
| 126 | # string if it still exists. This is in RFC3339 text format. Output |
| 127 | # only. |
| 128 | "kind": "dns#managedZoneServiceDirectoryConfigNamespace", |
| 129 | }, |
| 130 | }, |
| 131 | "visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while |
| 132 | # private zones are visible only to Virtual Private Cloud resources. |
| 133 | "kind": "dns#managedZone", |
| 134 | "reverseLookupConfig": { # The presence of this field indicates that this is a managed reverse |
| 135 | # lookup zone and Cloud DNS will resolve reverse lookup queries using |
| 136 | # automatically configured records for VPC resources. This only applies |
| 137 | # to networks listed under private_visibility_config. |
| 138 | "kind": "dns#managedZoneReverseLookupConfig", |
| 139 | }, |
| 140 | "privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources |
| 141 | # that the zone is visible from. |
| 142 | "networks": [ # The list of VPC networks that can see this zone. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 143 | { |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 144 | "kind": "dns#managedZonePrivateVisibilityConfigNetwork", |
| 145 | "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. |
| 146 | # This should be formatted like |
| 147 | # https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 148 | }, |
| 149 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 150 | "kind": "dns#managedZonePrivateVisibilityConfig", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 151 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 152 | "dnssecConfig": { # DNSSEC configuration. |
| 153 | "defaultKeySpecs": [ # Specifies parameters for generating initial DnsKeys for this |
| 154 | # ManagedZone. Can only be changed while the state is OFF. |
| 155 | { # Parameters for DnsKey key generation. Used for generating initial keys |
| 156 | # for a new ManagedZone and as default when adding a new DnsKey. |
| 157 | "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. |
| 158 | "keyType": "A String", # Specifies whether this is a key signing key (KSK) or a zone signing key |
| 159 | # (ZSK). Key signing keys have the Secure Entry Point flag set and, when |
| 160 | # active, will only be used to sign resource record sets of type DNSKEY. |
| 161 | # Zone signing keys do not have the Secure Entry Point flag set and will be |
| 162 | # used to sign all other types of resource record sets. |
| 163 | "kind": "dns#dnsKeySpec", |
| 164 | "keyLength": 42, # Length of the keys in bits. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 165 | }, |
| 166 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 167 | "state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in. |
| 168 | "nonExistence": "A String", # Specifies the mechanism for authenticated denial-of-existence responses. |
| 169 | # Can only be changed while the state is OFF. |
| 170 | "kind": "dns#managedZoneDnsSecConfig", |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 171 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 172 | "forwardingConfig": { # The presence for this field indicates that outbound forwarding is enabled |
| 173 | # for this zone. The value of this field contains the set of destinations |
| 174 | # to forward to. |
| 175 | "targetNameServers": [ # List of target name servers to forward to. |
| 176 | # Cloud DNS will select the best available name server if more than one |
| 177 | # target is given. |
| 178 | { |
| 179 | "ipv4Address": "A String", # IPv4 address of a target name server. |
| 180 | "forwardingPath": "A String", # Forwarding path for this NameServerTarget, if unset or set to DEFAULT, |
| 181 | # Cloud DNS will make forwarding decision based on address ranges, |
| 182 | # i.e. RFC1918 addresses go to the VPC, Non-RFC1918 addresses go to the |
| 183 | # Internet. When set to PRIVATE, Cloud DNS will always send queries |
| 184 | # through VPC for this target |
| 185 | "kind": "dns#managedZoneForwardingConfigNameServerTarget", |
| 186 | }, |
| 187 | ], |
| 188 | "kind": "dns#managedZoneForwardingConfig", |
| 189 | }, |
| 190 | "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.". |
| 191 | "labels": { # User labels. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 192 | "a_key": "A String", |
| 193 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 194 | "id": "A String", # Unique identifier for the resource; defined by the server (output only) |
| 195 | "peeringConfig": { # The presence of this field indicates that DNS Peering is enabled for this |
| 196 | # zone. The value of this field contains the network to peer with. |
| 197 | "kind": "dns#managedZonePeeringConfig", |
| 198 | "targetNetwork": { # The network with which to peer. |
| 199 | "deactivateTime": "A String", # The time at which the zone was deactivated, in RFC 3339 date-time |
| 200 | # format. An empty string indicates that the peering connection is |
| 201 | # active. The producer network can deactivate a zone. The zone is |
| 202 | # automatically deactivated if the producer network that the zone |
| 203 | # targeted is deleted. Output only. |
| 204 | "kind": "dns#managedZonePeeringConfigTargetNetwork", |
| 205 | "networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. |
| 206 | # This should be formatted like |
| 207 | # https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} |
| 208 | }, |
| 209 | }, |
| 210 | "nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A |
| 211 | # NameServerSet is a set of DNS name servers that all host the same |
| 212 | # ManagedZones. Most users will leave this field unset. |
| 213 | "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the |
| 214 | # server (output only) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 215 | "A String", |
| 216 | ], |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 217 | } |
| 218 | |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 219 | clientOperationId: string, For mutating operation requests only. An optional identifier |
| 220 | specified by the client. Must be unique for operation resources in the |
| 221 | Operations collection. |
| 222 | x__xgafv: string, V1 error format. |
| 223 | Allowed values |
| 224 | 1 - v1 error format |
| 225 | 2 - v2 error format |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 226 | |
| 227 | Returns: |
| 228 | An object of the form: |
| 229 | |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 230 | { # A zone is a subtree of the DNS namespace under one administrative |
| 231 | # responsibility. A ManagedZone is a resource that represents a DNS zone |
| 232 | # hosted by the Cloud DNS service. |
| 233 | "description": "A String", # A mutable string of at most 1024 characters associated with this resource |
| 234 | # for the user's convenience. Has no effect on the managed zone's function. |
| 235 | "name": "A String", # User assigned name for this resource. Must be unique within the project. |
| 236 | # The name must be 1-63 characters long, must begin with a letter, end with |
| 237 | # a letter or digit, and only contain lowercase letters, digits or dashes. |
| 238 | "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 |
| 239 | # text format. Output only. |
| 240 | "serviceDirectoryConfig": { # Contains information about Service Directory-backed zones. # This field links to the associated service directory namespace. This field |
| 241 | # should not be set for public zones or forwarding zones. |
| 242 | "kind": "dns#managedZoneServiceDirectoryConfig", |
| 243 | "namespace": { # Contains information about the namespace associated with the zone. |
| 244 | "namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. |
| 245 | # This should be formatted like |
| 246 | # https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace} |
| 247 | "deletionTime": "A String", # The time that the namespace backing this zone was deleted, empty |
| 248 | # string if it still exists. This is in RFC3339 text format. Output |
| 249 | # only. |
| 250 | "kind": "dns#managedZoneServiceDirectoryConfigNamespace", |
| 251 | }, |
| 252 | }, |
| 253 | "visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while |
| 254 | # private zones are visible only to Virtual Private Cloud resources. |
| 255 | "kind": "dns#managedZone", |
| 256 | "reverseLookupConfig": { # The presence of this field indicates that this is a managed reverse |
| 257 | # lookup zone and Cloud DNS will resolve reverse lookup queries using |
| 258 | # automatically configured records for VPC resources. This only applies |
| 259 | # to networks listed under private_visibility_config. |
| 260 | "kind": "dns#managedZoneReverseLookupConfig", |
| 261 | }, |
| 262 | "privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources |
| 263 | # that the zone is visible from. |
| 264 | "networks": [ # The list of VPC networks that can see this zone. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 265 | { |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 266 | "kind": "dns#managedZonePrivateVisibilityConfigNetwork", |
| 267 | "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. |
| 268 | # This should be formatted like |
| 269 | # https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 270 | }, |
| 271 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 272 | "kind": "dns#managedZonePrivateVisibilityConfig", |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 273 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 274 | "dnssecConfig": { # DNSSEC configuration. |
| 275 | "defaultKeySpecs": [ # Specifies parameters for generating initial DnsKeys for this |
| 276 | # ManagedZone. Can only be changed while the state is OFF. |
| 277 | { # Parameters for DnsKey key generation. Used for generating initial keys |
| 278 | # for a new ManagedZone and as default when adding a new DnsKey. |
| 279 | "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. |
| 280 | "keyType": "A String", # Specifies whether this is a key signing key (KSK) or a zone signing key |
| 281 | # (ZSK). Key signing keys have the Secure Entry Point flag set and, when |
| 282 | # active, will only be used to sign resource record sets of type DNSKEY. |
| 283 | # Zone signing keys do not have the Secure Entry Point flag set and will be |
| 284 | # used to sign all other types of resource record sets. |
| 285 | "kind": "dns#dnsKeySpec", |
| 286 | "keyLength": 42, # Length of the keys in bits. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 287 | }, |
| 288 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 289 | "state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in. |
| 290 | "nonExistence": "A String", # Specifies the mechanism for authenticated denial-of-existence responses. |
| 291 | # Can only be changed while the state is OFF. |
| 292 | "kind": "dns#managedZoneDnsSecConfig", |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 293 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 294 | "forwardingConfig": { # The presence for this field indicates that outbound forwarding is enabled |
| 295 | # for this zone. The value of this field contains the set of destinations |
| 296 | # to forward to. |
| 297 | "targetNameServers": [ # List of target name servers to forward to. |
| 298 | # Cloud DNS will select the best available name server if more than one |
| 299 | # target is given. |
| 300 | { |
| 301 | "ipv4Address": "A String", # IPv4 address of a target name server. |
| 302 | "forwardingPath": "A String", # Forwarding path for this NameServerTarget, if unset or set to DEFAULT, |
| 303 | # Cloud DNS will make forwarding decision based on address ranges, |
| 304 | # i.e. RFC1918 addresses go to the VPC, Non-RFC1918 addresses go to the |
| 305 | # Internet. When set to PRIVATE, Cloud DNS will always send queries |
| 306 | # through VPC for this target |
| 307 | "kind": "dns#managedZoneForwardingConfigNameServerTarget", |
| 308 | }, |
| 309 | ], |
| 310 | "kind": "dns#managedZoneForwardingConfig", |
| 311 | }, |
| 312 | "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.". |
| 313 | "labels": { # User labels. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 314 | "a_key": "A String", |
| 315 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 316 | "id": "A String", # Unique identifier for the resource; defined by the server (output only) |
| 317 | "peeringConfig": { # The presence of this field indicates that DNS Peering is enabled for this |
| 318 | # zone. The value of this field contains the network to peer with. |
| 319 | "kind": "dns#managedZonePeeringConfig", |
| 320 | "targetNetwork": { # The network with which to peer. |
| 321 | "deactivateTime": "A String", # The time at which the zone was deactivated, in RFC 3339 date-time |
| 322 | # format. An empty string indicates that the peering connection is |
| 323 | # active. The producer network can deactivate a zone. The zone is |
| 324 | # automatically deactivated if the producer network that the zone |
| 325 | # targeted is deleted. Output only. |
| 326 | "kind": "dns#managedZonePeeringConfigTargetNetwork", |
| 327 | "networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. |
| 328 | # This should be formatted like |
| 329 | # https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} |
| 330 | }, |
| 331 | }, |
| 332 | "nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A |
| 333 | # NameServerSet is a set of DNS name servers that all host the same |
| 334 | # ManagedZones. Most users will leave this field unset. |
| 335 | "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the |
| 336 | # server (output only) |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 337 | "A String", |
| 338 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 339 | }</pre> |
| 340 | </div> |
| 341 | |
| 342 | <div class="method"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 343 | <code class="details" id="delete">delete(project, managedZone, clientOperationId=None, x__xgafv=None)</code> |
| 344 | <pre>Delete a previously created ManagedZone. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 345 | |
| 346 | Args: |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 347 | project: string, Identifies the project addressed by this request. (required) |
| 348 | managedZone: string, Identifies the managed zone addressed by this request. Can be the managed |
| 349 | zone name or id. (required) |
| 350 | clientOperationId: string, For mutating operation requests only. An optional identifier |
| 351 | specified by the client. Must be unique for operation resources in the |
| 352 | Operations collection. |
| 353 | x__xgafv: string, V1 error format. |
| 354 | Allowed values |
| 355 | 1 - v1 error format |
| 356 | 2 - v2 error format |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 357 | </pre> |
| 358 | </div> |
| 359 | |
| 360 | <div class="method"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 361 | <code class="details" id="get">get(project, managedZone, clientOperationId=None, x__xgafv=None)</code> |
| 362 | <pre>Fetch the representation of an existing ManagedZone. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 363 | |
| 364 | Args: |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 365 | project: string, Identifies the project addressed by this request. (required) |
| 366 | managedZone: string, Identifies the managed zone addressed by this request. Can be the managed |
| 367 | zone name or id. (required) |
| 368 | clientOperationId: string, For mutating operation requests only. An optional identifier |
| 369 | specified by the client. Must be unique for operation resources in the |
| 370 | Operations collection. |
| 371 | x__xgafv: string, V1 error format. |
| 372 | Allowed values |
| 373 | 1 - v1 error format |
| 374 | 2 - v2 error format |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 375 | |
| 376 | Returns: |
| 377 | An object of the form: |
| 378 | |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 379 | { # A zone is a subtree of the DNS namespace under one administrative |
| 380 | # responsibility. A ManagedZone is a resource that represents a DNS zone |
| 381 | # hosted by the Cloud DNS service. |
| 382 | "description": "A String", # A mutable string of at most 1024 characters associated with this resource |
| 383 | # for the user's convenience. Has no effect on the managed zone's function. |
| 384 | "name": "A String", # User assigned name for this resource. Must be unique within the project. |
| 385 | # The name must be 1-63 characters long, must begin with a letter, end with |
| 386 | # a letter or digit, and only contain lowercase letters, digits or dashes. |
| 387 | "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 |
| 388 | # text format. Output only. |
| 389 | "serviceDirectoryConfig": { # Contains information about Service Directory-backed zones. # This field links to the associated service directory namespace. This field |
| 390 | # should not be set for public zones or forwarding zones. |
| 391 | "kind": "dns#managedZoneServiceDirectoryConfig", |
| 392 | "namespace": { # Contains information about the namespace associated with the zone. |
| 393 | "namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. |
| 394 | # This should be formatted like |
| 395 | # https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace} |
| 396 | "deletionTime": "A String", # The time that the namespace backing this zone was deleted, empty |
| 397 | # string if it still exists. This is in RFC3339 text format. Output |
| 398 | # only. |
| 399 | "kind": "dns#managedZoneServiceDirectoryConfigNamespace", |
| 400 | }, |
| 401 | }, |
| 402 | "visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while |
| 403 | # private zones are visible only to Virtual Private Cloud resources. |
| 404 | "kind": "dns#managedZone", |
| 405 | "reverseLookupConfig": { # The presence of this field indicates that this is a managed reverse |
| 406 | # lookup zone and Cloud DNS will resolve reverse lookup queries using |
| 407 | # automatically configured records for VPC resources. This only applies |
| 408 | # to networks listed under private_visibility_config. |
| 409 | "kind": "dns#managedZoneReverseLookupConfig", |
| 410 | }, |
| 411 | "privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources |
| 412 | # that the zone is visible from. |
| 413 | "networks": [ # The list of VPC networks that can see this zone. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 414 | { |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 415 | "kind": "dns#managedZonePrivateVisibilityConfigNetwork", |
| 416 | "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. |
| 417 | # This should be formatted like |
| 418 | # https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 419 | }, |
| 420 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 421 | "kind": "dns#managedZonePrivateVisibilityConfig", |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 422 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 423 | "dnssecConfig": { # DNSSEC configuration. |
| 424 | "defaultKeySpecs": [ # Specifies parameters for generating initial DnsKeys for this |
| 425 | # ManagedZone. Can only be changed while the state is OFF. |
| 426 | { # Parameters for DnsKey key generation. Used for generating initial keys |
| 427 | # for a new ManagedZone and as default when adding a new DnsKey. |
| 428 | "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. |
| 429 | "keyType": "A String", # Specifies whether this is a key signing key (KSK) or a zone signing key |
| 430 | # (ZSK). Key signing keys have the Secure Entry Point flag set and, when |
| 431 | # active, will only be used to sign resource record sets of type DNSKEY. |
| 432 | # Zone signing keys do not have the Secure Entry Point flag set and will be |
| 433 | # used to sign all other types of resource record sets. |
| 434 | "kind": "dns#dnsKeySpec", |
| 435 | "keyLength": 42, # Length of the keys in bits. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 436 | }, |
| 437 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 438 | "state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in. |
| 439 | "nonExistence": "A String", # Specifies the mechanism for authenticated denial-of-existence responses. |
| 440 | # Can only be changed while the state is OFF. |
| 441 | "kind": "dns#managedZoneDnsSecConfig", |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 442 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 443 | "forwardingConfig": { # The presence for this field indicates that outbound forwarding is enabled |
| 444 | # for this zone. The value of this field contains the set of destinations |
| 445 | # to forward to. |
| 446 | "targetNameServers": [ # List of target name servers to forward to. |
| 447 | # Cloud DNS will select the best available name server if more than one |
| 448 | # target is given. |
| 449 | { |
| 450 | "ipv4Address": "A String", # IPv4 address of a target name server. |
| 451 | "forwardingPath": "A String", # Forwarding path for this NameServerTarget, if unset or set to DEFAULT, |
| 452 | # Cloud DNS will make forwarding decision based on address ranges, |
| 453 | # i.e. RFC1918 addresses go to the VPC, Non-RFC1918 addresses go to the |
| 454 | # Internet. When set to PRIVATE, Cloud DNS will always send queries |
| 455 | # through VPC for this target |
| 456 | "kind": "dns#managedZoneForwardingConfigNameServerTarget", |
| 457 | }, |
| 458 | ], |
| 459 | "kind": "dns#managedZoneForwardingConfig", |
| 460 | }, |
| 461 | "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.". |
| 462 | "labels": { # User labels. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 463 | "a_key": "A String", |
| 464 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 465 | "id": "A String", # Unique identifier for the resource; defined by the server (output only) |
| 466 | "peeringConfig": { # The presence of this field indicates that DNS Peering is enabled for this |
| 467 | # zone. The value of this field contains the network to peer with. |
| 468 | "kind": "dns#managedZonePeeringConfig", |
| 469 | "targetNetwork": { # The network with which to peer. |
| 470 | "deactivateTime": "A String", # The time at which the zone was deactivated, in RFC 3339 date-time |
| 471 | # format. An empty string indicates that the peering connection is |
| 472 | # active. The producer network can deactivate a zone. The zone is |
| 473 | # automatically deactivated if the producer network that the zone |
| 474 | # targeted is deleted. Output only. |
| 475 | "kind": "dns#managedZonePeeringConfigTargetNetwork", |
| 476 | "networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. |
| 477 | # This should be formatted like |
| 478 | # https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} |
| 479 | }, |
| 480 | }, |
| 481 | "nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A |
| 482 | # NameServerSet is a set of DNS name servers that all host the same |
| 483 | # ManagedZones. Most users will leave this field unset. |
| 484 | "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the |
| 485 | # server (output only) |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 486 | "A String", |
| 487 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 488 | }</pre> |
| 489 | </div> |
| 490 | |
| 491 | <div class="method"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 492 | <code class="details" id="list">list(project, pageToken=None, maxResults=None, dnsName=None, x__xgafv=None)</code> |
| 493 | <pre>Enumerate ManagedZones that have been created but not yet deleted. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 494 | |
| 495 | Args: |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 496 | project: string, Identifies the project addressed by this request. (required) |
| 497 | pageToken: string, Optional. A tag returned by a previous list request that was truncated. |
| 498 | Use this parameter to continue a previous list request. |
| 499 | maxResults: integer, Optional. Maximum number of results to be returned. If unspecified, the |
| 500 | server will decide how many results to return. |
| 501 | dnsName: string, Restricts the list to return only zones with this domain name. |
| 502 | x__xgafv: string, V1 error format. |
| 503 | Allowed values |
| 504 | 1 - v1 error format |
| 505 | 2 - v2 error format |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 506 | |
| 507 | Returns: |
| 508 | An object of the form: |
| 509 | |
| 510 | { |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 511 | "managedZones": [ # The managed zone resources. |
| 512 | { # A zone is a subtree of the DNS namespace under one administrative |
| 513 | # responsibility. A ManagedZone is a resource that represents a DNS zone |
| 514 | # hosted by the Cloud DNS service. |
| 515 | "description": "A String", # A mutable string of at most 1024 characters associated with this resource |
| 516 | # for the user's convenience. Has no effect on the managed zone's function. |
| 517 | "name": "A String", # User assigned name for this resource. Must be unique within the project. |
| 518 | # The name must be 1-63 characters long, must begin with a letter, end with |
| 519 | # a letter or digit, and only contain lowercase letters, digits or dashes. |
| 520 | "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 |
| 521 | # text format. Output only. |
| 522 | "serviceDirectoryConfig": { # Contains information about Service Directory-backed zones. # This field links to the associated service directory namespace. This field |
| 523 | # should not be set for public zones or forwarding zones. |
| 524 | "kind": "dns#managedZoneServiceDirectoryConfig", |
| 525 | "namespace": { # Contains information about the namespace associated with the zone. |
| 526 | "namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. |
| 527 | # This should be formatted like |
| 528 | # https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace} |
| 529 | "deletionTime": "A String", # The time that the namespace backing this zone was deleted, empty |
| 530 | # string if it still exists. This is in RFC3339 text format. Output |
| 531 | # only. |
| 532 | "kind": "dns#managedZoneServiceDirectoryConfigNamespace", |
| 533 | }, |
| 534 | }, |
| 535 | "visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while |
| 536 | # private zones are visible only to Virtual Private Cloud resources. |
| 537 | "kind": "dns#managedZone", |
| 538 | "reverseLookupConfig": { # The presence of this field indicates that this is a managed reverse |
| 539 | # lookup zone and Cloud DNS will resolve reverse lookup queries using |
| 540 | # automatically configured records for VPC resources. This only applies |
| 541 | # to networks listed under private_visibility_config. |
| 542 | "kind": "dns#managedZoneReverseLookupConfig", |
| 543 | }, |
| 544 | "privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources |
| 545 | # that the zone is visible from. |
| 546 | "networks": [ # The list of VPC networks that can see this zone. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 547 | { |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 548 | "kind": "dns#managedZonePrivateVisibilityConfigNetwork", |
| 549 | "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. |
| 550 | # This should be formatted like |
| 551 | # https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 552 | }, |
| 553 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 554 | "kind": "dns#managedZonePrivateVisibilityConfig", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 555 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 556 | "dnssecConfig": { # DNSSEC configuration. |
| 557 | "defaultKeySpecs": [ # Specifies parameters for generating initial DnsKeys for this |
| 558 | # ManagedZone. Can only be changed while the state is OFF. |
| 559 | { # Parameters for DnsKey key generation. Used for generating initial keys |
| 560 | # for a new ManagedZone and as default when adding a new DnsKey. |
| 561 | "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. |
| 562 | "keyType": "A String", # Specifies whether this is a key signing key (KSK) or a zone signing key |
| 563 | # (ZSK). Key signing keys have the Secure Entry Point flag set and, when |
| 564 | # active, will only be used to sign resource record sets of type DNSKEY. |
| 565 | # Zone signing keys do not have the Secure Entry Point flag set and will be |
| 566 | # used to sign all other types of resource record sets. |
| 567 | "kind": "dns#dnsKeySpec", |
| 568 | "keyLength": 42, # Length of the keys in bits. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 569 | }, |
| 570 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 571 | "state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in. |
| 572 | "nonExistence": "A String", # Specifies the mechanism for authenticated denial-of-existence responses. |
| 573 | # Can only be changed while the state is OFF. |
| 574 | "kind": "dns#managedZoneDnsSecConfig", |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 575 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 576 | "forwardingConfig": { # The presence for this field indicates that outbound forwarding is enabled |
| 577 | # for this zone. The value of this field contains the set of destinations |
| 578 | # to forward to. |
| 579 | "targetNameServers": [ # List of target name servers to forward to. |
| 580 | # Cloud DNS will select the best available name server if more than one |
| 581 | # target is given. |
| 582 | { |
| 583 | "ipv4Address": "A String", # IPv4 address of a target name server. |
| 584 | "forwardingPath": "A String", # Forwarding path for this NameServerTarget, if unset or set to DEFAULT, |
| 585 | # Cloud DNS will make forwarding decision based on address ranges, |
| 586 | # i.e. RFC1918 addresses go to the VPC, Non-RFC1918 addresses go to the |
| 587 | # Internet. When set to PRIVATE, Cloud DNS will always send queries |
| 588 | # through VPC for this target |
| 589 | "kind": "dns#managedZoneForwardingConfigNameServerTarget", |
| 590 | }, |
| 591 | ], |
| 592 | "kind": "dns#managedZoneForwardingConfig", |
| 593 | }, |
| 594 | "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.". |
| 595 | "labels": { # User labels. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 596 | "a_key": "A String", |
| 597 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 598 | "id": "A String", # Unique identifier for the resource; defined by the server (output only) |
| 599 | "peeringConfig": { # The presence of this field indicates that DNS Peering is enabled for this |
| 600 | # zone. The value of this field contains the network to peer with. |
| 601 | "kind": "dns#managedZonePeeringConfig", |
| 602 | "targetNetwork": { # The network with which to peer. |
| 603 | "deactivateTime": "A String", # The time at which the zone was deactivated, in RFC 3339 date-time |
| 604 | # format. An empty string indicates that the peering connection is |
| 605 | # active. The producer network can deactivate a zone. The zone is |
| 606 | # automatically deactivated if the producer network that the zone |
| 607 | # targeted is deleted. Output only. |
| 608 | "kind": "dns#managedZonePeeringConfigTargetNetwork", |
| 609 | "networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. |
| 610 | # This should be formatted like |
| 611 | # https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} |
| 612 | }, |
| 613 | }, |
| 614 | "nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A |
| 615 | # NameServerSet is a set of DNS name servers that all host the same |
| 616 | # ManagedZones. Most users will leave this field unset. |
| 617 | "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the |
| 618 | # server (output only) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 619 | "A String", |
| 620 | ], |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 621 | }, |
| 622 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 623 | "header": { # Elements common to every response. |
| 624 | "operationId": "A String", # For mutating operation requests that completed successfully. |
| 625 | # This is the client_operation_id if the client specified it, |
| 626 | # otherwise it is generated by the server (output only). |
| 627 | }, |
| 628 | "nextPageToken": "A String", # The presence of this field indicates that there exist more results |
| 629 | # following your last page of results in pagination order. To fetch them, |
| 630 | # make another list request using this value as your page token. |
| 631 | # |
| 632 | # In this way you can retrieve the complete contents of even very large |
| 633 | # collections one page at a time. However, if the contents of the collection |
| 634 | # change between the first and last paginated list request, the set of all |
| 635 | # elements returned will be an inconsistent view of the collection. There is |
| 636 | # no way to retrieve a consistent snapshot of a collection larger than the |
| 637 | # maximum page size. |
| 638 | "kind": "dns#managedZonesListResponse", # Type of resource. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 639 | }</pre> |
| 640 | </div> |
| 641 | |
| 642 | <div class="method"> |
| 643 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 644 | <pre>Retrieves the next page of results. |
| 645 | |
| 646 | Args: |
| 647 | previous_request: The request for the previous page. (required) |
| 648 | previous_response: The response from the request for the previous page. (required) |
| 649 | |
| 650 | Returns: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 651 | A request object that you can call 'execute()' on to request the next |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 652 | page. Returns None if there are no more items in the collection. |
| 653 | </pre> |
| 654 | </div> |
| 655 | |
| 656 | <div class="method"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 657 | <code class="details" id="patch">patch(project, managedZone, body=None, clientOperationId=None, x__xgafv=None)</code> |
| 658 | <pre>Apply a partial update to an existing ManagedZone. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 659 | |
| 660 | Args: |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 661 | project: string, Identifies the project addressed by this request. (required) |
| 662 | managedZone: string, Identifies the managed zone addressed by this request. Can be the managed |
| 663 | zone name or id. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 664 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 665 | The object takes the form of: |
| 666 | |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 667 | { # A zone is a subtree of the DNS namespace under one administrative |
| 668 | # responsibility. A ManagedZone is a resource that represents a DNS zone |
| 669 | # hosted by the Cloud DNS service. |
| 670 | "description": "A String", # A mutable string of at most 1024 characters associated with this resource |
| 671 | # for the user's convenience. Has no effect on the managed zone's function. |
| 672 | "name": "A String", # User assigned name for this resource. Must be unique within the project. |
| 673 | # The name must be 1-63 characters long, must begin with a letter, end with |
| 674 | # a letter or digit, and only contain lowercase letters, digits or dashes. |
| 675 | "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 |
| 676 | # text format. Output only. |
| 677 | "serviceDirectoryConfig": { # Contains information about Service Directory-backed zones. # This field links to the associated service directory namespace. This field |
| 678 | # should not be set for public zones or forwarding zones. |
| 679 | "kind": "dns#managedZoneServiceDirectoryConfig", |
| 680 | "namespace": { # Contains information about the namespace associated with the zone. |
| 681 | "namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. |
| 682 | # This should be formatted like |
| 683 | # https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace} |
| 684 | "deletionTime": "A String", # The time that the namespace backing this zone was deleted, empty |
| 685 | # string if it still exists. This is in RFC3339 text format. Output |
| 686 | # only. |
| 687 | "kind": "dns#managedZoneServiceDirectoryConfigNamespace", |
| 688 | }, |
| 689 | }, |
| 690 | "visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while |
| 691 | # private zones are visible only to Virtual Private Cloud resources. |
| 692 | "kind": "dns#managedZone", |
| 693 | "reverseLookupConfig": { # The presence of this field indicates that this is a managed reverse |
| 694 | # lookup zone and Cloud DNS will resolve reverse lookup queries using |
| 695 | # automatically configured records for VPC resources. This only applies |
| 696 | # to networks listed under private_visibility_config. |
| 697 | "kind": "dns#managedZoneReverseLookupConfig", |
| 698 | }, |
| 699 | "privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources |
| 700 | # that the zone is visible from. |
| 701 | "networks": [ # The list of VPC networks that can see this zone. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 702 | { |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 703 | "kind": "dns#managedZonePrivateVisibilityConfigNetwork", |
| 704 | "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. |
| 705 | # This should be formatted like |
| 706 | # https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 707 | }, |
| 708 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 709 | "kind": "dns#managedZonePrivateVisibilityConfig", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 710 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 711 | "dnssecConfig": { # DNSSEC configuration. |
| 712 | "defaultKeySpecs": [ # Specifies parameters for generating initial DnsKeys for this |
| 713 | # ManagedZone. Can only be changed while the state is OFF. |
| 714 | { # Parameters for DnsKey key generation. Used for generating initial keys |
| 715 | # for a new ManagedZone and as default when adding a new DnsKey. |
| 716 | "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. |
| 717 | "keyType": "A String", # Specifies whether this is a key signing key (KSK) or a zone signing key |
| 718 | # (ZSK). Key signing keys have the Secure Entry Point flag set and, when |
| 719 | # active, will only be used to sign resource record sets of type DNSKEY. |
| 720 | # Zone signing keys do not have the Secure Entry Point flag set and will be |
| 721 | # used to sign all other types of resource record sets. |
| 722 | "kind": "dns#dnsKeySpec", |
| 723 | "keyLength": 42, # Length of the keys in bits. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 724 | }, |
| 725 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 726 | "state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in. |
| 727 | "nonExistence": "A String", # Specifies the mechanism for authenticated denial-of-existence responses. |
| 728 | # Can only be changed while the state is OFF. |
| 729 | "kind": "dns#managedZoneDnsSecConfig", |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 730 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 731 | "forwardingConfig": { # The presence for this field indicates that outbound forwarding is enabled |
| 732 | # for this zone. The value of this field contains the set of destinations |
| 733 | # to forward to. |
| 734 | "targetNameServers": [ # List of target name servers to forward to. |
| 735 | # Cloud DNS will select the best available name server if more than one |
| 736 | # target is given. |
| 737 | { |
| 738 | "ipv4Address": "A String", # IPv4 address of a target name server. |
| 739 | "forwardingPath": "A String", # Forwarding path for this NameServerTarget, if unset or set to DEFAULT, |
| 740 | # Cloud DNS will make forwarding decision based on address ranges, |
| 741 | # i.e. RFC1918 addresses go to the VPC, Non-RFC1918 addresses go to the |
| 742 | # Internet. When set to PRIVATE, Cloud DNS will always send queries |
| 743 | # through VPC for this target |
| 744 | "kind": "dns#managedZoneForwardingConfigNameServerTarget", |
| 745 | }, |
| 746 | ], |
| 747 | "kind": "dns#managedZoneForwardingConfig", |
| 748 | }, |
| 749 | "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.". |
| 750 | "labels": { # User labels. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 751 | "a_key": "A String", |
| 752 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 753 | "id": "A String", # Unique identifier for the resource; defined by the server (output only) |
| 754 | "peeringConfig": { # The presence of this field indicates that DNS Peering is enabled for this |
| 755 | # zone. The value of this field contains the network to peer with. |
| 756 | "kind": "dns#managedZonePeeringConfig", |
| 757 | "targetNetwork": { # The network with which to peer. |
| 758 | "deactivateTime": "A String", # The time at which the zone was deactivated, in RFC 3339 date-time |
| 759 | # format. An empty string indicates that the peering connection is |
| 760 | # active. The producer network can deactivate a zone. The zone is |
| 761 | # automatically deactivated if the producer network that the zone |
| 762 | # targeted is deleted. Output only. |
| 763 | "kind": "dns#managedZonePeeringConfigTargetNetwork", |
| 764 | "networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. |
| 765 | # This should be formatted like |
| 766 | # https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} |
| 767 | }, |
| 768 | }, |
| 769 | "nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A |
| 770 | # NameServerSet is a set of DNS name servers that all host the same |
| 771 | # ManagedZones. Most users will leave this field unset. |
| 772 | "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the |
| 773 | # server (output only) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 774 | "A String", |
| 775 | ], |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 776 | } |
| 777 | |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 778 | clientOperationId: string, For mutating operation requests only. An optional identifier |
| 779 | specified by the client. Must be unique for operation resources in the |
| 780 | Operations collection. |
| 781 | x__xgafv: string, V1 error format. |
| 782 | Allowed values |
| 783 | 1 - v1 error format |
| 784 | 2 - v2 error format |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 785 | |
| 786 | Returns: |
| 787 | An object of the form: |
| 788 | |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 789 | { # An operation represents a successful mutation performed on a Cloud DNS |
| 790 | # resource. |
| 791 | # Operations provide: |
| 792 | # - An audit log of server resource mutations. |
| 793 | # - A way to recover/retry API calls in the case where the response is never |
| 794 | # received by the caller. Use the caller specified client_operation_id. |
| 795 | "dnsKeyContext": { # Only populated if the operation targeted a DnsKey (output only). |
| 796 | "newValue": { # A DNSSEC key pair. # The post-operation DnsKey resource. |
| 797 | "id": "A String", # Unique identifier for the resource; defined by the server (output only). |
| 798 | "kind": "dns#dnsKey", |
| 799 | "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. Immutable |
| 800 | # after creation time. |
| 801 | "publicKey": "A String", # Base64 encoded public half of this key. Output only. |
| 802 | "keyLength": 42, # Length of the key in bits. Specified at creation time then immutable. |
| 803 | "creationTime": "A String", # The time that this resource was created in the control plane. This is in |
| 804 | # RFC3339 text format. Output only. |
| 805 | "isActive": True or False, # Active keys will be used to sign subsequent changes to the ManagedZone. |
| 806 | # Inactive keys will still be present as DNSKEY Resource Records for the use |
| 807 | # of resolvers validating existing signatures. |
| 808 | "digests": [ # Cryptographic hashes of the DNSKEY resource record associated with this |
| 809 | # DnsKey. These digests are needed to construct a DS record that points at |
| 810 | # this DNS key. Output only. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 811 | { |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 812 | "type": "A String", # Specifies the algorithm used to calculate this digest. |
| 813 | "digest": "A String", # The base-16 encoded bytes of this digest. Suitable for use in a DS |
| 814 | # resource record. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 815 | }, |
| 816 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 817 | "type": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the |
| 818 | # Secure Entry Point flag set and, when active, will be used to sign only |
| 819 | # resource record sets of type DNSKEY. Otherwise, the Secure Entry Point |
| 820 | # flag will be cleared and this key will be used to sign only resource |
| 821 | # record sets of other types. Immutable after creation time. |
| 822 | "keyTag": 42, # The key tag is a non-cryptographic hash of the a DNSKEY resource record |
| 823 | # associated with this DnsKey. The key tag can be used to identify a DNSKEY |
| 824 | # more quickly (but it is not a unique identifier). In particular, the key |
| 825 | # tag is used in a parent zone's DS record to point at the DNSKEY in this |
| 826 | # child ManagedZone. The key tag is a number in the range [0, 65535] and the |
| 827 | # algorithm to calculate it is specified in RFC4034 Appendix B. Output only. |
| 828 | "description": "A String", # A mutable string of at most 1024 characters associated with this resource |
| 829 | # for the user's convenience. Has no effect on the resource's function. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 830 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 831 | "oldValue": { # A DNSSEC key pair. # The pre-operation DnsKey resource. |
| 832 | "id": "A String", # Unique identifier for the resource; defined by the server (output only). |
| 833 | "kind": "dns#dnsKey", |
| 834 | "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. Immutable |
| 835 | # after creation time. |
| 836 | "publicKey": "A String", # Base64 encoded public half of this key. Output only. |
| 837 | "keyLength": 42, # Length of the key in bits. Specified at creation time then immutable. |
| 838 | "creationTime": "A String", # The time that this resource was created in the control plane. This is in |
| 839 | # RFC3339 text format. Output only. |
| 840 | "isActive": True or False, # Active keys will be used to sign subsequent changes to the ManagedZone. |
| 841 | # Inactive keys will still be present as DNSKEY Resource Records for the use |
| 842 | # of resolvers validating existing signatures. |
| 843 | "digests": [ # Cryptographic hashes of the DNSKEY resource record associated with this |
| 844 | # DnsKey. These digests are needed to construct a DS record that points at |
| 845 | # this DNS key. Output only. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 846 | { |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 847 | "type": "A String", # Specifies the algorithm used to calculate this digest. |
| 848 | "digest": "A String", # The base-16 encoded bytes of this digest. Suitable for use in a DS |
| 849 | # resource record. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 850 | }, |
| 851 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 852 | "type": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the |
| 853 | # Secure Entry Point flag set and, when active, will be used to sign only |
| 854 | # resource record sets of type DNSKEY. Otherwise, the Secure Entry Point |
| 855 | # flag will be cleared and this key will be used to sign only resource |
| 856 | # record sets of other types. Immutable after creation time. |
| 857 | "keyTag": 42, # The key tag is a non-cryptographic hash of the a DNSKEY resource record |
| 858 | # associated with this DnsKey. The key tag can be used to identify a DNSKEY |
| 859 | # more quickly (but it is not a unique identifier). In particular, the key |
| 860 | # tag is used in a parent zone's DS record to point at the DNSKEY in this |
| 861 | # child ManagedZone. The key tag is a number in the range [0, 65535] and the |
| 862 | # algorithm to calculate it is specified in RFC4034 Appendix B. Output only. |
| 863 | "description": "A String", # A mutable string of at most 1024 characters associated with this resource |
| 864 | # for the user's convenience. Has no effect on the resource's function. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 865 | }, |
| 866 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 867 | "id": "A String", # Unique identifier for the resource. This is the client_operation_id if |
| 868 | # the client specified it when the mutation was initiated, otherwise, |
| 869 | # it is generated by the server. The name must be 1-63 characters long |
| 870 | # and match the regular expression [-a-z0-9]? (output only) |
| 871 | "user": "A String", # User who requested the operation, for example: user@example.com. |
| 872 | # cloud-dns-system for operations automatically done by the system. |
| 873 | # (output only) |
| 874 | "kind": "dns#operation", |
| 875 | "startTime": "A String", # The time that this operation was started by the server. This is in RFC3339 |
| 876 | # text format (output only). |
| 877 | "type": "A String", # Type of the operation. Operations include insert, update, and delete |
| 878 | # (output only). |
| 879 | "status": "A String", # Status of the operation. Can be one of the following: "PENDING" or "DONE" |
| 880 | # (output only). A status of "DONE" means that the |
| 881 | # request to update the authoritative servers has been sent, but the |
| 882 | # servers might not be updated yet. |
| 883 | "zoneContext": { # Only populated if the operation targeted a ManagedZone (output only). |
| 884 | "newValue": { # A zone is a subtree of the DNS namespace under one administrative # The post-operation ManagedZone resource. |
| 885 | # responsibility. A ManagedZone is a resource that represents a DNS zone |
| 886 | # hosted by the Cloud DNS service. |
| 887 | "description": "A String", # A mutable string of at most 1024 characters associated with this resource |
| 888 | # for the user's convenience. Has no effect on the managed zone's function. |
| 889 | "name": "A String", # User assigned name for this resource. Must be unique within the project. |
| 890 | # The name must be 1-63 characters long, must begin with a letter, end with |
| 891 | # a letter or digit, and only contain lowercase letters, digits or dashes. |
| 892 | "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 |
| 893 | # text format. Output only. |
| 894 | "serviceDirectoryConfig": { # Contains information about Service Directory-backed zones. # This field links to the associated service directory namespace. This field |
| 895 | # should not be set for public zones or forwarding zones. |
| 896 | "kind": "dns#managedZoneServiceDirectoryConfig", |
| 897 | "namespace": { # Contains information about the namespace associated with the zone. |
| 898 | "namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. |
| 899 | # This should be formatted like |
| 900 | # https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace} |
| 901 | "deletionTime": "A String", # The time that the namespace backing this zone was deleted, empty |
| 902 | # string if it still exists. This is in RFC3339 text format. Output |
| 903 | # only. |
| 904 | "kind": "dns#managedZoneServiceDirectoryConfigNamespace", |
| 905 | }, |
| 906 | }, |
| 907 | "visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while |
| 908 | # private zones are visible only to Virtual Private Cloud resources. |
| 909 | "kind": "dns#managedZone", |
| 910 | "reverseLookupConfig": { # The presence of this field indicates that this is a managed reverse |
| 911 | # lookup zone and Cloud DNS will resolve reverse lookup queries using |
| 912 | # automatically configured records for VPC resources. This only applies |
| 913 | # to networks listed under private_visibility_config. |
| 914 | "kind": "dns#managedZoneReverseLookupConfig", |
| 915 | }, |
| 916 | "privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources |
| 917 | # that the zone is visible from. |
| 918 | "networks": [ # The list of VPC networks that can see this zone. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 919 | { |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 920 | "kind": "dns#managedZonePrivateVisibilityConfigNetwork", |
| 921 | "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. |
| 922 | # This should be formatted like |
| 923 | # https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 924 | }, |
| 925 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 926 | "kind": "dns#managedZonePrivateVisibilityConfig", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 927 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 928 | "dnssecConfig": { # DNSSEC configuration. |
| 929 | "defaultKeySpecs": [ # Specifies parameters for generating initial DnsKeys for this |
| 930 | # ManagedZone. Can only be changed while the state is OFF. |
| 931 | { # Parameters for DnsKey key generation. Used for generating initial keys |
| 932 | # for a new ManagedZone and as default when adding a new DnsKey. |
| 933 | "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. |
| 934 | "keyType": "A String", # Specifies whether this is a key signing key (KSK) or a zone signing key |
| 935 | # (ZSK). Key signing keys have the Secure Entry Point flag set and, when |
| 936 | # active, will only be used to sign resource record sets of type DNSKEY. |
| 937 | # Zone signing keys do not have the Secure Entry Point flag set and will be |
| 938 | # used to sign all other types of resource record sets. |
| 939 | "kind": "dns#dnsKeySpec", |
| 940 | "keyLength": 42, # Length of the keys in bits. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 941 | }, |
| 942 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 943 | "state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in. |
| 944 | "nonExistence": "A String", # Specifies the mechanism for authenticated denial-of-existence responses. |
| 945 | # Can only be changed while the state is OFF. |
| 946 | "kind": "dns#managedZoneDnsSecConfig", |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 947 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 948 | "forwardingConfig": { # The presence for this field indicates that outbound forwarding is enabled |
| 949 | # for this zone. The value of this field contains the set of destinations |
| 950 | # to forward to. |
| 951 | "targetNameServers": [ # List of target name servers to forward to. |
| 952 | # Cloud DNS will select the best available name server if more than one |
| 953 | # target is given. |
| 954 | { |
| 955 | "ipv4Address": "A String", # IPv4 address of a target name server. |
| 956 | "forwardingPath": "A String", # Forwarding path for this NameServerTarget, if unset or set to DEFAULT, |
| 957 | # Cloud DNS will make forwarding decision based on address ranges, |
| 958 | # i.e. RFC1918 addresses go to the VPC, Non-RFC1918 addresses go to the |
| 959 | # Internet. When set to PRIVATE, Cloud DNS will always send queries |
| 960 | # through VPC for this target |
| 961 | "kind": "dns#managedZoneForwardingConfigNameServerTarget", |
| 962 | }, |
| 963 | ], |
| 964 | "kind": "dns#managedZoneForwardingConfig", |
| 965 | }, |
| 966 | "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.". |
| 967 | "labels": { # User labels. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 968 | "a_key": "A String", |
| 969 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 970 | "id": "A String", # Unique identifier for the resource; defined by the server (output only) |
| 971 | "peeringConfig": { # The presence of this field indicates that DNS Peering is enabled for this |
| 972 | # zone. The value of this field contains the network to peer with. |
| 973 | "kind": "dns#managedZonePeeringConfig", |
| 974 | "targetNetwork": { # The network with which to peer. |
| 975 | "deactivateTime": "A String", # The time at which the zone was deactivated, in RFC 3339 date-time |
| 976 | # format. An empty string indicates that the peering connection is |
| 977 | # active. The producer network can deactivate a zone. The zone is |
| 978 | # automatically deactivated if the producer network that the zone |
| 979 | # targeted is deleted. Output only. |
| 980 | "kind": "dns#managedZonePeeringConfigTargetNetwork", |
| 981 | "networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. |
| 982 | # This should be formatted like |
| 983 | # https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} |
| 984 | }, |
| 985 | }, |
| 986 | "nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A |
| 987 | # NameServerSet is a set of DNS name servers that all host the same |
| 988 | # ManagedZones. Most users will leave this field unset. |
| 989 | "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the |
| 990 | # server (output only) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 991 | "A String", |
| 992 | ], |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 993 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 994 | "oldValue": { # A zone is a subtree of the DNS namespace under one administrative # The pre-operation ManagedZone resource. |
| 995 | # responsibility. A ManagedZone is a resource that represents a DNS zone |
| 996 | # hosted by the Cloud DNS service. |
| 997 | "description": "A String", # A mutable string of at most 1024 characters associated with this resource |
| 998 | # for the user's convenience. Has no effect on the managed zone's function. |
| 999 | "name": "A String", # User assigned name for this resource. Must be unique within the project. |
| 1000 | # The name must be 1-63 characters long, must begin with a letter, end with |
| 1001 | # a letter or digit, and only contain lowercase letters, digits or dashes. |
| 1002 | "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 |
| 1003 | # text format. Output only. |
| 1004 | "serviceDirectoryConfig": { # Contains information about Service Directory-backed zones. # This field links to the associated service directory namespace. This field |
| 1005 | # should not be set for public zones or forwarding zones. |
| 1006 | "kind": "dns#managedZoneServiceDirectoryConfig", |
| 1007 | "namespace": { # Contains information about the namespace associated with the zone. |
| 1008 | "namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. |
| 1009 | # This should be formatted like |
| 1010 | # https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace} |
| 1011 | "deletionTime": "A String", # The time that the namespace backing this zone was deleted, empty |
| 1012 | # string if it still exists. This is in RFC3339 text format. Output |
| 1013 | # only. |
| 1014 | "kind": "dns#managedZoneServiceDirectoryConfigNamespace", |
| 1015 | }, |
| 1016 | }, |
| 1017 | "visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while |
| 1018 | # private zones are visible only to Virtual Private Cloud resources. |
| 1019 | "kind": "dns#managedZone", |
| 1020 | "reverseLookupConfig": { # The presence of this field indicates that this is a managed reverse |
| 1021 | # lookup zone and Cloud DNS will resolve reverse lookup queries using |
| 1022 | # automatically configured records for VPC resources. This only applies |
| 1023 | # to networks listed under private_visibility_config. |
| 1024 | "kind": "dns#managedZoneReverseLookupConfig", |
| 1025 | }, |
| 1026 | "privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources |
| 1027 | # that the zone is visible from. |
| 1028 | "networks": [ # The list of VPC networks that can see this zone. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1029 | { |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1030 | "kind": "dns#managedZonePrivateVisibilityConfigNetwork", |
| 1031 | "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. |
| 1032 | # This should be formatted like |
| 1033 | # https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1034 | }, |
| 1035 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1036 | "kind": "dns#managedZonePrivateVisibilityConfig", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1037 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1038 | "dnssecConfig": { # DNSSEC configuration. |
| 1039 | "defaultKeySpecs": [ # Specifies parameters for generating initial DnsKeys for this |
| 1040 | # ManagedZone. Can only be changed while the state is OFF. |
| 1041 | { # Parameters for DnsKey key generation. Used for generating initial keys |
| 1042 | # for a new ManagedZone and as default when adding a new DnsKey. |
| 1043 | "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. |
| 1044 | "keyType": "A String", # Specifies whether this is a key signing key (KSK) or a zone signing key |
| 1045 | # (ZSK). Key signing keys have the Secure Entry Point flag set and, when |
| 1046 | # active, will only be used to sign resource record sets of type DNSKEY. |
| 1047 | # Zone signing keys do not have the Secure Entry Point flag set and will be |
| 1048 | # used to sign all other types of resource record sets. |
| 1049 | "kind": "dns#dnsKeySpec", |
| 1050 | "keyLength": 42, # Length of the keys in bits. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1051 | }, |
| 1052 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1053 | "state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in. |
| 1054 | "nonExistence": "A String", # Specifies the mechanism for authenticated denial-of-existence responses. |
| 1055 | # Can only be changed while the state is OFF. |
| 1056 | "kind": "dns#managedZoneDnsSecConfig", |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1057 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1058 | "forwardingConfig": { # The presence for this field indicates that outbound forwarding is enabled |
| 1059 | # for this zone. The value of this field contains the set of destinations |
| 1060 | # to forward to. |
| 1061 | "targetNameServers": [ # List of target name servers to forward to. |
| 1062 | # Cloud DNS will select the best available name server if more than one |
| 1063 | # target is given. |
| 1064 | { |
| 1065 | "ipv4Address": "A String", # IPv4 address of a target name server. |
| 1066 | "forwardingPath": "A String", # Forwarding path for this NameServerTarget, if unset or set to DEFAULT, |
| 1067 | # Cloud DNS will make forwarding decision based on address ranges, |
| 1068 | # i.e. RFC1918 addresses go to the VPC, Non-RFC1918 addresses go to the |
| 1069 | # Internet. When set to PRIVATE, Cloud DNS will always send queries |
| 1070 | # through VPC for this target |
| 1071 | "kind": "dns#managedZoneForwardingConfigNameServerTarget", |
| 1072 | }, |
| 1073 | ], |
| 1074 | "kind": "dns#managedZoneForwardingConfig", |
| 1075 | }, |
| 1076 | "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.". |
| 1077 | "labels": { # User labels. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1078 | "a_key": "A String", |
| 1079 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1080 | "id": "A String", # Unique identifier for the resource; defined by the server (output only) |
| 1081 | "peeringConfig": { # The presence of this field indicates that DNS Peering is enabled for this |
| 1082 | # zone. The value of this field contains the network to peer with. |
| 1083 | "kind": "dns#managedZonePeeringConfig", |
| 1084 | "targetNetwork": { # The network with which to peer. |
| 1085 | "deactivateTime": "A String", # The time at which the zone was deactivated, in RFC 3339 date-time |
| 1086 | # format. An empty string indicates that the peering connection is |
| 1087 | # active. The producer network can deactivate a zone. The zone is |
| 1088 | # automatically deactivated if the producer network that the zone |
| 1089 | # targeted is deleted. Output only. |
| 1090 | "kind": "dns#managedZonePeeringConfigTargetNetwork", |
| 1091 | "networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. |
| 1092 | # This should be formatted like |
| 1093 | # https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} |
| 1094 | }, |
| 1095 | }, |
| 1096 | "nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A |
| 1097 | # NameServerSet is a set of DNS name servers that all host the same |
| 1098 | # ManagedZones. Most users will leave this field unset. |
| 1099 | "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the |
| 1100 | # server (output only) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1101 | "A String", |
| 1102 | ], |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1103 | }, |
| 1104 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1105 | }</pre> |
| 1106 | </div> |
| 1107 | |
| 1108 | <div class="method"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1109 | <code class="details" id="update">update(project, managedZone, body=None, clientOperationId=None, x__xgafv=None)</code> |
| 1110 | <pre>Update an existing ManagedZone. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1111 | |
| 1112 | Args: |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1113 | project: string, Identifies the project addressed by this request. (required) |
| 1114 | managedZone: string, Identifies the managed zone addressed by this request. Can be the managed |
| 1115 | zone name or id. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1116 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1117 | The object takes the form of: |
| 1118 | |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1119 | { # A zone is a subtree of the DNS namespace under one administrative |
| 1120 | # responsibility. A ManagedZone is a resource that represents a DNS zone |
| 1121 | # hosted by the Cloud DNS service. |
| 1122 | "description": "A String", # A mutable string of at most 1024 characters associated with this resource |
| 1123 | # for the user's convenience. Has no effect on the managed zone's function. |
| 1124 | "name": "A String", # User assigned name for this resource. Must be unique within the project. |
| 1125 | # The name must be 1-63 characters long, must begin with a letter, end with |
| 1126 | # a letter or digit, and only contain lowercase letters, digits or dashes. |
| 1127 | "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 |
| 1128 | # text format. Output only. |
| 1129 | "serviceDirectoryConfig": { # Contains information about Service Directory-backed zones. # This field links to the associated service directory namespace. This field |
| 1130 | # should not be set for public zones or forwarding zones. |
| 1131 | "kind": "dns#managedZoneServiceDirectoryConfig", |
| 1132 | "namespace": { # Contains information about the namespace associated with the zone. |
| 1133 | "namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. |
| 1134 | # This should be formatted like |
| 1135 | # https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace} |
| 1136 | "deletionTime": "A String", # The time that the namespace backing this zone was deleted, empty |
| 1137 | # string if it still exists. This is in RFC3339 text format. Output |
| 1138 | # only. |
| 1139 | "kind": "dns#managedZoneServiceDirectoryConfigNamespace", |
| 1140 | }, |
| 1141 | }, |
| 1142 | "visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while |
| 1143 | # private zones are visible only to Virtual Private Cloud resources. |
| 1144 | "kind": "dns#managedZone", |
| 1145 | "reverseLookupConfig": { # The presence of this field indicates that this is a managed reverse |
| 1146 | # lookup zone and Cloud DNS will resolve reverse lookup queries using |
| 1147 | # automatically configured records for VPC resources. This only applies |
| 1148 | # to networks listed under private_visibility_config. |
| 1149 | "kind": "dns#managedZoneReverseLookupConfig", |
| 1150 | }, |
| 1151 | "privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources |
| 1152 | # that the zone is visible from. |
| 1153 | "networks": [ # The list of VPC networks that can see this zone. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1154 | { |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1155 | "kind": "dns#managedZonePrivateVisibilityConfigNetwork", |
| 1156 | "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. |
| 1157 | # This should be formatted like |
| 1158 | # https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1159 | }, |
| 1160 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1161 | "kind": "dns#managedZonePrivateVisibilityConfig", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1162 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1163 | "dnssecConfig": { # DNSSEC configuration. |
| 1164 | "defaultKeySpecs": [ # Specifies parameters for generating initial DnsKeys for this |
| 1165 | # ManagedZone. Can only be changed while the state is OFF. |
| 1166 | { # Parameters for DnsKey key generation. Used for generating initial keys |
| 1167 | # for a new ManagedZone and as default when adding a new DnsKey. |
| 1168 | "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. |
| 1169 | "keyType": "A String", # Specifies whether this is a key signing key (KSK) or a zone signing key |
| 1170 | # (ZSK). Key signing keys have the Secure Entry Point flag set and, when |
| 1171 | # active, will only be used to sign resource record sets of type DNSKEY. |
| 1172 | # Zone signing keys do not have the Secure Entry Point flag set and will be |
| 1173 | # used to sign all other types of resource record sets. |
| 1174 | "kind": "dns#dnsKeySpec", |
| 1175 | "keyLength": 42, # Length of the keys in bits. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1176 | }, |
| 1177 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1178 | "state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in. |
| 1179 | "nonExistence": "A String", # Specifies the mechanism for authenticated denial-of-existence responses. |
| 1180 | # Can only be changed while the state is OFF. |
| 1181 | "kind": "dns#managedZoneDnsSecConfig", |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1182 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1183 | "forwardingConfig": { # The presence for this field indicates that outbound forwarding is enabled |
| 1184 | # for this zone. The value of this field contains the set of destinations |
| 1185 | # to forward to. |
| 1186 | "targetNameServers": [ # List of target name servers to forward to. |
| 1187 | # Cloud DNS will select the best available name server if more than one |
| 1188 | # target is given. |
| 1189 | { |
| 1190 | "ipv4Address": "A String", # IPv4 address of a target name server. |
| 1191 | "forwardingPath": "A String", # Forwarding path for this NameServerTarget, if unset or set to DEFAULT, |
| 1192 | # Cloud DNS will make forwarding decision based on address ranges, |
| 1193 | # i.e. RFC1918 addresses go to the VPC, Non-RFC1918 addresses go to the |
| 1194 | # Internet. When set to PRIVATE, Cloud DNS will always send queries |
| 1195 | # through VPC for this target |
| 1196 | "kind": "dns#managedZoneForwardingConfigNameServerTarget", |
| 1197 | }, |
| 1198 | ], |
| 1199 | "kind": "dns#managedZoneForwardingConfig", |
| 1200 | }, |
| 1201 | "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.". |
| 1202 | "labels": { # User labels. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1203 | "a_key": "A String", |
| 1204 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1205 | "id": "A String", # Unique identifier for the resource; defined by the server (output only) |
| 1206 | "peeringConfig": { # The presence of this field indicates that DNS Peering is enabled for this |
| 1207 | # zone. The value of this field contains the network to peer with. |
| 1208 | "kind": "dns#managedZonePeeringConfig", |
| 1209 | "targetNetwork": { # The network with which to peer. |
| 1210 | "deactivateTime": "A String", # The time at which the zone was deactivated, in RFC 3339 date-time |
| 1211 | # format. An empty string indicates that the peering connection is |
| 1212 | # active. The producer network can deactivate a zone. The zone is |
| 1213 | # automatically deactivated if the producer network that the zone |
| 1214 | # targeted is deleted. Output only. |
| 1215 | "kind": "dns#managedZonePeeringConfigTargetNetwork", |
| 1216 | "networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. |
| 1217 | # This should be formatted like |
| 1218 | # https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} |
| 1219 | }, |
| 1220 | }, |
| 1221 | "nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A |
| 1222 | # NameServerSet is a set of DNS name servers that all host the same |
| 1223 | # ManagedZones. Most users will leave this field unset. |
| 1224 | "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the |
| 1225 | # server (output only) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1226 | "A String", |
| 1227 | ], |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1228 | } |
| 1229 | |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1230 | clientOperationId: string, For mutating operation requests only. An optional identifier |
| 1231 | specified by the client. Must be unique for operation resources in the |
| 1232 | Operations collection. |
| 1233 | x__xgafv: string, V1 error format. |
| 1234 | Allowed values |
| 1235 | 1 - v1 error format |
| 1236 | 2 - v2 error format |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1237 | |
| 1238 | Returns: |
| 1239 | An object of the form: |
| 1240 | |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1241 | { # An operation represents a successful mutation performed on a Cloud DNS |
| 1242 | # resource. |
| 1243 | # Operations provide: |
| 1244 | # - An audit log of server resource mutations. |
| 1245 | # - A way to recover/retry API calls in the case where the response is never |
| 1246 | # received by the caller. Use the caller specified client_operation_id. |
| 1247 | "dnsKeyContext": { # Only populated if the operation targeted a DnsKey (output only). |
| 1248 | "newValue": { # A DNSSEC key pair. # The post-operation DnsKey resource. |
| 1249 | "id": "A String", # Unique identifier for the resource; defined by the server (output only). |
| 1250 | "kind": "dns#dnsKey", |
| 1251 | "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. Immutable |
| 1252 | # after creation time. |
| 1253 | "publicKey": "A String", # Base64 encoded public half of this key. Output only. |
| 1254 | "keyLength": 42, # Length of the key in bits. Specified at creation time then immutable. |
| 1255 | "creationTime": "A String", # The time that this resource was created in the control plane. This is in |
| 1256 | # RFC3339 text format. Output only. |
| 1257 | "isActive": True or False, # Active keys will be used to sign subsequent changes to the ManagedZone. |
| 1258 | # Inactive keys will still be present as DNSKEY Resource Records for the use |
| 1259 | # of resolvers validating existing signatures. |
| 1260 | "digests": [ # Cryptographic hashes of the DNSKEY resource record associated with this |
| 1261 | # DnsKey. These digests are needed to construct a DS record that points at |
| 1262 | # this DNS key. Output only. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1263 | { |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1264 | "type": "A String", # Specifies the algorithm used to calculate this digest. |
| 1265 | "digest": "A String", # The base-16 encoded bytes of this digest. Suitable for use in a DS |
| 1266 | # resource record. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1267 | }, |
| 1268 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1269 | "type": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the |
| 1270 | # Secure Entry Point flag set and, when active, will be used to sign only |
| 1271 | # resource record sets of type DNSKEY. Otherwise, the Secure Entry Point |
| 1272 | # flag will be cleared and this key will be used to sign only resource |
| 1273 | # record sets of other types. Immutable after creation time. |
| 1274 | "keyTag": 42, # The key tag is a non-cryptographic hash of the a DNSKEY resource record |
| 1275 | # associated with this DnsKey. The key tag can be used to identify a DNSKEY |
| 1276 | # more quickly (but it is not a unique identifier). In particular, the key |
| 1277 | # tag is used in a parent zone's DS record to point at the DNSKEY in this |
| 1278 | # child ManagedZone. The key tag is a number in the range [0, 65535] and the |
| 1279 | # algorithm to calculate it is specified in RFC4034 Appendix B. Output only. |
| 1280 | "description": "A String", # A mutable string of at most 1024 characters associated with this resource |
| 1281 | # for the user's convenience. Has no effect on the resource's function. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1282 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1283 | "oldValue": { # A DNSSEC key pair. # The pre-operation DnsKey resource. |
| 1284 | "id": "A String", # Unique identifier for the resource; defined by the server (output only). |
| 1285 | "kind": "dns#dnsKey", |
| 1286 | "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. Immutable |
| 1287 | # after creation time. |
| 1288 | "publicKey": "A String", # Base64 encoded public half of this key. Output only. |
| 1289 | "keyLength": 42, # Length of the key in bits. Specified at creation time then immutable. |
| 1290 | "creationTime": "A String", # The time that this resource was created in the control plane. This is in |
| 1291 | # RFC3339 text format. Output only. |
| 1292 | "isActive": True or False, # Active keys will be used to sign subsequent changes to the ManagedZone. |
| 1293 | # Inactive keys will still be present as DNSKEY Resource Records for the use |
| 1294 | # of resolvers validating existing signatures. |
| 1295 | "digests": [ # Cryptographic hashes of the DNSKEY resource record associated with this |
| 1296 | # DnsKey. These digests are needed to construct a DS record that points at |
| 1297 | # this DNS key. Output only. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1298 | { |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1299 | "type": "A String", # Specifies the algorithm used to calculate this digest. |
| 1300 | "digest": "A String", # The base-16 encoded bytes of this digest. Suitable for use in a DS |
| 1301 | # resource record. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1302 | }, |
| 1303 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1304 | "type": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the |
| 1305 | # Secure Entry Point flag set and, when active, will be used to sign only |
| 1306 | # resource record sets of type DNSKEY. Otherwise, the Secure Entry Point |
| 1307 | # flag will be cleared and this key will be used to sign only resource |
| 1308 | # record sets of other types. Immutable after creation time. |
| 1309 | "keyTag": 42, # The key tag is a non-cryptographic hash of the a DNSKEY resource record |
| 1310 | # associated with this DnsKey. The key tag can be used to identify a DNSKEY |
| 1311 | # more quickly (but it is not a unique identifier). In particular, the key |
| 1312 | # tag is used in a parent zone's DS record to point at the DNSKEY in this |
| 1313 | # child ManagedZone. The key tag is a number in the range [0, 65535] and the |
| 1314 | # algorithm to calculate it is specified in RFC4034 Appendix B. Output only. |
| 1315 | "description": "A String", # A mutable string of at most 1024 characters associated with this resource |
| 1316 | # for the user's convenience. Has no effect on the resource's function. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1317 | }, |
| 1318 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1319 | "id": "A String", # Unique identifier for the resource. This is the client_operation_id if |
| 1320 | # the client specified it when the mutation was initiated, otherwise, |
| 1321 | # it is generated by the server. The name must be 1-63 characters long |
| 1322 | # and match the regular expression [-a-z0-9]? (output only) |
| 1323 | "user": "A String", # User who requested the operation, for example: user@example.com. |
| 1324 | # cloud-dns-system for operations automatically done by the system. |
| 1325 | # (output only) |
| 1326 | "kind": "dns#operation", |
| 1327 | "startTime": "A String", # The time that this operation was started by the server. This is in RFC3339 |
| 1328 | # text format (output only). |
| 1329 | "type": "A String", # Type of the operation. Operations include insert, update, and delete |
| 1330 | # (output only). |
| 1331 | "status": "A String", # Status of the operation. Can be one of the following: "PENDING" or "DONE" |
| 1332 | # (output only). A status of "DONE" means that the |
| 1333 | # request to update the authoritative servers has been sent, but the |
| 1334 | # servers might not be updated yet. |
| 1335 | "zoneContext": { # Only populated if the operation targeted a ManagedZone (output only). |
| 1336 | "newValue": { # A zone is a subtree of the DNS namespace under one administrative # The post-operation ManagedZone resource. |
| 1337 | # responsibility. A ManagedZone is a resource that represents a DNS zone |
| 1338 | # hosted by the Cloud DNS service. |
| 1339 | "description": "A String", # A mutable string of at most 1024 characters associated with this resource |
| 1340 | # for the user's convenience. Has no effect on the managed zone's function. |
| 1341 | "name": "A String", # User assigned name for this resource. Must be unique within the project. |
| 1342 | # The name must be 1-63 characters long, must begin with a letter, end with |
| 1343 | # a letter or digit, and only contain lowercase letters, digits or dashes. |
| 1344 | "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 |
| 1345 | # text format. Output only. |
| 1346 | "serviceDirectoryConfig": { # Contains information about Service Directory-backed zones. # This field links to the associated service directory namespace. This field |
| 1347 | # should not be set for public zones or forwarding zones. |
| 1348 | "kind": "dns#managedZoneServiceDirectoryConfig", |
| 1349 | "namespace": { # Contains information about the namespace associated with the zone. |
| 1350 | "namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. |
| 1351 | # This should be formatted like |
| 1352 | # https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace} |
| 1353 | "deletionTime": "A String", # The time that the namespace backing this zone was deleted, empty |
| 1354 | # string if it still exists. This is in RFC3339 text format. Output |
| 1355 | # only. |
| 1356 | "kind": "dns#managedZoneServiceDirectoryConfigNamespace", |
| 1357 | }, |
| 1358 | }, |
| 1359 | "visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while |
| 1360 | # private zones are visible only to Virtual Private Cloud resources. |
| 1361 | "kind": "dns#managedZone", |
| 1362 | "reverseLookupConfig": { # The presence of this field indicates that this is a managed reverse |
| 1363 | # lookup zone and Cloud DNS will resolve reverse lookup queries using |
| 1364 | # automatically configured records for VPC resources. This only applies |
| 1365 | # to networks listed under private_visibility_config. |
| 1366 | "kind": "dns#managedZoneReverseLookupConfig", |
| 1367 | }, |
| 1368 | "privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources |
| 1369 | # that the zone is visible from. |
| 1370 | "networks": [ # The list of VPC networks that can see this zone. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1371 | { |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1372 | "kind": "dns#managedZonePrivateVisibilityConfigNetwork", |
| 1373 | "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. |
| 1374 | # This should be formatted like |
| 1375 | # https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1376 | }, |
| 1377 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1378 | "kind": "dns#managedZonePrivateVisibilityConfig", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1379 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1380 | "dnssecConfig": { # DNSSEC configuration. |
| 1381 | "defaultKeySpecs": [ # Specifies parameters for generating initial DnsKeys for this |
| 1382 | # ManagedZone. Can only be changed while the state is OFF. |
| 1383 | { # Parameters for DnsKey key generation. Used for generating initial keys |
| 1384 | # for a new ManagedZone and as default when adding a new DnsKey. |
| 1385 | "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. |
| 1386 | "keyType": "A String", # Specifies whether this is a key signing key (KSK) or a zone signing key |
| 1387 | # (ZSK). Key signing keys have the Secure Entry Point flag set and, when |
| 1388 | # active, will only be used to sign resource record sets of type DNSKEY. |
| 1389 | # Zone signing keys do not have the Secure Entry Point flag set and will be |
| 1390 | # used to sign all other types of resource record sets. |
| 1391 | "kind": "dns#dnsKeySpec", |
| 1392 | "keyLength": 42, # Length of the keys in bits. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1393 | }, |
| 1394 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1395 | "state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in. |
| 1396 | "nonExistence": "A String", # Specifies the mechanism for authenticated denial-of-existence responses. |
| 1397 | # Can only be changed while the state is OFF. |
| 1398 | "kind": "dns#managedZoneDnsSecConfig", |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1399 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1400 | "forwardingConfig": { # The presence for this field indicates that outbound forwarding is enabled |
| 1401 | # for this zone. The value of this field contains the set of destinations |
| 1402 | # to forward to. |
| 1403 | "targetNameServers": [ # List of target name servers to forward to. |
| 1404 | # Cloud DNS will select the best available name server if more than one |
| 1405 | # target is given. |
| 1406 | { |
| 1407 | "ipv4Address": "A String", # IPv4 address of a target name server. |
| 1408 | "forwardingPath": "A String", # Forwarding path for this NameServerTarget, if unset or set to DEFAULT, |
| 1409 | # Cloud DNS will make forwarding decision based on address ranges, |
| 1410 | # i.e. RFC1918 addresses go to the VPC, Non-RFC1918 addresses go to the |
| 1411 | # Internet. When set to PRIVATE, Cloud DNS will always send queries |
| 1412 | # through VPC for this target |
| 1413 | "kind": "dns#managedZoneForwardingConfigNameServerTarget", |
| 1414 | }, |
| 1415 | ], |
| 1416 | "kind": "dns#managedZoneForwardingConfig", |
| 1417 | }, |
| 1418 | "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.". |
| 1419 | "labels": { # User labels. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1420 | "a_key": "A String", |
| 1421 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1422 | "id": "A String", # Unique identifier for the resource; defined by the server (output only) |
| 1423 | "peeringConfig": { # The presence of this field indicates that DNS Peering is enabled for this |
| 1424 | # zone. The value of this field contains the network to peer with. |
| 1425 | "kind": "dns#managedZonePeeringConfig", |
| 1426 | "targetNetwork": { # The network with which to peer. |
| 1427 | "deactivateTime": "A String", # The time at which the zone was deactivated, in RFC 3339 date-time |
| 1428 | # format. An empty string indicates that the peering connection is |
| 1429 | # active. The producer network can deactivate a zone. The zone is |
| 1430 | # automatically deactivated if the producer network that the zone |
| 1431 | # targeted is deleted. Output only. |
| 1432 | "kind": "dns#managedZonePeeringConfigTargetNetwork", |
| 1433 | "networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. |
| 1434 | # This should be formatted like |
| 1435 | # https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} |
| 1436 | }, |
| 1437 | }, |
| 1438 | "nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A |
| 1439 | # NameServerSet is a set of DNS name servers that all host the same |
| 1440 | # ManagedZones. Most users will leave this field unset. |
| 1441 | "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the |
| 1442 | # server (output only) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1443 | "A String", |
| 1444 | ], |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1445 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1446 | "oldValue": { # A zone is a subtree of the DNS namespace under one administrative # The pre-operation ManagedZone resource. |
| 1447 | # responsibility. A ManagedZone is a resource that represents a DNS zone |
| 1448 | # hosted by the Cloud DNS service. |
| 1449 | "description": "A String", # A mutable string of at most 1024 characters associated with this resource |
| 1450 | # for the user's convenience. Has no effect on the managed zone's function. |
| 1451 | "name": "A String", # User assigned name for this resource. Must be unique within the project. |
| 1452 | # The name must be 1-63 characters long, must begin with a letter, end with |
| 1453 | # a letter or digit, and only contain lowercase letters, digits or dashes. |
| 1454 | "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 |
| 1455 | # text format. Output only. |
| 1456 | "serviceDirectoryConfig": { # Contains information about Service Directory-backed zones. # This field links to the associated service directory namespace. This field |
| 1457 | # should not be set for public zones or forwarding zones. |
| 1458 | "kind": "dns#managedZoneServiceDirectoryConfig", |
| 1459 | "namespace": { # Contains information about the namespace associated with the zone. |
| 1460 | "namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. |
| 1461 | # This should be formatted like |
| 1462 | # https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace} |
| 1463 | "deletionTime": "A String", # The time that the namespace backing this zone was deleted, empty |
| 1464 | # string if it still exists. This is in RFC3339 text format. Output |
| 1465 | # only. |
| 1466 | "kind": "dns#managedZoneServiceDirectoryConfigNamespace", |
| 1467 | }, |
| 1468 | }, |
| 1469 | "visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while |
| 1470 | # private zones are visible only to Virtual Private Cloud resources. |
| 1471 | "kind": "dns#managedZone", |
| 1472 | "reverseLookupConfig": { # The presence of this field indicates that this is a managed reverse |
| 1473 | # lookup zone and Cloud DNS will resolve reverse lookup queries using |
| 1474 | # automatically configured records for VPC resources. This only applies |
| 1475 | # to networks listed under private_visibility_config. |
| 1476 | "kind": "dns#managedZoneReverseLookupConfig", |
| 1477 | }, |
| 1478 | "privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources |
| 1479 | # that the zone is visible from. |
| 1480 | "networks": [ # The list of VPC networks that can see this zone. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1481 | { |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1482 | "kind": "dns#managedZonePrivateVisibilityConfigNetwork", |
| 1483 | "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. |
| 1484 | # This should be formatted like |
| 1485 | # https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1486 | }, |
| 1487 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1488 | "kind": "dns#managedZonePrivateVisibilityConfig", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1489 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1490 | "dnssecConfig": { # DNSSEC configuration. |
| 1491 | "defaultKeySpecs": [ # Specifies parameters for generating initial DnsKeys for this |
| 1492 | # ManagedZone. Can only be changed while the state is OFF. |
| 1493 | { # Parameters for DnsKey key generation. Used for generating initial keys |
| 1494 | # for a new ManagedZone and as default when adding a new DnsKey. |
| 1495 | "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. |
| 1496 | "keyType": "A String", # Specifies whether this is a key signing key (KSK) or a zone signing key |
| 1497 | # (ZSK). Key signing keys have the Secure Entry Point flag set and, when |
| 1498 | # active, will only be used to sign resource record sets of type DNSKEY. |
| 1499 | # Zone signing keys do not have the Secure Entry Point flag set and will be |
| 1500 | # used to sign all other types of resource record sets. |
| 1501 | "kind": "dns#dnsKeySpec", |
| 1502 | "keyLength": 42, # Length of the keys in bits. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1503 | }, |
| 1504 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1505 | "state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in. |
| 1506 | "nonExistence": "A String", # Specifies the mechanism for authenticated denial-of-existence responses. |
| 1507 | # Can only be changed while the state is OFF. |
| 1508 | "kind": "dns#managedZoneDnsSecConfig", |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1509 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1510 | "forwardingConfig": { # The presence for this field indicates that outbound forwarding is enabled |
| 1511 | # for this zone. The value of this field contains the set of destinations |
| 1512 | # to forward to. |
| 1513 | "targetNameServers": [ # List of target name servers to forward to. |
| 1514 | # Cloud DNS will select the best available name server if more than one |
| 1515 | # target is given. |
| 1516 | { |
| 1517 | "ipv4Address": "A String", # IPv4 address of a target name server. |
| 1518 | "forwardingPath": "A String", # Forwarding path for this NameServerTarget, if unset or set to DEFAULT, |
| 1519 | # Cloud DNS will make forwarding decision based on address ranges, |
| 1520 | # i.e. RFC1918 addresses go to the VPC, Non-RFC1918 addresses go to the |
| 1521 | # Internet. When set to PRIVATE, Cloud DNS will always send queries |
| 1522 | # through VPC for this target |
| 1523 | "kind": "dns#managedZoneForwardingConfigNameServerTarget", |
| 1524 | }, |
| 1525 | ], |
| 1526 | "kind": "dns#managedZoneForwardingConfig", |
| 1527 | }, |
| 1528 | "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.". |
| 1529 | "labels": { # User labels. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1530 | "a_key": "A String", |
| 1531 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1532 | "id": "A String", # Unique identifier for the resource; defined by the server (output only) |
| 1533 | "peeringConfig": { # The presence of this field indicates that DNS Peering is enabled for this |
| 1534 | # zone. The value of this field contains the network to peer with. |
| 1535 | "kind": "dns#managedZonePeeringConfig", |
| 1536 | "targetNetwork": { # The network with which to peer. |
| 1537 | "deactivateTime": "A String", # The time at which the zone was deactivated, in RFC 3339 date-time |
| 1538 | # format. An empty string indicates that the peering connection is |
| 1539 | # active. The producer network can deactivate a zone. The zone is |
| 1540 | # automatically deactivated if the producer network that the zone |
| 1541 | # targeted is deleted. Output only. |
| 1542 | "kind": "dns#managedZonePeeringConfigTargetNetwork", |
| 1543 | "networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. |
| 1544 | # This should be formatted like |
| 1545 | # https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} |
| 1546 | }, |
| 1547 | }, |
| 1548 | "nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A |
| 1549 | # NameServerSet is a set of DNS name servers that all host the same |
| 1550 | # ManagedZones. Most users will leave this field unset. |
| 1551 | "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the |
| 1552 | # server (output only) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1553 | "A String", |
| 1554 | ], |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1555 | }, |
| 1556 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1557 | }</pre> |
| 1558 | </div> |
| 1559 | |
| 1560 | </body></html> |