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(보류 아님), 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 | 문자열 | 도메인 상태 (active/expired/stop) |
| 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",
}
