API documentation
Lista Domainek
Felhasználó domain listájának lekérése, támogatja az oldalak b?ngészését, rendezést és státusz szerinti sz?rést
Tartalom típusa
application-json
kategória
domain
m?velet
domain_list
Kérés paraméterei
| Paraméter neve | Típus | Leírás | Példa |
|---|---|---|---|
| sort | Karakterlánc (opcionális) | Rendezés módja: name_asc (domain név n?vekv?), name_desc (domain név cs?kken?), time_asc (regisztráció id?pontja n?vekv?), time_desc (regisztráció id?pontja cs?kken?, alapértelmezett) | time_desc |
| page_size | Egész szám (opcionális) | Elemek száma oldalanként (alapértelmezett: 10, elérhet?: 10, 20, 30, 50, 100) | 20 |
| page_index | Egész szám (opcionális) | Oldalszám (alapértelmezett: 1) | 1 |
| status | Karakterlánc (opcionális) | Domain státusz: minden (?sszes domain, alapértelmezett), aktív (aktív domainek), lejárt (lejárt domainek), leállított (leállított domainek) | active |
| hold | Karakterlánc (opcionális) | Domain zárolási státusz: üres (nincs sz?rés, alapértelmezett), 0 (nem zárolt), 1 (zárolt) | 0 |
Válasz paraméterei
| Paraméter neve | Típus | Leírás |
|---|---|---|
| code | Egész szám | Státuszkód (200 siker esetén) |
| msg | Sz?veg | üzenet |
| data | Objektum | Adatobjektum domain lista és beállításokkal |
| data.options | Objektum | Lekérdezési beállítások, t?bbek k?z?tt rendezés, lapozás és sz?rés |
| data.options.sort | Sz?veg | A lekérdezéshez használt rendezési mód |
| data.options.page_size | Egész szám | Elemek száma oldalanként |
| data.options.page_index | Egész szám | Jelenlegi oldalszám |
| data.options.status | Sz?veg | Lekérdezésre alkalmazott állapotsz?r? |
| data.options.total | Egész szám | ?sszes rekord száma |
| data.options.total_pages | Egész szám | ?sszes oldal száma |
| data.domain_list | T?mb | Domain objektumok t?mbje |
| data.domain_list.domain | Sz?veg | Domain név |
| data.domain_list.created_date | Dátum | Létrehozás dátuma (éééé-HH-NN) |
| data.domain_list.expired_date | Dátum | Lejárat dátuma (éééé-HH-NN) |
| data.domain_list.status | Sz?veg | Domain állapota (aktív/lejárt/felfüggesztett) |
| data.domain_list.nameservers | T?mb | DNS kiszolgáló t?mb |
| data.domain_list.hold | Egész szám | Felfüggesztési állapot (0=nincs felfüggesztés, 1=felfüggesztett) |
példa kérés
{
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"
}
Eredmény visszaadása
0 OK
Sikeres válasz
{
"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 Hibás kérés
{
"code": 400,
"msg" : "Request parameter error",
}
