Contact UsGet started

Cloud DNS API, gRPC: DnsZoneService.UpdateRecordSets

Written by
Updated at October 17, 2024

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.

gRPC request

rpc UpdateRecordSets (UpdateRecordSetsRequest) returns (operation.Operation)

UpdateRecordSetsRequest

{
  "dnsZoneId": "string",
  "deletions": [
    {
      "name": "string",
      "type": "string",
      "ttl": "int64",
      "data": [
        "string"
      ]
    }
  ],
  "additions": [
    {
      "name": "string",
      "type": "string",
      "ttl": "int64",
      "data": [
        "string"
      ]
    }
  ]
}

Field

Description

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.

Field

Description

name

string

Domain name.

type

string

Record type.

ttl

int64

Time to live in seconds.

data[]

string

Data of the record set.

operation.Operation

{
  "id": "string",
  "description": "string",
  "createdAt": "google.protobuf.Timestamp",
  "createdBy": "string",
  "modifiedAt": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": "UpdateRecordSetsMetadata",
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": {
    "additions": [
      {
        "name": "string",
        "type": "string",
        "ttl": "int64",
        "data": [
          "string"
        ]
      }
    ],
    "deletions": [
      {
        "name": "string",
        "type": "string",
        "ttl": "int64",
        "data": [
          "string"
        ]
      }
    ]
  }
  // 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

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

UpdateRecordSetsMetadata

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

google.rpc.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

RecordSetDiff

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.

UpdateRecordSetsMetadata

Field

Description

Empty

RecordSetDiff

Field

Description

additions[]

RecordSet

List of record sets that were added

deletions[]

RecordSet

List of record sets that were deleted

RecordSet

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

Field

Description

name

string

Domain name.

type

string

Record type.

ttl

int64

Time to live in seconds.

data[]

string

Data of the record set.
Previous
ListRecordSets
Next
UpsertRecordSets