Cloud DNS API, REST: DnsZone.Update
Updates the specified DNS zone.
HTTP request
PATCH https://dns.api.cloud.yandex.net/dns/v1/zones/{dnsZoneId}
Path parameters
Field |
Description |
dnsZoneId |
string Required field. ID of the DNS zone to update. To get the DNS zone ID, make a DnsZoneService.List request. |
Body parameters
{
"updateMask": "string",
"name": "string",
"description": "string",
"labels": "string",
"privateVisibility": {
"networkIds": [
"string"
]
},
"publicVisibility": "object",
"deletionProtection": "boolean"
}
Field |
Description |
updateMask |
string (field-mask) A comma-separated names off ALL fields to be updated. If |
name |
string New name for the DNS zone. |
description |
string New description of the DNS zone. |
labels |
string DNS zone labels as Existing set of labels is completely replaced by the provided set, so if you just want
|
privateVisibility |
Change network IDs for private visibility. |
publicVisibility |
object Public visibility configuration. |
deletionProtection |
boolean Prevents accidental zone removal. |
PrivateVisibility
Configuration for privately visible zones.
Field |
Description |
networkIds[] |
string Network IDs. |
Response
HTTP Code: 200 - OK
{
"id": "string",
"description": "string",
"createdAt": "string",
"createdBy": "string",
"modifiedAt": "string",
"done": "boolean",
"metadata": {
"dnsZoneId": "string"
},
// Includes only one of the fields `error`, `response`
"error": {
"code": "integer",
"message": "string",
"details": [
"object"
]
},
"response": {
"id": "string",
"folderId": "string",
"createdAt": "string",
"name": "string",
"description": "string",
"labels": "string",
"zone": "string",
"privateVisibility": {
"networkIds": [
"string"
]
},
"publicVisibility": "object",
"deletionProtection": "boolean"
}
// end of the list of possible fields
}
An Operation resource. For more information, see Operation.
Field |
Description |
id |
string ID of the operation. |
description |
string Description of the operation. 0-256 characters long. |
createdAt |
string (date-time) Creation timestamp. String in RFC3339 To work with values in this field, use the APIs described in the |
createdBy |
string ID of the user or service account who initiated the operation. |
modifiedAt |
string (date-time) The time when the Operation resource was last modified. String in RFC3339 To work with values in this field, use the APIs described in the |
done |
boolean If the value is |
metadata |
Service-specific metadata associated with the operation. |
error |
The error result of the operation in case of failure or cancellation. Includes only one of the fields The operation result. |
response |
The normal response of the operation in case of success. Includes only one of the fields The operation result. |
UpdateDnsZoneMetadata
Field |
Description |
dnsZoneId |
string ID of the DNS zone that is being updated. |
Status
The error result of the operation in case of failure or cancellation.
Field |
Description |
code |
integer (int32) Error code. An enum value of google.rpc.Code |
message |
string An error message. |
details[] |
object A list of messages that carry the error details. |
DnsZone
A DNS zone. For details about the concept, see DNS zones.
Field |
Description |
id |
string ID of the DNS zone. Generated at creation time. |
folderId |
string ID of the folder that the DNS zone belongs to. |
createdAt |
string (date-time) Creation timestamp. String in RFC3339 To work with values in this field, use the APIs described in the |
name |
string Name of the DNS zone. |
description |
string Description of the DNS zone. |
labels |
string DNS zone labels as |
zone |
string DNS zone suffix. |
privateVisibility |
Privately visible zone settings. |
publicVisibility |
object Publicly visible zone settings. |
deletionProtection |
boolean Prevents accidental zone removal. |
PrivateVisibility
Configuration for privately visible zones.
Field |
Description |
networkIds[] |
string Network IDs. |