API documentation
Sąrašas Domenai
Gauti vartotojo domenų sąrašą, palaiko puslapiavimą, rūšiavimą ir būsenos filtravimą
Turinio tipas
application-json
kategorija
domain
veiksmas
domain_list
Užklausos parametrai
| Parametro pavadinimas | Tipas | Aprašymas | Pavyzdys |
|---|---|---|---|
| sort | Tekstas (pasirinktinai) | Rūšiavimo metodas: name_asc (domenų vardai didėjančia tvarka), name_desc (domenų vardai mažėjančia tvarka), time_asc (registracijos laikas didėjančia tvarka), time_desc (registracijos laikas mažėjančia tvarka, numatytoji reikšmė) | time_desc |
| page_size | Sveikasis skaičius (pasirinktinai) | Įrašų puslapyje skaičius (numatytoji reikšmė: 10, palaikoma: 10, 20, 30, 50, 100) | 20 |
| page_index | Sveikasis skaičius (pasirinktinai) | Puslapio numeris (numatytoji reikšmė: 1) | 1 |
| status | Tekstas (pasirinktinai) | Domeno būsenos: all (visi domenai, numatytoji reikšmė), active (aktyvūs domenai), expired (pasibaigę domenai), stop (sustabdyti domenai) | active |
| hold | Tekstas (pasirinktinai) | Domeno laikymo būsena: tuščia eilutė (be filtro, numatytoji), 0 (ne laikymo būsena), 1 (laikymo būsena) | 0 |
Atsakymo parametrai
| Parametro pavadinimas | Tipas | Aprašymas |
|---|---|---|
| code | Sveikasis skaičius | Būsenos kodas (200 reiškia sėkmę) |
| msg | Tekstas | Pranešimas |
| data | Objektas | Duomenų objektas su domenų sąrašu ir parinktimis |
| data.options | Objektas | Užklausos parinktys, įskaitant rūšiavimą, puslapiavimą ir filtravimą |
| data.options.sort | Tekstas | Užklausos rūšiavimo būdas |
| data.options.page_size | Sveikasis skaičius | Elementų skaičius puslapyje |
| data.options.page_index | Sveikasis skaičius | Dabartinis puslapio numeris |
| data.options.status | Tekstas | Užklausai taikomas būsenos filtras |
| data.options.total | Sveikasis skaičius | Įrašų suma |
| data.options.total_pages | Sveikasis skaičius | Puslapių suma |
| data.domain_list | Masyvas | Domenų objektų masyvas |
| data.domain_list.domain | Tekstas | Domeno vardas |
| data.domain_list.created_date | Data | Sukurimo data (YYYY-MM-DD) |
| data.domain_list.expired_date | Data | Galiojimo pabaigos data (YYYY-MM-DD) |
| data.domain_list.status | Tekstas | Domeno būsena (aktyvus/pasibaigęs/sustabdyta) |
| data.domain_list.nameservers | Masyvas | DNS serverių sąrašas |
| data.domain_list.hold | Sveikasis skaičius | Laikymo būsena (0=neužrakinta, 1=užrakinta) |
Užklausos pavyzdys
{
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"
}
Rezultato grąžinimas
0 OK
Sėkmingas atsakymas
{
"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 Neteisingas užklausimas
{
"code": 400,
"msg" : "Request parameter error",
}
