API documentation
List Domains
Benutzer-Domainliste abrufen, unterstützt Paginierung, Sortierung und Statusfilterung
Content-Type
application-json
Kategorie
domain
Aktion
domain_list
Anfrageparameter
| Parametername | Typ | Beschreibung | Beispiel |
|---|---|---|---|
| sort | Zeichenkette (optional) | Sortiermethode: name_asc (Domainname aufsteigend), name_desc (Domainname absteigend), time_asc (Registrierungszeit aufsteigend), time_desc (Registrierungszeit absteigend, Standard) | time_desc |
| page_size | Ganzzahl (optional) | Anzahl der Elemente pro Seite (Standard: 10, unterstützt: 10, 20, 30, 50, 100) | 20 |
| page_index | Ganzzahl (optional) | Seitennummer (Standard: 1) | 1 |
| status | Zeichenkette (optional) | Domainstatus: all (alle Domains, Standard), active (aktive Domains), expired (abgelaufene Domains), stop (gestoppte Domains) | active |
| hold | Zeichenkette (optional) | Domain-Hold-Status: leerer String (kein Filter, Standard), 0 (kein Hold-Status), 1 (Hold-Status) | 0 |
Antwortparameter
| Parametername | Typ | Beschreibung |
|---|---|---|
| code | Ganzzahl | Statuscode (200 zeigt Erfolg an) |
| msg | Zeichenkette | Nachricht |
| data | Objekt | Datenobjekt mit Domainliste und Optionen |
| data.options | Objekt | Abfrageoptionen einschließlich Sortierung, Paginierung und Filtereinstellungen |
| data.options.sort | Zeichenkette | In der Abfrage verwendete Sortiermethode |
| data.options.page_size | Ganzzahl | Anzahl der Elemente pro Seite |
| data.options.page_index | Ganzzahl | Aktuelle Seitennummer |
| data.options.status | Zeichenkette | Auf die Abfrage angewendeter Statusfilter |
| data.options.total | Ganzzahl | Gesamtzahl der Datensätze |
| data.options.total_pages | Ganzzahl | Gesamtanzahl der Seiten |
| data.domain_list | Array | Array von Domainobjekten |
| data.domain_list.domain | Zeichenkette | Domainname |
| data.domain_list.created_date | Datum | Erstellungsdatum (JJJJ-MM-TT) |
| data.domain_list.expired_date | Datum | Ablaufdatum (JJJJ-MM-TT) |
| data.domain_list.status | Zeichenkette | Domainstatus (aktiv/abgelaufen/gestoppt) |
| data.domain_list.nameservers | Array | DNS-Server-Array |
| data.domain_list.hold | Ganzzahl | Hold-Status (0=nicht gehalten, 1=gehalten) |
Anfragebeispiel
{
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"
}
Rückgabewert
0 OK
Erfolgreiche Antwort
{
"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 Fehlerhafte Anfrage
{
"code": 400,
"msg" : "Request parameter error",
}
