API documentation
सूची डोमेन
उपयोगकर्ता की डोमेन सूची प्राप्त करें, पेजिनेशन, सॉर्टिंग और स्थिति फ़िल्टरिंग का समर्थन करता है
Content-Type
application-json
श्रेणी
domain
कार्रवाई
domain_list
अनुरोध पैरामीटर
| पैरामीटर नाम | प्रकार | विवरण | उदाहरण |
|---|---|---|---|
| sort | स्ट्रिंग (वैकल्पिक) | क्रमबद्ध करने की विधि: name_asc (डोमेन नाम आरोही), name_desc (डोमेन नाम अवरोही), time_asc (पंजीकरण समय आरोही), time_desc (पंजीकरण समय अवरोही, डिफ़ॉल्ट) | time_desc |
| page_size | पूर्णांक (वैकल्पिक) | प्रति पृष्ठ आइटमों की संख्या (डिफ़ॉल्ट: 10, समर्थित: 10, 20, 30, 50, 100) | 20 |
| page_index | पूर्णांक (वैकल्पिक) | पेज नंबर (डिफ़ॉल्ट: 1) | 1 |
| status | स्ट्रिंग (वैकल्पिक) | डोमेन स्थिति: all (सभी डोमेन, डिफ़ॉल्ट), active (सक्रिय डोमेन), expired (समाप्त डोमेन), stop (रुके हुए डोमेन) | active |
| hold | स्ट्रिंग (वैकल्पिक) | डोमेन होल्ड स्थिति: खाली स्ट्रिंग (कोई फ़िल्टर नहीं, डिफ़ॉल्ट), 0 (non-hold स्थिति), 1 (hold स्थिति) | 0 |
प्रतिक्रिया पैरामीटर
| पैरामीटर नाम | प्रकार | विवरण |
|---|---|---|
| code | पूर्णांक | स्थिति कोड (200 सफलता को दर्शाता है) |
| msg | स्ट्रिंग | Message |
| data | ऑब्जेक्ट | डोमेन सूची और विकल्पों वाला डेटा ऑब्जेक्ट |
| data.options | ऑब्जेक्ट | सॉर्ट, पेजिनेशन और फ़िल्टरिंग सेटिंग्स सहित क्वेरी विकल्प |
| data.options.sort | स्ट्रिंग | क्वेरी में उपयोग की गई सॉर्ट विधि |
| data.options.page_size | पूर्णांक | प्रति पेज आइटमों की संख्या |
| data.options.page_index | पूर्णांक | वर्तमान पृष्ठ संख्या |
| data.options.status | स्ट्रिंग | क्वेरी पर लागू स्थिति फ़िल्टर |
| data.options.total | पूर्णांक | कुल रिकॉर्ड संख्या |
| data.options.total_pages | पूर्णांक | कुल पृष्ठों की संख्या |
| data.domain_list | एरे | domain objects की array |
| data.domain_list.domain | स्ट्रिंग | domain name |
| data.domain_list.created_date | तारीख | निर्माण तिथि (YYYY-MM-DD) |
| data.domain_list.expired_date | तारीख | समाप्ति तिथि (YYYY-MM-DD) |
| data.domain_list.status | स्ट्रिंग | डोमेन स्थिति (active/expired/stop) |
| data.domain_list.nameservers | एरे | DNS सर्वर ऐरे |
| data.domain_list.hold | पूर्णांक | होल्ड स्थिति (0=non-hold, 1=hold) |
अनुरोध उदाहरण
{
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"
}
परिणाम लौटाएँ
0 OK
सफल प्रतिक्रिया
{
"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 गलत अनुरोध
{
"code": 400,
"msg" : "Request parameter error",
}
