API documentation
Lista Domäner
Hämta användarens domänlista, stöd för paginering, sortering och statusfilter
Content-Type
application-json
kategori
domain
åtgärd
domain_list
Begärans parametrar
| Parameternamn | Typ | Beskrivning | Exempel |
|---|---|---|---|
| sort | Sträng (valfri) | Sorteringsmetod: name_asc (domännamn stigande), name_desc (domännamn fallande), time_asc (registreringstid stigande), time_desc (registreringstid fallande, standard) | time_desc |
| page_size | Heltal (valfri) | Antal objekt per sida (standard: 10, stöds: 10, 20, 30, 50, 100) | 20 |
| page_index | Heltal (valfri) | Sidnummer (standard: 1) | 1 |
| status | Sträng (valfri) | Domänstatus: all (alla domäner, standard), active (aktiva domäner), expired (utgångna domäner), stop (avstängda domäner) | active |
| hold | Sträng (valfri) | Domänens hold-status: tom sträng (ingen filtrering, standard), 0 (icke hold-status), 1 (hold-status) | 0 |
Svarparametrar
| Parameternamn | Typ | Beskrivning |
|---|---|---|
| code | Heltal | Statuskod (200 betyder framgång) |
| msg | Sträng | Meddelande |
| data | Objekt | Dataobjekt som innehåller domänlista och alternativ |
| data.options | Objekt | Frågealternativ inklusive sortering, sidindelning och filtrering |
| data.options.sort | Sträng | Sorteringsmetod som används i förfrågan |
| data.options.page_size | Heltal | Antal objekt per sida |
| data.options.page_index | Heltal | Aktuellt sidnummer |
| data.options.status | Sträng | Statusfilter tillämpat på sökningen |
| data.options.total | Heltal | Totalt antal poster |
| data.options.total_pages | Heltal | Totalt antal sidor |
| data.domain_list | Array | Array av domänobjekt |
| data.domain_list.domain | Sträng | Domännamn |
| data.domain_list.created_date | Datum | Skapelsedatum (ÅÅÅÅ-MM-DD) |
| data.domain_list.expired_date | Datum | Utgångsdatum (ÅÅÅÅ-MM-DD) |
| data.domain_list.status | Sträng | Domänstatus (aktiv/utgånget/avstängd) |
| data.domain_list.nameservers | Array | Lista över DNS-servrar |
| data.domain_list.hold | Heltal | Hold-status (0=ingen hold, 1=hold) |
Exempel på förfrågan
{
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"
}
Svarsresultat
0 OK
Framgångsrikt 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 Felaktig förfrågan
{
"code": 400,
"msg" : "Request parameter error",
}
