UpsertRecordSets

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.

TypeScript

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

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

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

  const operation = await client.upsertRecordSets(
    UpsertRecordSetsRequest.fromPartial({
      // dnsZoneId: "dnsZoneId",
      // deletions: [{
      // name: "name",
      // type: "type",
      // ttl: 0,
      // data: ["data"]
      // }],
      // replacements: [{
      // name: "name",
      // type: "type",
      // ttl: 0,
      // data: ["data"]
      // }],
      // merges: [{
      // 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 UpsertRecordSetsMetadata
from yandex.cloud.dns.v1.dns_zone_service_pb2 import UpsertRecordSetsRequest

token = os.getenv("YC_OAUTH_TOKEN")

sdk = yandexcloud.SDK(token=token)

service = sdk.client(DnsZoneServiceStub)
operation = service.UpsertRecordSets(
    UpsertRecordSetsRequest(
        # dns_zone_id = "dnsZoneId",
        # deletions = [RecordSet(
        # name = "name",
        # type = "type",
        # ttl = 0,
        # data = ["data"]
        # )],
        # replacements = [RecordSet(
        # name = "name",
        # type = "type",
        # ttl = 0,
        # data = ["data"]
        # )],
        # merges = [RecordSet(
        # name = "name",
        # type = "type",
        # ttl = 0,
        # data = ["data"]
        # )]
    )
)
operation_result = sdk.wait_operation_and_get_result(
    operation,
    response_type=RecordSetDiff,
    meta_type=UpsertRecordSetsMetadata,
)
print(operation_result)

UpsertRecordSetsRequest

dnsZoneId : string

ID of the DNS zone to upsert record sets to.

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

deletions : RecordSet

Delete only specified records from corresponding record sets.

replacements : RecordSet

Entirely replace specified record sets.

merges : RecordSet

Replace specified records or add new ones if no such record sets exists.

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.

---