tocdepth: 2

Методы API для управления ресурсными записями

Endpoint для запросов — https://console.cloud.ru/api/clouddns. Примеры запросов смотрите в разделе Инструкции.

Подсказка

Актуальную спецификацию можно скачать и использовать в привычном инструменте.

Набор методов для управления ресурсными записями:

Метод API	HTTP-метод	Описание
Get records	GET	Возвращает список всех ресурсных записей для зоны DNS
Get records/{name}/{type}	GET	Возвращает информацию о ресурсной записи
Create record	POST	Создает ресурсную запись
Update	PATCH	Обновляет параметры ресурсной записи
Delete	DELETE	Удаляет запись

PATCH /v1/zones/{record.zoneId}/records/{record.name}/{record.type}

Parameters

record.zoneId (string) – идентификатор зоны.
record.name (string) – наименование записи.
record.type (string) – тип записи.

Request JSON Object

record (object) – обязательное поле. Обновленная запись.
record.enables (boolean) – указывает на то, что запись активна.
record.name (string) – наименование записи.
record.ttl (string) – время жизни записи (default: 3600)
record.type (string) – тип записи.
record.values (array) – обязательное поле. Значения записи.
record.values[] (string) – значение записи.
record.zoneId (string) – идентификатор зоны.
updateMask (string) – обязательное поле. Маска для обновления записи.

Status Codes

200 OK – A successful response.

Response JSON Object

enables (boolean) – указывает на то, что запись активна.
name (string) – наименование записи.
ttl (string) – время жизни записи (default: 3600)
type (string) – тип записи.
values (array) – обязательное поле. Значения записи.
values[] (string) – значение записи.
zoneId (string) – идентификатор зоны.

GET /v1/zones/{zoneId}/records

Parameters

zoneId (string) – обязательное поле. идентификатор зоны.

Status Codes

200 OK – A successful response.

Response JSON Object

items (array) – список записей.
items[].enables (boolean) – указывает на то, что запись активна.
items[].name (string) – наименование записи.
items[].ttl (string) – время жизни записи (default: 3600)
items[].type (string) – тип записи.
items[].values (array) – обязательное поле. Значения записи.
items[].values[] (string) – значение записи.
items[].zoneId (string) – идентификатор зоны.

POST /v1/zones/{zoneId}/records

Parameters

zoneId (string) – обязательное поле. Идентификатор зоны.

Request JSON Object

name (string) – обязательное поле. Наименование записи .
ttl (string) – время жизни записи (default: 3600).
type (string) – обязательное поле. Тип записи.
values (array) – обязательное поле. Значения записи.
values[] (string) – значение записи.

Status Codes

200 OK – A successful response.

Response JSON Object

enables (boolean) – указывает на то, что запись активна.
name (string) – наименование записи.
ttl (string) – время жизни записи (default: 3600)
type (string) – тип записи.
values (array) – обязательное поле. Значения записи.
values[] (string) – значение записи.
zoneId (string) – идентификатор зоны.

GET /v1/zones/{zoneId}/records/{name}/{type}

Parameters

zoneId (string) – обязательное поле. Идентификатор зоны.
name (string) – обязательное поле. Наименование записи.
type (string) – обязательное поле. Тип записи.

Status Codes

200 OK – A successful response.

Response JSON Object

enables (boolean) – указывает на то, что запись активна.
name (string) – наименование записи.
ttl (string) – время жизни записи (default: 3600)
type (string) – тип записи.
values (array) – обязательное поле. Значения записи.
values[] (string) – значение записи.
zoneId (string) – идентификатор зоны.

DELETE /v1/zones/{zoneId}/records/{name}/{type}

Parameters

zoneId (string) – обязательное поле. Идентификатор зоны.
name (string) – обязательное поле. Наименование записи.
type (string) – обязательное поле. Тип записи.

Status Codes

200 OK – A successful response.

Была ли статья полезной?