API documentation
Saraksts Domēni
Iegūt lietotāja domēnu sarakstu ar lapošanas, kārtošanas un statusa filtrēšanas atbalstu
Content-Type
application-json
kategorija
domain
darbība
domain_list
Pieprasījuma parametri
| Parametra nosaukums | Tips | Apraksts | Piemērs |
|---|---|---|---|
| sort | Virknē (pēc izvēles) | Kārtošanas metode: name_asc (domeina nosaukums augošā secībā), name_desc (domeina nosaukums dilstošā secībā), time_asc (reģistrācijas laiks augošā secībā), time_desc (reģistrācijas laiks dilstošā secībā, noklusējums) | time_desc |
| page_size | Vesels skaitlis (pēc izvēles) | Vienumu skaits lapā (noklusējums: 10, atbalstīts: 10, 20, 30, 50, 100) | 20 |
| page_index | Vesels skaitlis (pēc izvēles) | Lapas numurs (noklusējums: 1) | 1 |
| status | Virknē (pēc izvēles) | Domeina statuss: all (visi domēni, noklusējums), active (aktīvie domēni), expired (beigušies domēni), stop (pārtrauktie domēni) | active |
| hold | Virknē (pēc izvēles) | Domes turēšanas statuss: tukša virkne (bez filtrēšanas, noklusējums), 0 (nav turēšanas statuss), 1 (turēšanas statuss) | 0 |
Atbildes parametri
| Parametra nosaukums | Tips | Apraksts |
|---|---|---|
| code | Vesels skaitlis | Statusa kods (200 nozīmē panākumu) |
| msg | Teksts | Ziņojums |
| data | Objekts | Datu objekts ar domēnu sarakstu un opcijām |
| data.options | Objekts | Vaicājuma opcijas ar kārtošanu, lapošanas un filtrēšanas iestatījumiem |
| data.options.sort | Teksts | Vaicājumā izmantotā kārtošanas metode |
| data.options.page_size | Vesels skaitlis | Vienību skaits vienā lapā |
| data.options.page_index | Vesels skaitlis | Pašreizējais lapas numurs |
| data.options.status | Teksts | Statusa filtrs, kas piemērots vaicājumam |
| data.options.total | Vesels skaitlis | Kopējais ierakstu skaits |
| data.options.total_pages | Vesels skaitlis | Kopējais lapu skaits |
| data.domain_list | Masīvs | Domēnu objektu masīvs |
| data.domain_list.domain | Teksts | Domēna vārds |
| data.domain_list.created_date | Datums | Izveides datums (GGGG-MM-DD) |
| data.domain_list.expired_date | Datums | Derīguma termiņš (GGGG-MM-DD) |
| data.domain_list.status | Teksts | Domēna statuss (aktīvs/izbeidzies/apturēts) |
| data.domain_list.nameservers | Masīvs | DNS serveru saraksts |
| data.domain_list.hold | Vesels skaitlis | Bloķēšanas statuss (0=nav bloķēts, 1=bloķēts) |
Pieprasījuma piemērs
{
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"
}
Atgrieztie rezultāti
0 OK
Veiksmīga atbilde
{
"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 Nederīga pieprasījuma kļūda
{
"code": 400,
"msg" : "Request parameter error",
}
