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
Parameter | Description |
---|---|
dnsZoneId | ID of the DNS zone to update. To get the DNS zone ID, make a list request. The string length in characters must be equal to 20. |
Body parameters
{
"updateMask": "string",
"name": "string",
"description": "string",
"labels": "object",
"privateVisibility": {
"networkIds": [
"string"
]
},
"publicVisibility": {},
"deletionProtection": true
}
Field | Description |
---|---|
updateMask | string Field mask specifying which fields of the DNS zone resource are going to be updated. A comma-separated names off ALL fields to be updated. Only the specified fields will be changed. The others will be left untouched. If the field is specified in If |
name | string New name for the DNS zone. The name must be unique within the folder. Value must match the regular expression |
description | string New description of the DNS zone. The maximum string length in characters is 256. |
labels | object DNS zone labels as Existing set of labels is completely replaced by the provided set, so if you just want to add or remove a label:
No more than 64 per resource. The string length in characters for each key must be 1-63. Each key must match the regular expression |
privateVisibility | object Change network IDs for private visibility. Configuration for privately visible zones. |
privateVisibility. networkIds[] |
string Network IDs. The number of elements must be in the range 0-100. The string length in characters for each value must be equal to 20. |
publicVisibility | object Public visibility configuration. Configuration for publicly visible zones. |
deletionProtection | boolean (boolean) Prevents accidental zone removal. |
Response
HTTP Code: 200 - OK
{
"id": "string",
"description": "string",
"createdAt": "string",
"createdBy": "string",
"modifiedAt": "string",
"done": true,
"metadata": "object",
// includes only one of the fields `error`, `response`
"error": {
"code": "integer",
"message": "string",
"details": [
"object"
]
},
"response": "object",
// 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 text format. The range of possible values is from To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
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 text format. The range of possible values is from To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
done | boolean (boolean) If the value is |
metadata | object Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
error | object The error result of the operation in case of failure or cancellation. includes only one of the fields error , response |
error. code |
integer (int32) Error code. An enum value of google.rpc.Code. |
error. message |
string An error message. |
error. details[] |
object A list of messages that carry the error details. |
response | object includes only one of the fields error , response The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any. |