Методы API для управления зонами DNS
Endpoint для запросов — https://console.cloud.ru/api/clouddns. Примеры запросов смотрите в разделе Инструкции.
Актуальную спецификацию можно скачать и использовать в привычном инструменте.
Перед началом работы
Уточните Service Instance ID (parentId) вида d55b938f-47de-4d2a-b03f-331fdaf947cf. Этот идентификатор можно скопировать в сервисе Cloud DNS в разделе Зоны. Он отображается:
В поле Service Instance ID.
В URL-адресе после наименования сервиса.
https : // console . cloud . ru / spa / cloud - dns / d55b9 ...
В примере выше d55b9... — идентификатор Service Instance ID (parentId).
Набор методов для управления зонами DNS
Метод API |
HTTP-метод |
Описание |
|---|---|---|
Get zones |
GET |
Возвращает список всех созданных зон DNS |
Get zones/{id} |
GET |
Возвращает информацию об указанной зоне DNS |
Create |
POST |
Создает зону |
Update |
PATCH |
Обновляет параметры зоны |
Delete |
DELETE |
Удаляет зону |
name (string) – обязательное поле. Наименование зоны (FQDN).
parentId (string) – обязательное поле. Указывается идентификатор родительского сервисного инстанса.
200 OK – A successful response.
createdAt (string) – время создания зоны.
delegated (boolean) – указывает на то, что зона делегирована.
id (string) – идентификатор зоны.
lastCheck (string) – время последней проверки зоны.
name (string) – наименование зоны.
parentId (string) – идентификатор владельца ключа.
updatedAt (string) – время последнего обновления зоны.
valid (boolean) – указывает на то, что зона проверена и готова к использованию.
validationText (string) – уникальный текст для валидации зоны.
id (string) – обязательное поле. Идентификатор зоны.
200 OK – A successful response.
createdAt (string) – время создания зоны.
delegated (boolean) – указывает на то, что зона делегирована.
id (string) – идентификатор зоны.
lastCheck (string) – время последней проверки зоны.
name (string) – наименование зоны.
parentId (string) – идентификатор владельца ключа.
updatedAt (string) – время последнего обновления зоны.
valid (boolean) – указывает на то, что зона проверена и готова к использованию.
validationText (string) – уникальный текст для валидации зоны.
id (string) – обязательное поле. Идентификатор зоны.
200 OK – A successful response.
zone.id (string) – идентификатор зоны.
zone (object) – обязательное поле. Обновленная зона.
zone.createdAt (string) – время создания зоны.
zone.delegated (boolean) – указывает на то, что зона делегирована.
zone.id (string) – идентификатор зоны.
zone.lastCheck (string) – время последней проверки зоны.
zone.name (string) – наименование зоны.
zone.parentId (string) – идентификатор владельца ключа.
zone.updatedAt (string) – время последнего обновления зоны.
zone.valid (boolean) – указывает на то, что зона проверена и готова к использованию.
zone.validationText (string) – уникальный текст для валидации зоны.
200 OK – A successful response.
createdAt (string) – время создания зоны.
delegated (boolean) – указывает на то, что зона делегирована.
id (string) – идентификатор зоны.
lastCheck (string) – время последней проверки зоны.
name (string) – наименование зоны.
parentId (string) – идентификатор владельца ключа.
updatedAt (string) – время последнего обновления зоны.
valid (boolean) – указывает на то, что зона проверена и готова к использованию.
validationText (string) – уникальный текст для валидации зоны.
- PATCH /v1/zones/{zone.id}
- Parameters
zone.id (string) – идентификатор зоны.
- Request JSON Object
updateMask (string) – обязательное поле. Маска для обновления зоны.
zone (object) – обязательное поле. Обновленная зона.
zone.createdAt (string) – время создания зоны.
zone.delegated (boolean) – указывает на то, что зона делегирована.
zone.id (string) – идентификатор зоны.
zone.lastCheck (string) – время последней проверки зоны.
zone.name (string) – наименование зоны.
zone.parentId (string) – идентификатор владельца ключа.
zone.updatedAt (string) – время последнего обновления зоны.
zone.valid (boolean) – указывает на то, что зона проверена и готова к использованию.
zone.validationText (string) – уникальный текст для валидации зоны.
- Status Codes
200 OK – A successful response.
- Response JSON Object
createdAt (string) – время создания зоны.
delegated (boolean) – указывает на то, что зона делегирована.
id (string) – идентификатор зоны.
lastCheck (string) – время последней проверки зоны.
name (string) – наименование зоны.
parentId (string) – идентификатор владельца ключа.
updatedAt (string) – время последнего обновления зоны.
valid (boolean) – указывает на то, что зона проверена и готова к использованию.
validationText (string) – уникальный текст для валидации зоны.
- Перед началом работы
- Набор методов для управления зонами DNS