1 <html><body> 2 <style> 3 4 body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13 } 14 15 body { 16 font-size: 13px; 17 padding: 1em; 18 } 19 20 h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23 } 24 25 h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28 } 29 30 h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34 } 35 36 pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39 } 40 41 pre { 42 margin-top: 0.5em; 43 } 44 45 h1, h2, h3, p { 46 font-family: Arial, sans serif; 47 } 48 49 h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51 } 52 53 .toc_element { 54 margin-top: 0.5em; 55 } 56 57 .firstline { 58 margin-left: 2 em; 59 } 60 61 .method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66 } 67 68 .details { 69 font-weight: bold; 70 font-size: 14px; 71 } 72 73 </style> 74 75 <h1><a href="dns_v2beta1.html">Google Cloud DNS API</a> . <a href="dns_v2beta1.managedZones.html">managedZones</a></h1> 76 <h2>Instance Methods</h2> 77 <p class="toc_element"> 78 <code><a href="#create">create(project, body, clientOperationId=None)</a></code></p> 79 <p class="firstline">Create a new ManagedZone.</p> 80 <p class="toc_element"> 81 <code><a href="#delete">delete(project, managedZone, clientOperationId=None)</a></code></p> 82 <p class="firstline">Delete a previously created ManagedZone.</p> 83 <p class="toc_element"> 84 <code><a href="#get">get(project, managedZone, clientOperationId=None)</a></code></p> 85 <p class="firstline">Fetch the representation of an existing ManagedZone.</p> 86 <p class="toc_element"> 87 <code><a href="#list">list(project, pageToken=None, maxResults=None, dnsName=None)</a></code></p> 88 <p class="firstline">Enumerate ManagedZones that have been created but not yet deleted.</p> 89 <p class="toc_element"> 90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 91 <p class="firstline">Retrieves the next page of results.</p> 92 <p class="toc_element"> 93 <code><a href="#patch">patch(project, managedZone, body, clientOperationId=None)</a></code></p> 94 <p class="firstline">Update an existing ManagedZone. This method supports patch semantics.</p> 95 <p class="toc_element"> 96 <code><a href="#update">update(project, managedZone, body, clientOperationId=None)</a></code></p> 97 <p class="firstline">Update an existing ManagedZone.</p> 98 <h3>Method Details</h3> 99 <div class="method"> 100 <code class="details" id="create">create(project, body, clientOperationId=None)</code> 101 <pre>Create a new ManagedZone. 102 103 Args: 104 project: string, Identifies the project addressed by this request. (required) 105 body: object, The request body. (required) 106 The object takes the form of: 107 108 { # A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service. 109 "kind": "dns#managedZone", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZone". 110 "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function. 111 "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only) 112 "A String", 113 ], 114 "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only. 115 "nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users will leave this field unset. 116 "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.". 117 "dnssecConfig": { # DNSSEC configuration. 118 "kind": "dns#managedZoneDnsSecConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneDnsSecConfig". 119 "defaultKeySpecs": [ # Specifies parameters that will be used for generating initial DnsKeys for this ManagedZone. Output only while state is not OFF. 120 { # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey. 121 "keyType": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types. 122 "keyLength": 42, # Length of the keys in bits. 123 "kind": "dns#dnsKeySpec", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKeySpec". 124 "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. 125 }, 126 ], 127 "state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in. 128 "nonExistence": "A String", # Specifies the mechanism used to provide authenticated denial-of-existence responses. Output only while state is not OFF. 129 }, 130 "id": "A String", # Unique identifier for the resource; defined by the server (output only) 131 "name": "A String", # User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes. 132 } 133 134 clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. 135 136 Returns: 137 An object of the form: 138 139 { # A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service. 140 "kind": "dns#managedZone", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZone". 141 "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function. 142 "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only) 143 "A String", 144 ], 145 "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only. 146 "nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users will leave this field unset. 147 "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.". 148 "dnssecConfig": { # DNSSEC configuration. 149 "kind": "dns#managedZoneDnsSecConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneDnsSecConfig". 150 "defaultKeySpecs": [ # Specifies parameters that will be used for generating initial DnsKeys for this ManagedZone. Output only while state is not OFF. 151 { # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey. 152 "keyType": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types. 153 "keyLength": 42, # Length of the keys in bits. 154 "kind": "dns#dnsKeySpec", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKeySpec". 155 "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. 156 }, 157 ], 158 "state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in. 159 "nonExistence": "A String", # Specifies the mechanism used to provide authenticated denial-of-existence responses. Output only while state is not OFF. 160 }, 161 "id": "A String", # Unique identifier for the resource; defined by the server (output only) 162 "name": "A String", # User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes. 163 }</pre> 164 </div> 165 166 <div class="method"> 167 <code class="details" id="delete">delete(project, managedZone, clientOperationId=None)</code> 168 <pre>Delete a previously created ManagedZone. 169 170 Args: 171 project: string, Identifies the project addressed by this request. (required) 172 managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or id. (required) 173 clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. 174 175 Returns: 176 An object of the form: 177 178 { 179 "header": { # Elements common to every response. 180 "operationId": "A String", # For mutating operation requests that completed successfully. This is the client_operation_id if the client specified it, otherwise it is generated by the server (output only). 181 }, 182 }</pre> 183 </div> 184 185 <div class="method"> 186 <code class="details" id="get">get(project, managedZone, clientOperationId=None)</code> 187 <pre>Fetch the representation of an existing ManagedZone. 188 189 Args: 190 project: string, Identifies the project addressed by this request. (required) 191 managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or id. (required) 192 clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. 193 194 Returns: 195 An object of the form: 196 197 { # A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service. 198 "kind": "dns#managedZone", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZone". 199 "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function. 200 "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only) 201 "A String", 202 ], 203 "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only. 204 "nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users will leave this field unset. 205 "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.". 206 "dnssecConfig": { # DNSSEC configuration. 207 "kind": "dns#managedZoneDnsSecConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneDnsSecConfig". 208 "defaultKeySpecs": [ # Specifies parameters that will be used for generating initial DnsKeys for this ManagedZone. Output only while state is not OFF. 209 { # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey. 210 "keyType": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types. 211 "keyLength": 42, # Length of the keys in bits. 212 "kind": "dns#dnsKeySpec", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKeySpec". 213 "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. 214 }, 215 ], 216 "state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in. 217 "nonExistence": "A String", # Specifies the mechanism used to provide authenticated denial-of-existence responses. Output only while state is not OFF. 218 }, 219 "id": "A String", # Unique identifier for the resource; defined by the server (output only) 220 "name": "A String", # User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes. 221 }</pre> 222 </div> 223 224 <div class="method"> 225 <code class="details" id="list">list(project, pageToken=None, maxResults=None, dnsName=None)</code> 226 <pre>Enumerate ManagedZones that have been created but not yet deleted. 227 228 Args: 229 project: string, Identifies the project addressed by this request. (required) 230 pageToken: string, Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request. 231 maxResults: integer, Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return. 232 dnsName: string, Restricts the list to return only zones with this domain name. 233 234 Returns: 235 An object of the form: 236 237 { 238 "nextPageToken": "A String", # The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your page token. 239 # 240 # In this way you can retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned will be an inconsistent view of the collection. There is no way to retrieve a consistent snapshot of a collection larger than the maximum page size. 241 "header": { # Elements common to every response. 242 "operationId": "A String", # For mutating operation requests that completed successfully. This is the client_operation_id if the client specified it, otherwise it is generated by the server (output only). 243 }, 244 "kind": "dns#managedZonesListResponse", # Type of resource. 245 "managedZones": [ # The managed zone resources. 246 { # A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service. 247 "kind": "dns#managedZone", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZone". 248 "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function. 249 "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only) 250 "A String", 251 ], 252 "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only. 253 "nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users will leave this field unset. 254 "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.". 255 "dnssecConfig": { # DNSSEC configuration. 256 "kind": "dns#managedZoneDnsSecConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneDnsSecConfig". 257 "defaultKeySpecs": [ # Specifies parameters that will be used for generating initial DnsKeys for this ManagedZone. Output only while state is not OFF. 258 { # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey. 259 "keyType": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types. 260 "keyLength": 42, # Length of the keys in bits. 261 "kind": "dns#dnsKeySpec", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKeySpec". 262 "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. 263 }, 264 ], 265 "state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in. 266 "nonExistence": "A String", # Specifies the mechanism used to provide authenticated denial-of-existence responses. Output only while state is not OFF. 267 }, 268 "id": "A String", # Unique identifier for the resource; defined by the server (output only) 269 "name": "A String", # User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes. 270 }, 271 ], 272 }</pre> 273 </div> 274 275 <div class="method"> 276 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 277 <pre>Retrieves the next page of results. 278 279 Args: 280 previous_request: The request for the previous page. (required) 281 previous_response: The response from the request for the previous page. (required) 282 283 Returns: 284 A request object that you can call 'execute()' on to request the next 285 page. Returns None if there are no more items in the collection. 286 </pre> 287 </div> 288 289 <div class="method"> 290 <code class="details" id="patch">patch(project, managedZone, body, clientOperationId=None)</code> 291 <pre>Update an existing ManagedZone. This method supports patch semantics. 292 293 Args: 294 project: string, Identifies the project addressed by this request. (required) 295 managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or id. (required) 296 body: object, The request body. (required) 297 The object takes the form of: 298 299 { # A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service. 300 "kind": "dns#managedZone", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZone". 301 "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function. 302 "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only) 303 "A String", 304 ], 305 "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only. 306 "nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users will leave this field unset. 307 "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.". 308 "dnssecConfig": { # DNSSEC configuration. 309 "kind": "dns#managedZoneDnsSecConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneDnsSecConfig". 310 "defaultKeySpecs": [ # Specifies parameters that will be used for generating initial DnsKeys for this ManagedZone. Output only while state is not OFF. 311 { # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey. 312 "keyType": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types. 313 "keyLength": 42, # Length of the keys in bits. 314 "kind": "dns#dnsKeySpec", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKeySpec". 315 "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. 316 }, 317 ], 318 "state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in. 319 "nonExistence": "A String", # Specifies the mechanism used to provide authenticated denial-of-existence responses. Output only while state is not OFF. 320 }, 321 "id": "A String", # Unique identifier for the resource; defined by the server (output only) 322 "name": "A String", # User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes. 323 } 324 325 clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. 326 327 Returns: 328 An object of the form: 329 330 { # An operation represents a successful mutation performed on a Cloud DNS resource. Operations provide: - An audit log of server resource mutations. - A way to recover/retry API calls in the case where the response is never received by the caller. Use the caller specified client_operation_id. 331 "status": "A String", # Status of the operation. Can be one of the following: "PENDING" or "DONE" (output only). 332 "kind": "dns#operation", # Identifies what kind of resource this is. Value: the fixed string "dns#operation". 333 "dnsKeyContext": { # Only populated if the operation targeted a DnsKey (output only). 334 "newValue": { # A DNSSEC key pair. # The post-operation DnsKey resource. 335 "keyTag": 42, # The key tag is a non-cryptographic hash of the a DNSKEY resource record associated with this DnsKey. The key tag can be used to identify a DNSKEY more quickly (but it is not a unique identifier). In particular, the key tag is used in a parent zone's DS record to point at the DNSKEY in this child ManagedZone. The key tag is a number in the range [0, 65535] and the algorithm to calculate it is specified in RFC4034 Appendix B. Output only. 336 "kind": "dns#dnsKey", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKey". 337 "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the resource's function. 338 "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time. 339 "keyLength": 42, # Length of the key in bits. Specified at creation time then immutable. 340 "creationTime": "A String", # The time that this resource was created in the control plane. This is in RFC3339 text format. Output only. 341 "publicKey": "A String", # Base64 encoded public half of this key. Output only. 342 "type": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types. Immutable after creation time. 343 "digests": [ # Cryptographic hashes of the DNSKEY resource record associated with this DnsKey. These digests are needed to construct a DS record that points at this DNS key. Output only. 344 { 345 "type": "A String", # Specifies the algorithm used to calculate this digest. 346 "digest": "A String", # The base-16 encoded bytes of this digest. Suitable for use in a DS resource record. 347 }, 348 ], 349 "id": "A String", # Unique identifier for the resource; defined by the server (output only). 350 "isActive": True or False, # Active keys will be used to sign subsequent changes to the ManagedZone. Inactive keys will still be present as DNSKEY Resource Records for the use of resolvers validating existing signatures. 351 }, 352 "oldValue": { # A DNSSEC key pair. # The pre-operation DnsKey resource. 353 "keyTag": 42, # The key tag is a non-cryptographic hash of the a DNSKEY resource record associated with this DnsKey. The key tag can be used to identify a DNSKEY more quickly (but it is not a unique identifier). In particular, the key tag is used in a parent zone's DS record to point at the DNSKEY in this child ManagedZone. The key tag is a number in the range [0, 65535] and the algorithm to calculate it is specified in RFC4034 Appendix B. Output only. 354 "kind": "dns#dnsKey", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKey". 355 "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the resource's function. 356 "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time. 357 "keyLength": 42, # Length of the key in bits. Specified at creation time then immutable. 358 "creationTime": "A String", # The time that this resource was created in the control plane. This is in RFC3339 text format. Output only. 359 "publicKey": "A String", # Base64 encoded public half of this key. Output only. 360 "type": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types. Immutable after creation time. 361 "digests": [ # Cryptographic hashes of the DNSKEY resource record associated with this DnsKey. These digests are needed to construct a DS record that points at this DNS key. Output only. 362 { 363 "type": "A String", # Specifies the algorithm used to calculate this digest. 364 "digest": "A String", # The base-16 encoded bytes of this digest. Suitable for use in a DS resource record. 365 }, 366 ], 367 "id": "A String", # Unique identifier for the resource; defined by the server (output only). 368 "isActive": True or False, # Active keys will be used to sign subsequent changes to the ManagedZone. Inactive keys will still be present as DNSKEY Resource Records for the use of resolvers validating existing signatures. 369 }, 370 }, 371 "zoneContext": { # Only populated if the operation targeted a ManagedZone (output only). 372 "newValue": { # A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service. # The post-operation ManagedZone resource. 373 "kind": "dns#managedZone", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZone". 374 "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function. 375 "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only) 376 "A String", 377 ], 378 "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only. 379 "nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users will leave this field unset. 380 "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.". 381 "dnssecConfig": { # DNSSEC configuration. 382 "kind": "dns#managedZoneDnsSecConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneDnsSecConfig". 383 "defaultKeySpecs": [ # Specifies parameters that will be used for generating initial DnsKeys for this ManagedZone. Output only while state is not OFF. 384 { # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey. 385 "keyType": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types. 386 "keyLength": 42, # Length of the keys in bits. 387 "kind": "dns#dnsKeySpec", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKeySpec". 388 "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. 389 }, 390 ], 391 "state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in. 392 "nonExistence": "A String", # Specifies the mechanism used to provide authenticated denial-of-existence responses. Output only while state is not OFF. 393 }, 394 "id": "A String", # Unique identifier for the resource; defined by the server (output only) 395 "name": "A String", # User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes. 396 }, 397 "oldValue": { # A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service. # The pre-operation ManagedZone resource. 398 "kind": "dns#managedZone", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZone". 399 "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function. 400 "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only) 401 "A String", 402 ], 403 "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only. 404 "nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users will leave this field unset. 405 "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.". 406 "dnssecConfig": { # DNSSEC configuration. 407 "kind": "dns#managedZoneDnsSecConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneDnsSecConfig". 408 "defaultKeySpecs": [ # Specifies parameters that will be used for generating initial DnsKeys for this ManagedZone. Output only while state is not OFF. 409 { # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey. 410 "keyType": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types. 411 "keyLength": 42, # Length of the keys in bits. 412 "kind": "dns#dnsKeySpec", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKeySpec". 413 "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. 414 }, 415 ], 416 "state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in. 417 "nonExistence": "A String", # Specifies the mechanism used to provide authenticated denial-of-existence responses. Output only while state is not OFF. 418 }, 419 "id": "A String", # Unique identifier for the resource; defined by the server (output only) 420 "name": "A String", # User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes. 421 }, 422 }, 423 "user": "A String", # User who requested the operation, for example: user (a] example.com. cloud-dns-system for operations automatically done by the system. (output only) 424 "startTime": "A String", # The time that this operation was started by the server. This is in RFC3339 text format (output only). 425 "type": "A String", # Type of the operation. Operations include insert, update, and delete (output only). 426 "id": "A String", # Unique identifier for the resource. This is the client_operation_id if the client specified it when the mutation was initiated, otherwise, it is generated by the server. The name must be 1-63 characters long and match the regular expression [-a-z0-9]? (output only) 427 }</pre> 428 </div> 429 430 <div class="method"> 431 <code class="details" id="update">update(project, managedZone, body, clientOperationId=None)</code> 432 <pre>Update an existing ManagedZone. 433 434 Args: 435 project: string, Identifies the project addressed by this request. (required) 436 managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or id. (required) 437 body: object, The request body. (required) 438 The object takes the form of: 439 440 { # A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service. 441 "kind": "dns#managedZone", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZone". 442 "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function. 443 "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only) 444 "A String", 445 ], 446 "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only. 447 "nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users will leave this field unset. 448 "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.". 449 "dnssecConfig": { # DNSSEC configuration. 450 "kind": "dns#managedZoneDnsSecConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneDnsSecConfig". 451 "defaultKeySpecs": [ # Specifies parameters that will be used for generating initial DnsKeys for this ManagedZone. Output only while state is not OFF. 452 { # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey. 453 "keyType": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types. 454 "keyLength": 42, # Length of the keys in bits. 455 "kind": "dns#dnsKeySpec", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKeySpec". 456 "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. 457 }, 458 ], 459 "state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in. 460 "nonExistence": "A String", # Specifies the mechanism used to provide authenticated denial-of-existence responses. Output only while state is not OFF. 461 }, 462 "id": "A String", # Unique identifier for the resource; defined by the server (output only) 463 "name": "A String", # User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes. 464 } 465 466 clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. 467 468 Returns: 469 An object of the form: 470 471 { # An operation represents a successful mutation performed on a Cloud DNS resource. Operations provide: - An audit log of server resource mutations. - A way to recover/retry API calls in the case where the response is never received by the caller. Use the caller specified client_operation_id. 472 "status": "A String", # Status of the operation. Can be one of the following: "PENDING" or "DONE" (output only). 473 "kind": "dns#operation", # Identifies what kind of resource this is. Value: the fixed string "dns#operation". 474 "dnsKeyContext": { # Only populated if the operation targeted a DnsKey (output only). 475 "newValue": { # A DNSSEC key pair. # The post-operation DnsKey resource. 476 "keyTag": 42, # The key tag is a non-cryptographic hash of the a DNSKEY resource record associated with this DnsKey. The key tag can be used to identify a DNSKEY more quickly (but it is not a unique identifier). In particular, the key tag is used in a parent zone's DS record to point at the DNSKEY in this child ManagedZone. The key tag is a number in the range [0, 65535] and the algorithm to calculate it is specified in RFC4034 Appendix B. Output only. 477 "kind": "dns#dnsKey", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKey". 478 "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the resource's function. 479 "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time. 480 "keyLength": 42, # Length of the key in bits. Specified at creation time then immutable. 481 "creationTime": "A String", # The time that this resource was created in the control plane. This is in RFC3339 text format. Output only. 482 "publicKey": "A String", # Base64 encoded public half of this key. Output only. 483 "type": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types. Immutable after creation time. 484 "digests": [ # Cryptographic hashes of the DNSKEY resource record associated with this DnsKey. These digests are needed to construct a DS record that points at this DNS key. Output only. 485 { 486 "type": "A String", # Specifies the algorithm used to calculate this digest. 487 "digest": "A String", # The base-16 encoded bytes of this digest. Suitable for use in a DS resource record. 488 }, 489 ], 490 "id": "A String", # Unique identifier for the resource; defined by the server (output only). 491 "isActive": True or False, # Active keys will be used to sign subsequent changes to the ManagedZone. Inactive keys will still be present as DNSKEY Resource Records for the use of resolvers validating existing signatures. 492 }, 493 "oldValue": { # A DNSSEC key pair. # The pre-operation DnsKey resource. 494 "keyTag": 42, # The key tag is a non-cryptographic hash of the a DNSKEY resource record associated with this DnsKey. The key tag can be used to identify a DNSKEY more quickly (but it is not a unique identifier). In particular, the key tag is used in a parent zone's DS record to point at the DNSKEY in this child ManagedZone. The key tag is a number in the range [0, 65535] and the algorithm to calculate it is specified in RFC4034 Appendix B. Output only. 495 "kind": "dns#dnsKey", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKey". 496 "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the resource's function. 497 "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time. 498 "keyLength": 42, # Length of the key in bits. Specified at creation time then immutable. 499 "creationTime": "A String", # The time that this resource was created in the control plane. This is in RFC3339 text format. Output only. 500 "publicKey": "A String", # Base64 encoded public half of this key. Output only. 501 "type": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types. Immutable after creation time. 502 "digests": [ # Cryptographic hashes of the DNSKEY resource record associated with this DnsKey. These digests are needed to construct a DS record that points at this DNS key. Output only. 503 { 504 "type": "A String", # Specifies the algorithm used to calculate this digest. 505 "digest": "A String", # The base-16 encoded bytes of this digest. Suitable for use in a DS resource record. 506 }, 507 ], 508 "id": "A String", # Unique identifier for the resource; defined by the server (output only). 509 "isActive": True or False, # Active keys will be used to sign subsequent changes to the ManagedZone. Inactive keys will still be present as DNSKEY Resource Records for the use of resolvers validating existing signatures. 510 }, 511 }, 512 "zoneContext": { # Only populated if the operation targeted a ManagedZone (output only). 513 "newValue": { # A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service. # The post-operation ManagedZone resource. 514 "kind": "dns#managedZone", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZone". 515 "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function. 516 "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only) 517 "A String", 518 ], 519 "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only. 520 "nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users will leave this field unset. 521 "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.". 522 "dnssecConfig": { # DNSSEC configuration. 523 "kind": "dns#managedZoneDnsSecConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneDnsSecConfig". 524 "defaultKeySpecs": [ # Specifies parameters that will be used for generating initial DnsKeys for this ManagedZone. Output only while state is not OFF. 525 { # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey. 526 "keyType": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types. 527 "keyLength": 42, # Length of the keys in bits. 528 "kind": "dns#dnsKeySpec", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKeySpec". 529 "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. 530 }, 531 ], 532 "state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in. 533 "nonExistence": "A String", # Specifies the mechanism used to provide authenticated denial-of-existence responses. Output only while state is not OFF. 534 }, 535 "id": "A String", # Unique identifier for the resource; defined by the server (output only) 536 "name": "A String", # User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes. 537 }, 538 "oldValue": { # A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service. # The pre-operation ManagedZone resource. 539 "kind": "dns#managedZone", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZone". 540 "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function. 541 "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only) 542 "A String", 543 ], 544 "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only. 545 "nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users will leave this field unset. 546 "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.". 547 "dnssecConfig": { # DNSSEC configuration. 548 "kind": "dns#managedZoneDnsSecConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneDnsSecConfig". 549 "defaultKeySpecs": [ # Specifies parameters that will be used for generating initial DnsKeys for this ManagedZone. Output only while state is not OFF. 550 { # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey. 551 "keyType": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types. 552 "keyLength": 42, # Length of the keys in bits. 553 "kind": "dns#dnsKeySpec", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKeySpec". 554 "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. 555 }, 556 ], 557 "state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in. 558 "nonExistence": "A String", # Specifies the mechanism used to provide authenticated denial-of-existence responses. Output only while state is not OFF. 559 }, 560 "id": "A String", # Unique identifier for the resource; defined by the server (output only) 561 "name": "A String", # User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes. 562 }, 563 }, 564 "user": "A String", # User who requested the operation, for example: user (a] example.com. cloud-dns-system for operations automatically done by the system. (output only) 565 "startTime": "A String", # The time that this operation was started by the server. This is in RFC3339 text format (output only). 566 "type": "A String", # Type of the operation. Operations include insert, update, and delete (output only). 567 "id": "A String", # Unique identifier for the resource. This is the client_operation_id if the client specified it when the mutation was initiated, otherwise, it is generated by the server. The name must be 1-63 characters long and match the regular expression [-a-z0-9]? (output only) 568 }</pre> 569 </div> 570 571 </body></html>
