listDomains

이 가이드는 API 명세를 기반으로 자동 생성했습니다.

Classic/VPC 환경에서 이용 가능합니다.

Ncloud API 표준 규격을 적용한 API입니다.

도메인 목록을 조회합니다. sort를 지정하지 않으면 기본 정렬로 status 오름차순, 이어서 name 오름차순이 적용됩니다. offset 페이지네이션(pageNo/pageSize)을 사용하므로 조회 중 도메인이 추가/삭제되면 페이지 경계에서 항목이 중복되거나 누락될 수 있습니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드	URI
GET	/domains

요청 헤더

Global DNS API에서 공통으로 사용하는 헤더에 대한 정보는 Global DNS 요청 헤더를 참조해 주십시오.

요청 쿼리 파라미터

요청 쿼리 파라미터에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`name`	String	Optional	도메인 이름 필터 부분 일치, 대소문자 무시 길이: ~ 255 <예시> example.com
`pageNo`	Integer (int32)	Optional	페이지 번호 (0부터 시작) 범위: 0 ~ 기본값: 0 <예시> 0
`pageSize`	Integer (int32)	Optional	페이지 크기 범위: 1 ~ 1,000 기본값: 20 <예시> 20
`sort`	List<String>	Optional	정렬 기준 (`property,(asc\\|desc)` 형식) 여러 개는 반복 지정 `status` 처럼 값이 고유하지 않은 키만으로 정렬하면 같은 값 사이의 순서가 보장되지 않으므로, 순서를 고정하려면 `name` 을 마지막 정렬키로 지정 기본값: `["status,asc", "name,asc"]` <예시> `["name,asc"]` 항목 패턴: `^(name\\|status)(,(asc\\|desc))?$`

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request GET 'https://globaldns.apigw.gov-ntruss.com/dns/v2/domains' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`pageNo`	Integer (int32)	-	페이지 번호 (0부터 시작) <예시> 0
`pageSize`	Integer (int32)	-	페이지 크기 <예시> 20
`totalElements`	Integer (int64)	-	전체 요소 개수 <예시> 100
`totalPages`	Integer (int32)	-	전체 페이지 수 <예시> 5
`domains`	List<DomainSimple>	-	페이지 내용 (도메인 요약)

DomainSimple

도메인 요약

필드	타입	필수 여부	설명
`domainNo`	Integer (int64)	-	도메인 번호 <예시> 1
`name`	String	-	도메인 이름 <예시> example.com
`applied`	Boolean	-	도메인 처리 완료 여부 (`status` 에서 파생) `true` \| `false` `true`: 처리 완료 (`status` 가 SUCCEEDED) `false`: 처리 중 (`status` 가 PROCESSING) <예시> true
`dnssecEnabled`	Boolean	-	DNSSEC 적용 여부 `true` \| `false` <예시> true
`status`	String	-	도메인 처리 상태 실패 상태 값은 없으며, 완료 판정에는 작업 자원의 `done` 사용 `PROCESSING` \| `SUCCEEDED` `PROCESSING`: 생성·수정·삭제 처리 중. 네임서버 동기화가 확인될 때까지 유지 `SUCCEEDED`: 처리 완료. 작업(Operation)의 `done` 이 true 가 되는 시점과 같음 <예시> SUCCEEDED

응답 상태 코드

Global DNS API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Global DNS 응답 상태 코드를 참조해 주십시오.

이 API에만 해당하는 응답 상태 코드는 다음과 같습니다.

HTTP 상태 코드	코드	메시지	설명
200	-	-	OK

응답 예시

응답 예시는 다음과 같습니다.

{
  "pageNo": 0,
  "pageSize": 20,
  "totalElements": 100,
  "totalPages": 5,
  "domains": [
    {
      "domainNo": 1,
      "name": "example.com",
      "applied": true,
      "dnssecEnabled": true,
      "status": "SUCCEEDED"
    }
  ]
}