Cloud DNS API, REST: DnsZone.UpsertRecordSets

Статья создана

Обновлена 1 июля 2026 г.

HTTP request
Path parameters
Body parameters
RecordSet
Response
Status

Method without strict control for changing zone state. Nothing happens if deleted record doesn't exist.
Deletes records that match all specified fields which allows to delete only specified records from a record set.

HTTP request

POST https://dns.api.cloud.yandex.net/dns/v1/zones/{dnsZoneId}:upsertRecordSets

Path parameters

Field

Description

dnsZoneId

string

Required field. ID of the DNS zone to upsert record sets to.

To get a DNS zone ID, make a DnsZoneService.List request.

The maximum string length in characters is 255.

Body parameters

{
  "deletions": [
    {
      "name": "string",
      "type": "string",
      "ttl": "string",
      "data": [
        "string"
      ],
      "description": "string"
    }
  ],
  "replacements": [
    {
      "name": "string",
      "type": "string",
      "ttl": "string",
      "data": [
        "string"
      ],
      "description": "string"
    }
  ],
  "merges": [
    {
      "name": "string",
      "type": "string",
      "ttl": "string",
      "data": [
        "string"
      ],
      "description": "string"
    }
  ]
}

Field	Description
deletions[]	RecordSet Delete only specified records from corresponding record sets. The maximum number of elements is 1000.
replacements[]	RecordSet Entirely replace specified record sets. The maximum number of elements is 1000.
merges[]	RecordSet Replace specified records or add new ones if no such record sets exists. The maximum number of elements is 1000.

RecordSet

A record set. For details about the concept, see Resource record.

Field	Description
name	string Domain name. The string length in characters must be 1-254.
type	string Record type. The string length in characters must be 1-20.
ttl	string (int64) Time to live in seconds. Acceptable values are 0 to 2147483647, inclusive.
data[]	string Data of the record set. The string length in characters for each value must be 1-1024. The number of elements must be in the range 1-100.
description	string Description of the record set.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": "boolean",
  "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 `0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. 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 `0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. 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 If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
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	Status The error result of the operation in case of failure or cancellation. Includes only one of the fields `error`, `response`. The operation result. If `done == false` and there was no failure detected, neither `error` nor `response` is set. If `done == false` and there was a failure detected, `error` is set. If `done == true`, exactly one of `error` or `response` is set.
response	object 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. Includes only one of the fields `error`, `response`. The operation result. If `done == false` and there was no failure detected, neither `error` nor `response` is set. If `done == false` and there was a failure detected, `error` is set. If `done == true`, exactly one of `error` or `response` is set.

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.

Cloud DNS API, REST: DnsZone.UpsertRecordSets

HTTP requestHTTP request

Path parametersPath parameters

Body parametersBody parameters

RecordSetRecordSet

ResponseResponse

StatusStatus