Cloud DNS API, REST: DnsZone.updateRecordSets
Method with strict control for changing zone state. Returns error when:
- Deleted record is not found.
- Found record with matched type and name but different TTL or value.
- Attempted to add record with existing name and type.
Deletions happen first. If a record with the same name and type exists in both lists,
then the existing record will be deleted, and a new one added.
HTTP request
POST https://dns.api.cloud.yandex.net/dns/v1/zones/{dnsZoneId}:updateRecordSets
Path parameters
| Parameter | Description |
|---|---|
| dnsZoneId | ID of the DNS zone to update record sets in. To get a DNS zone ID, make a list request. The string length in characters must be equal to 20. |
Body parameters
{
"deletions": [
{
"name": "string",
"type": "string",
"ttl": "string",
"data": [
"string"
]
}
],
"additions": [
{
"name": "string",
"type": "string",
"ttl": "string",
"data": [
"string"
]
}
]
}
| Field | Description |
|---|---|
| deletions[] | object List of record sets to delete. The maximum number of elements is 1000. |
| deletions[]. name |
string Domain name. The string length in characters must be 1-254. |
| deletions[]. type |
string Record type. The string length in characters must be 1-20. |
| deletions[]. ttl |
string (int64) Time to live in seconds. Acceptable values are 0 to 2147483647, inclusive. |
| deletions[]. data[] |
string Required. Data of the record set. The number of elements must be in the range 1-100. The string length in characters for each value must be 1-255. |
| additions[] | object List of record sets to add. The maximum number of elements is 1000. |
| additions[]. name |
string Domain name. The string length in characters must be 1-254. |
| additions[]. type |
string Record type. The string length in characters must be 1-20. |
| additions[]. ttl |
string (int64) Time to live in seconds. Acceptable values are 0 to 2147483647, inclusive. |
| additions[]. data[] |
string Required. Data of the record set. The number of elements must be in the range 1-100. The string length in characters for each value must be 1-255. |
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, responseThe 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. |