API documentation
Danh sách Tên miền
Lấy danh sách domain của người dùng, hỗ trợ phân 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 ký tăng dần), time_desc (thời gian đăng ký 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, phân 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",
}
