UpdateRecordSets

Method with strict control for changing zone state. Returns error when:

1. Deleted record is not found.
2. Found record with matched type and name but different TTL or value.
3. 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.

TypeScript

import {
  cloudApi,
  decodeMessage,
  serviceClients,
  Session,
  waitForOperation,
} from "@yandex-cloud/nodejs-sdk";

const RecordSetDiff = cloudApi.dns.dns_zone_service.RecordSetDiff;
const UpdateRecordSetsRequest =
  cloudApi.dns.dns_zone_service.UpdateRecordSetsRequest;

(async () => {
  const authToken = process.env["YC_OAUTH_TOKEN"];
  const session = new Session({ oauthToken: authToken });
  const client = session.client(serviceClients.DnsZoneServiceClient);

  const operation = await client.updateRecordSets(
    UpdateRecordSetsRequest.fromPartial({
      // dnsZoneId: "dnsZoneId",
      // deletions: [{
      // name: "name",
      // type: "type",
      // ttl: 0,
      // data: ["data"]
      // }],
      // additions: [{
      // name: "name",
      // type: "type",
      // ttl: 0,
      // data: ["data"]
      // }]
    })
  );
  const finishedOp = await waitForOperation(operation, session);

  if (finishedOp.response) {
    const result = decodeMessage<typeof RecordSetDiff>(finishedOp.response);
    console.log(result);
  }
})();

Python

import os
import grpc
import yandexcloud

from yandex.cloud.dns.v1.dns_zone_service_pb2_grpc import DnsZoneServiceStub
from yandex.cloud.dns.v1.dns_zone_pb2 import RecordSet
from yandex.cloud.dns.v1.dns_zone_service_pb2 import RecordSetDiff
from yandex.cloud.dns.v1.dns_zone_service_pb2 import UpdateRecordSetsMetadata
from yandex.cloud.dns.v1.dns_zone_service_pb2 import UpdateRecordSetsRequest

token = os.getenv("YC_OAUTH_TOKEN")

sdk = yandexcloud.SDK(token=token)

service = sdk.client(DnsZoneServiceStub)
operation = service.UpdateRecordSets(
    UpdateRecordSetsRequest(
        # dns_zone_id = "dnsZoneId",
        # deletions = [RecordSet(
        # name = "name",
        # type = "type",
        # ttl = 0,
        # data = ["data"]
        # )],
        # additions = [RecordSet(
        # name = "name",
        # type = "type",
        # ttl = 0,
        # data = ["data"]
        # )]
    )
)
operation_result = sdk.wait_operation_and_get_result(
    operation,
    response_type=RecordSetDiff,
    meta_type=UpdateRecordSetsMetadata,
)
print(operation_result)

UpdateRecordSetsRequest

dnsZoneId : string

ID of the DNS zone to update record sets in.

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

deletions : RecordSet

List of record sets to delete.

additions : RecordSet

List of record sets to add.

RecordSet

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

name : string

Domain name.

type : string

Record type.

ttl : int64

Time to live in seconds.

data : string

Data of the record set.

Operation

An Operation resource. For more information, see Operation.

id : string

ID of the operation.

description : string

Description of the operation. 0-256 characters long.

createdAt : google.protobuf.Timestamp

Creation timestamp.

createdBy : string

ID of the user or service account who initiated the operation.

modifiedAt : google.protobuf.Timestamp

The time when the Operation resource was last modified.

done : bool

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 : google.protobuf.Any

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.

One of result

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.

• error : google.rpc.Status

  The error result of the operation in case of failure or cancellation.

• response : google.protobuf.Any

  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.

---