API documentation
รายการ โดเมน
ดึงรายการโดเมนของผู้ใช้ รองรับการแบ่งหน้า การเรียงลำดับ และการกรองตามสถานะ
Content-Type
application-json
หมวดหมู่
domain
การทำงาน
domain_list
พารามิเตอร์คำขอ
| ชื่อพารามิเตอร์ | ประเภท | คำอธิบาย | ตัวอย่าง |
|---|---|---|---|
| sort | สตริง (ไม่บังคับ) | วิธีการจัดเรียง: name_asc (domain name จากน้อยไปมาก), name_desc (domain name จากมากไปน้อย), 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 | สตริง (ไม่บังคับ) | สถานะ hold ของโดเมน: ค่าว่าง (ไม่กรอง, ค่าเริ่มต้น), 0 (สถานะไม่ถูก hold), 1 (สถานะ hold) | 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 | สตริง | สถานะโดเมน (active/expired/stop) |
| data.domain_list.nameservers | อาร์เรย์ | รายการเซิร์ฟเวอร์ DNS |
| data.domain_list.hold | จำนวนเต็ม | สถานะ 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",
}
