API documentation
Liste Domæner
Hent brugerens domæneliste, understøtter sideinddeling, sortering og statusfiltrering
Content-Type
application-json
kategori
domain
handling
domain_list
Anmodningsparametre
| Parameter navn | Type | Beskrivelse | Eksempel |
|---|---|---|---|
| sort | Tekst (valgfri) | Sorteringsmetode: name_asc (domænenavn stigende), name_desc (domænenavn faldende), time_asc (registreringstid stigende), time_desc (registreringstid faldende, standard) | time_desc |
| page_size | Heltal (valgfri) | Antal elementer pr. side (standard: 10, understøttet: 10, 20, 30, 50, 100) | 20 |
| page_index | Heltal (valgfri) | Sidetal (standard: 1) | 1 |
| status | Tekst (valgfri) | Domænestatus: all (alle domæner, standard), active (aktive domæner), expired (udløbne domæner), stop (suspendere domæner) | active |
| hold | Tekst (valgfri) | Domain hold status: tom streng (ingen filtrering, standard), 0 (ikke hold-status), 1 (hold-status) | 0 |
Svarparametre
| Parameter navn | Type | Beskrivelse |
|---|---|---|
| code | Heltal | Statuskode (200 indikerer succes) |
| msg | Tekststreng | Besked |
| data | Objekt | Dataobjekt med domæneliste og indstillinger |
| data.options | Objekt | Forespørgselsindstillinger inklusive sortering, sideinddeling og filtre |
| data.options.sort | Tekststreng | Sorteringsmetode brugt i forespørgslen |
| data.options.page_size | Heltal | Antal elementer pr. side |
| data.options.page_index | Heltal | Aktuel sidetal |
| data.options.status | Tekststreng | Statusfilter anvendt på forespørgslen |
| data.options.total | Heltal | Samlet antal poster |
| data.options.total_pages | Heltal | Samlet antal sider |
| data.domain_list | Array | Array af domæneobjekter |
| data.domain_list.domain | Tekststreng | Domænenavn |
| data.domain_list.created_date | Dato | Oprettelsesdato (ÅÅÅÅ-MM-DD) |
| data.domain_list.expired_date | Dato | Udløbsdato (ÅÅÅÅ-MM-DD) |
| data.domain_list.status | Tekststreng | Domænestatus (aktiv/udløbet/stop) |
| data.domain_list.nameservers | Array | DNS-server array |
| data.domain_list.hold | Heltal | Hold-status (0=ikke hold, 1=hold) |
Forespørgselseksempel
{
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"
}
Returner resultat
0 OK
Succesfuldt svar
{
"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 Ugyldig anmodning
{
"code": 400,
"msg" : "Request parameter error",
}
