API documentation
Domain list
Get user domain list, support pagination, sorting and status filtering
Content-Type
application-json
category
domain
action
domain_list
Request parameters
| Parameter Name | Type | Describe | Example |
|---|---|---|---|
| sort | String (Optional) | Sort method: name_asc (domain name ascending), name_desc (domain name descending), time_asc (registration time ascending), time_desc (registration time descending, default) | time_desc |
| page_size | Integer (Optional) | Number of items per page (default: 10, supported: 10, 20, 30, 50, 100) | 20 |
| page_index | Integer (Optional) | Page number (default: 1) | 1 |
| status | String (Optional) | Domain status: all (all domains, default), active (active domains), expired (expired domains), stop (stopped domains) | active |
| hold | String (Optional) | Domain hold status: empty string (no filtering, default), 0 (non-hold status), 1 (hold status) | 0 |
Response parameters
| Parameter Name | Type | Describe |
|---|---|---|
| code | Integer | Status code (200 indicates success) |
| msg | String | Message |
| data | Object | Data object containing domain list and options |
| data.options | Object | Query options including sort, pagination, and filtering settings |
| data.options.sort | String | Sort method used in the query |
| data.options.page_size | Integer | Number of items per page |
| data.options.page_index | Integer | Current page number |
| data.options.status | String | Status filter applied to the query |
| data.options.total | Integer | Total number of records |
| data.options.total_pages | Integer | Total number of pages |
| data.domain_list | Array | Array of domain objects |
| data.domain_list.domain | String | Domain name |
| data.domain_list.created_date | Date | Creation date (YYYY-MM-DD) |
| data.domain_list.expired_date | Date | Expiration date (YYYY-MM-DD) |
| data.domain_list.status | String | Domain status (active/expired/stop) |
| data.domain_list.nameservers | Array | DNS server array |
| data.domain_list.hold | Integer | Hold status (0=non-hold, 1=hold) |
Request Example
{
curl http://api.www.gtlpnf.cn/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"
}
Return result
0 OK
Successful response
{
"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 Bad Request
{
"code": 400,
"msg" : "Request parameter error",
}
