API documentation
List النطاقات
الحصول على قائمة النطاقات الخاصة بالمستخدم مع دعم الترقيم والفرز وتصفية الحالات
نوع المحتوى
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 (غير محجوز)، 1 (محجوز) | 0 |
معلمات الاستجابة
| اسم المعلمة | النوع | الوصف |
|---|---|---|
| code | عدد صحيح | رمز الحالة (200 يعني نجاح) |
| msg | سلسلة نصية | الرسالة |
| 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 | مصفوفة | مصفوفة من كائنات النطاقات |
| data.domain_list.domain | سلسلة نصية | اسم النطاق |
| data.domain_list.created_date | التاريخ | تاريخ الإنشاء (YYYY-MM-DD) |
| data.domain_list.expired_date | التاريخ | تاريخ الانتهاء (YYYY-MM-DD) |
| data.domain_list.status | سلسلة نصية | حالة النطاق (نشط/منتهي/موقوف) |
| data.domain_list.nameservers | مصفوفة | مصفوفة خوادم DNS |
| data.domain_list.hold | عدد صحيح | حالة الحجز (0=غير محجوز، 1=محجوز) |
مثال الطلب
{
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",
}
