API documentation
Danh sách Tên mi?n
L?y danh sách domain c?a ng??i dùng, h? tr? phan trang, s?p x?p và l?c theo tr?ng thái
Content-Type
application-json
Danh m?c
domain
Hành ??ng
domain_list
Tham s? yêu c?u
| Tên tham s? | Ki?u | M? t? | Ví d? |
|---|---|---|---|
| sort | Chu?i (Tùy ch?n) | Ph??ng th?c s?p x?p: name_asc (tên domain t?ng d?n), name_desc (tên domain gi?m d?n), time_asc (th?i gian ??ng ky t?ng d?n), time_desc (th?i gian ??ng ky gi?m d?n, m?c ??nh) | time_desc |
| page_size | S? nguyên (Tùy ch?n) | S? l??ng m?c m?i trang (m?c ??nh: 10, h? tr?: 10, 20, 30, 50, 100) | 20 |
| page_index | S? nguyên (Tùy ch?n) | S? trang (m?c ??nh: 1) | 1 |
| status | Chu?i (Tùy ch?n) | Tr?ng thái domain: all (t?t c? domain, m?c ??nh), active (domain ?ang ho?t ??ng), expired (domain ?? h?t h?n), stop (domain ?? d?ng) | active |
| hold | Chu?i (Tùy ch?n) | Tr?ng thái gi? domain: chu?i r?ng (kh?ng l?c, m?c ??nh), 0 (kh?ng gi?), 1 (?ang gi?) | 0 |
Tham s? ph?n h?i
| Tên tham s? | Ki?u | M? t? |
|---|---|---|
| code | S? nguyên | M? tr?ng thái (200 cho bi?t thành c?ng) |
| msg | Chu?i | Th?ng ?i?p |
| data | ??i t??ng | ??i t??ng d? li?u ch?a danh sách domain và các tùy ch?n |
| data.options | ??i t??ng | Tùy ch?n truy v?n bao g?m thi?t l?p s?p x?p, phan trang và l?c |
| data.options.sort | Chu?i | Ph??ng th?c s?p x?p ???c dùng trong truy v?n |
| data.options.page_size | S? nguyên | S? l??ng m?c m?i trang |
| data.options.page_index | S? nguyên | S? trang hi?n t?i |
| data.options.status | Chu?i | B? l?c tr?ng thái áp d?ng cho truy v?n |
| data.options.total | S? nguyên | T?ng s? b?n ghi |
| data.options.total_pages | S? nguyên | T?ng s? trang |
| data.domain_list | M?ng | M?ng ??i t??ng domain |
| data.domain_list.domain | Chu?i | Tên domain |
| data.domain_list.created_date | Ngày | Ngày t?o (YYYY-MM-DD) |
| data.domain_list.expired_date | Ngày | Ngày h?t h?n (YYYY-MM-DD) |
| data.domain_list.status | Chu?i | Tr?ng thái domain (active/expired/stop) |
| data.domain_list.nameservers | M?ng | M?ng máy ch? DNS |
| data.domain_list.hold | S? nguyên | Tr?ng thái hold (0=kh?ng hold, 1=hold) |
Ví d? yêu c?u
{
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"
}
K?t qu? tr? v?
0 OK
Ph?n h?i thành c?ng
{
"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 Yêu c?u kh?ng h?p l?
{
"code": 400,
"msg" : "Request parameter error",
}
