Получить DNS-записи домена

Запрос позволяет получить все DNS-записи, которые были установлены для домена.

Примечание

Требуется разрешение на управление DNS (чтение и запись).

Request

GET

https://api360.yandex.net/directory/v1/org/{orgId}/domains/{domain}/dns

Path parameters

Name

Description

domain

Type: string

Полное доменное имя. Например example.com. Для кириллических доменов (например домен.рф) используйте кодировку Punycode.

Example: ``

orgId

Type: integer

Идентификатор организации.

Query parameters

Name

Description

page

Type: integer

Номер страницы ответа. Значение по умолчанию — 1.

perPage

Type: integer

Количество сотрудников на одной странице ответа. Значение по умолчанию — 50.

Responses

200 OK

Запрос успешно выполнен.

Body

application/json

{
  "records": [
    {
      "recordId": 0,
      "type": "A",
      "name": "example",
      "ttl": 0,
      "address": "example",
      "target": "example",
      "exchange": "example",
      "preference": 0,
      "text": "example",
      "port": 0,
      "priority": 0,
      "weight": 0,
      "flag": 0,
      "tag": "example",
      "value": "example"
    }
  ],
  "page": 0,
  "pages": 0,
  "perPage": 0,
  "total": 0
}

Name	Description
page	Type: integer Номер страницы ответа.
pages	Type: integer Количество страниц ответа.
perPage	Type: integer Количество записей на одной странице ответа.
records	Type: v1Record[] Список DNS-записей. Example `[ { "recordId": 0, "type": "A", "name": "example", "ttl": 0, "address": "example", "target": "example", "exchange": "example", "preference": 0, "text": "example", "port": 0, "priority": 0, "weight": 0, "flag": 0, "tag": "example", "value": "example" } ]`
total	Type: integer Общее количество записей.

v1RecordType

Тип DNS-записи.

Type: string

Default: A

Enum: A, AAAA, CNAME, MX, TXT, SRV, NS, CAA

v1Record

Name	Description
address	Type: string Адрес для записи А или ААА. Example: `example`
exchange	Type: string `EXCHANGE` для MX-записи. Example: `example`
flag	Type: integer Флаг для CAA-записи.
name	Type: string Полное доменное имя. Например `example.com`. Для кириллических доменов (например `домен.рф`) используйте кодировку Punycode. Example: `example`
port	Type: integer Порт для SRV-записи.
preference	Type: integer `PREFERENCE` для MX-записи.
priority	Type: integer Приоритет для SRV-записи.
recordId	Type: integer Идентификатор записи.
tag	Type: string Тег для CAA-записи. Example: `example`
target	Type: string Цель для записи CNAME или SRV. Example: `example`
text	Type: string Содержимое для TXT-записи. Example: `example`
ttl	Type: integer Время жизни записи в секундах (TTL) .
type	Type: v1RecordType Тип DNS-записи. Default: `A` Enum: `A`, `AAAA`, `CNAME`, `MX`, `TXT`, `SRV`, `NS`, `CAA`
value	Type: string CAA-запись, заключенная в двойные кавычки, например `"ca.example.net"`. Example: `example`
weight	Type: integer Вес для SRV-записи.

Example

{
  "recordId": 0,
  "type": "A",
  "name": "example",
  "ttl": 0,
  "address": "example",
  "target": "example",
  "exchange": "example",
  "preference": 0,
  "text": "example",
  "port": 0,
  "priority": 0,
  "weight": 0,
  "flag": 0,
  "tag": "example",
  "value": "example"
}

400 Bad Request

Некорректный запрос.

Body

application/json

{
  "code": 0,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}

Name	Description
code	Type: integer Код ошибки.
details	Type: protobufAny[] Дополнительные сведения об ошибке. Example `[ { "@type": "example" } ]`
message	Type: string Описание ошибки. Example: `example`

protobufAny

Name

Description

@type

Type: string

Example: example

[additional]

Type: unknown

Example: null

Example

{
  "@type": "example"
}

401 Unauthorized

Пользователь не авторизован.

Body

application/json

{
  "code": 0,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}

Name	Description
code	Type: integer Код ошибки.
details	Type: protobufAny[] Дополнительные сведения об ошибке. Example `[ { "@type": "example" } ]`
message	Type: string Описание ошибки. Example: `example`

403 Forbidden

У пользователя или приложения нет прав на доступ к ресурсу, запрос отклонен.

Body

application/json

{
  "code": 0,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}

Name	Description
code	Type: integer Код ошибки.
details	Type: protobufAny[] Дополнительные сведения об ошибке. Example `[ { "@type": "example" } ]`
message	Type: string Описание ошибки. Example: `example`

404 Not Found

Запрашиваемый ресурс не найден.

Body

application/json

{
  "code": 0,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}

Name	Description
code	Type: integer Код ошибки.
details	Type: protobufAny[] Дополнительные сведения об ошибке. Example `[ { "@type": "example" } ]`
message	Type: string Описание ошибки. Example: `example`

500 Internal Server Error

Внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время.

Body

application/json

{
  "code": 0,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}

Name	Description
code	Type: integer Код ошибки.
details	Type: protobufAny[] Дополнительные сведения об ошибке. Example `[ { "@type": "example" } ]`
message	Type: string Описание ошибки. Example: `example`

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

Обзор

Добавить DNS-запись