АПИ documentation
List Доменами
Получить список доменов пользователя, поддержка постраничного отображения, сортировки и фильтрации по статусу
Content-Type
application-json
категория
domain
действие
domain_list
Параметры запроса
| Имя параметра | Тип | Описание | Пример |
|---|---|---|---|
| sort | Строка (необязательно) | Метод сортировки: name_asc (по возрастанию доменного имени), name_desc (по убыванию доменного имени), time_asc (по возрастанию времени регистрации), time_desc (по убыванию времени регистрации, по умолчанию) | time_desc |
| page_size | Целое число (необязательно) | Количество элементов на странице (по умолчанию: 10, поддерживается: 10, 20, 30, 50, 100) | 20 |
| page_index | Целое число (необязательно) | Номер страницы (по умолчанию: 1) | 1 |
| status | Строка (необязательно) | Статус домена: all (все домены, по умолчанию), active (активные домены), expired (истекшие домены), stop (приостановленные домены) | active |
| hold | Строка (необязательно) | Статус удержания домена: пустая строка (без фильтрации, по умолчанию), 0 (не удерживается), 1 (удерживается) | 0 |
Параметры ответа
| Имя параметра | Тип | Описание |
|---|---|---|
| code | Целое число | Код статуса (200 означает успешный результат) |
| msg | Строка | Сообщение |
| data | Объект | Объект данных, содержащий список доменов и параметры |
| data.options | Объект | Параметры запроса, включая сортировку, постраничный вывод и фильтры |
| data.options.sort | Строка | Метод сортировки, используемый в запросе |
| data.options.page_size | Целое число | Количество элементов на странице |
| data.options.page_index | Целое число | Текущий номер страницы |
| data.options.status | Строка | Фильтр по статусу, примененный к запросу |
| data.options.total | Целое число | Общее количество записей |
| data.options.total_pages | Целое число | Общее количество страниц |
| data.domain_list | Массив | Массив объектов доменов |
| data.domain_list.domain | Строка | Имя домена |
| data.domain_list.created_date | Дата | Дата создания (ГГГГ-ММ-ДД) |
| data.domain_list.expired_date | Дата | Дата истечения (ГГГГ-ММ-ДД) |
| data.domain_list.status | Строка | Статус домена (active/expired/stop) |
| data.domain_list.nameservers | Массив | Массив DNS-серверов |
| data.domain_list.hold | Целое число | Статус удержания (0=не удерживается, 1=удерживается) |
Пример запроса
{
curl https://api.nicenic.net/v2/?category=domain&action=domain_list&sort={sort}&page_size={page_size}&page_index={page_index}&status={status}&hold={hold}
-H "Authorization: username:api_secret"
-H "Content-Type: application/json"
}
Результат ответа
0 OK
Успешный ответ
{
"code": 0,
"msg" : "success",
"data" : {
"options": {
"sort": "time_desc",
"page_size": 20,
"page_index": 1,
"status": "active",
"total": 50,
"total_pages": 3
},
"domain_list": [
{
"domain": "example.com",
"created_date": "2023-01-15",
"expired_date": "2025-01-15",
"status": "active",
"nameservers": ["ns1.example.com", "ns2.example.com"],
"hold": 0
}
]
}
}
400 Некорректный запрос
{
"code": 400,
"msg" : "Request parameter error",
}
