Cloud DNS API, REST: DnsZone methods
A set of methods for managing DNS zones.
JSON Representation
{
"id": "string",
"folderId": "string",
"createdAt": "string",
"name": "string",
"description": "string",
"labels": "object",
"zone": "string",
"privateVisibility": {
"networkIds": [
"string"
]
},
"publicVisibility": {},
"deletionProtection": true
}
| Field | Description |
|---|---|
| id | string ID of the DNS zone. Generated at creation time. |
| folderId | string ID of the folder that the DNS zone belongs to. |
| createdAt | string (date-time) Creation timestamp. String in RFC3339 text format. The range of possible values is from 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). |
| name | string Name of the DNS zone. The name is unique within the folder. |
| description | string Description of the DNS zone. |
| labels | object DNS zone labels as |
| zone | string DNS zone suffix. |
| privateVisibility | object Privately visible zone settings. Specifies whether records within the zone are visible from a VPC networks only. Configuration for privately visible zones. |
| privateVisibility. networkIds[] |
string Network IDs. The number of elements must be in the range 0-100. The string length in characters for each value must be equal to 20. |
| publicVisibility | object Publicly visible zone settings. Indicates whether records within the zone are publicly visible. Configuration for publicly visible zones. |
| deletionProtection | boolean (boolean) Prevents accidental zone removal. |
Methods
| Method | Description |
|---|---|
| create | Creates a DNS zone in the specified folder. |
| delete | Deletes the specified DNS zone. |
| get | Returns the specified DNS zone. |
| getRecordSet | Returns the specified record set. |
| list | Retrieves the list of DNS zones in the specified folder. |
| listAccessBindings | Lists existing access bindings for the specified DNS zone. |
| listOperations | Lists operations for the specified DNS zone. |
| listRecordSets | Retrieves the list of record sets in the specified folder. |
| setAccessBindings | Sets access bindings for the specified DNS zone. |
| update | Updates the specified DNS zone. |
| updateAccessBindings | Updates access bindings for the specified DNS zone. |
| updatePrivateNetworks | Atomically updates zone private networks |
| 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. |
| 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. |