API documentation
Nimekiri Domeenid
Kuva kasutaja domeenide nimekiri, toetab lehekülgede jagamist, sorteerimist ja oleku filtreerimist
Content-Type
application-json
kategooria
domain
tegevus
domain_list
Päringu parameetrid
| Parameetri nimi | Tüüp | Kirjeldus | Näide |
|---|---|---|---|
| sort | Jada (valikuline) | Sorteerimismeetod: name_asc (domeeninimed kasvavas järjekorras), name_desc (domeeninimed kahanevas järjekorras), time_asc (registreerimise aeg kasvavas järjekorras), time_desc (registreerimise aeg kahanevas järjekorras, vaikimisi) | time_desc |
| page_size | Täisarv (valikuline) | Elementide arv lehel (vaikimisi: 10, toetatud: 10, 20, 30, 50, 100) | 20 |
| page_index | Täisarv (valikuline) | Lehe number (vaikimisi: 1) | 1 |
| status | Jada (valikuline) | Domeeni staatus: all (kõik domeenid, vaikimisi), active (aktiivsed domeenid), expired (aegunud domeenid), stop (peatatud domeenid) | active |
| hold | Jada (valikuline) | Domeeni peatamise olek: tühi string (filtreerimist ei toimu, vaikimisi), 0 (mitte-peatatud olek), 1 (peatatud olek) | 0 |
Vastusparameetrid
| Parameetri nimi | Tüüp | Kirjeldus |
|---|---|---|
| code | Täisarv | Olekukood (200 tähendab edukust) |
| msg | Tekstijada | Sõnum |
| data | Objekt | Domeenide nimekirja ja valikuid sisaldav andmeobjekt |
| data.options | Objekt | Päringu valikud, sealhulgas sorteerimine, lehekülgede jagamine ja filtreerimine |
| data.options.sort | Tekstijada | Päringus kasutatav sorteerimismeetod |
| data.options.page_size | Täisarv | Elementide arv lehekülje kohta |
| data.options.page_index | Täisarv | Praegune lehekülg |
| data.options.status | Tekstijada | Päringule rakendatud oleku filter |
| data.options.total | Täisarv | Kirjete koguarv |
| data.options.total_pages | Täisarv | Lehekülgede koguarv |
| data.domain_list | Massiiv | Domeeniobjektide massiiv |
| data.domain_list.domain | Tekstijada | Domeeninimi |
| data.domain_list.created_date | Kuupäev | Loomiskuupäev (AAAA-KK-PP) |
| data.domain_list.expired_date | Kuupäev | Aegumiskuupäev (AAAA-KK-PP) |
| data.domain_list.status | Tekstijada | Domeeni olek (aktiivne/aegunud/peatatud) |
| data.domain_list.nameservers | Massiiv | DNS-serverite valik |
| data.domain_list.hold | Täisarv | Blokeerimisstaatus (0=ei blokeeritud, 1=blokeeritud) |
päringu näide
{
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"
}
tagastuse tulemus
0 OK
Õnnestunud vastus
{
"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 Vigane päring
{
"code": 400,
"msg" : "Request parameter error",
}
