Contact UsGet started
© 2024 Direct Cursus Technology L.L.C.

Cloud DNS API, gRPC: DnsZoneService.Create

Written by
Updated at December 17, 2024

Creates a DNS zone in the specified folder.

gRPC request

rpc Create (CreateDnsZoneRequest) returns (operation.Operation)

CreateDnsZoneRequest

{
  "folder_id": "string",
  "name": "string",
  "description": "string",
  "labels": "map<string, string>",
  "zone": "string",
  "private_visibility": {
    "network_ids": [
      "string"
    ]
  },
  "public_visibility": "PublicVisibility",
  "deletion_protection": "bool"
}

Field

Description

folder_id

string

Required field. ID of the folder to create DNS zones in.

To get a folder ID, make a yandex.cloud.resourcemanager.v1.FolderService.List request.

name

string

Name of the DNS zone.
The name must be unique within the folder.

description

string

Description of the DNS zone.

labels

object (map<string, string>)

DNS zone labels as key:value pairs.

zone

string

Required field. DNS zone suffix.

private_visibility

PrivateVisibility

Privately visible zone settings.
At least one of two visibility fields must be set.

public_visibility

PublicVisibility

Publicly visible zone settings.
At least one of two visibility fields must be set.

deletion_protection

bool

Prevents accidental zone removal.

PrivateVisibility

Configuration for privately visible zones.

Field

Description

network_ids[]

string

Network IDs.

PublicVisibility

Configuration for publicly visible zones.

Field

Description

Empty

operation.Operation

{
  "id": "string",
  "description": "string",
  "created_at": "google.protobuf.Timestamp",
  "created_by": "string",
  "modified_at": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": {
    "dns_zone_id": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": {
    "id": "string",
    "folder_id": "string",
    "created_at": "google.protobuf.Timestamp",
    "name": "string",
    "description": "string",
    "labels": "map<string, string>",
    "zone": "string",
    "private_visibility": {
      "network_ids": [
        "string"
      ]
    },
    "public_visibility": "PublicVisibility",
    "deletion_protection": "bool"
  }
  // 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.

created_at

google.protobuf.Timestamp

Creation timestamp.

created_by

string

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

modified_at

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

CreateDnsZoneMetadata

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

DnsZone

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.

CreateDnsZoneMetadata

Field

Description

dns_zone_id

string

ID of the DNS zone that is being created.

DnsZone

A DNS zone. For details about the concept, see DNS zones.

Field

Description

id

string

ID of the DNS zone. Generated at creation time.

folder_id

string

ID of the folder that the DNS zone belongs to.

created_at

google.protobuf.Timestamp

Creation timestamp.

name

string

Name of the DNS zone.
The name is unique within the folder.

description

string

Description of the DNS zone.

labels

object (map<string, string>)

DNS zone labels as key:value pairs.

zone

string

DNS zone suffix.

private_visibility

PrivateVisibility

Privately visible zone settings.
Specifies whether records within the zone are visible from a VPC networks only.

public_visibility

PublicVisibility

Publicly visible zone settings.
Indicates whether records within the zone are publicly visible.

deletion_protection

bool

Prevents accidental zone removal.

PrivateVisibility

Configuration for privately visible zones.

Field

Description

network_ids[]

string

Network IDs.

PublicVisibility

Configuration for publicly visible zones.

Field

Description

Empty
Previous
List
Next
Update