listDomainsOperations

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

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

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

도메인 생성·수정·삭제 작업(Operation) 목록을 조회합니다. 요청 응답에서 받은 id 를 잃어버렸거나 클라이언트가 재시작된 경우에도 이 API 로 진행 중인 작업을 다시 찾을 수 있습니다. sort를 지정하지 않으면 기본 정렬로 작업 시작 시각(metadata.startDateTime) 내림차순, 이어서 값이 고유한 id 오름차순이 적용되어 순서가 항상 일정합니다. offset 페이지네이션(pageNo/pageSize)을 사용하므로 조회 중 작업이 추가되면 페이지 경계에서 항목이 중복되거나 누락될 수 있습니다. 완료된 작업은 완료 시점으로부터 30일 동안만 보관하므로, 보관 기간이 지난 작업은 목록에서 사라집니다. 레코드 적용 작업은 GET /domains/{domainNo}/records/operations 를 사용합니다.

요청

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

메서드	URI
GET	/domains/operations

요청 헤더

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

요청 쿼리 파라미터

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

필드	타입	필수 여부	설명
`pageNo`	Integer (int32)	Optional	페이지 번호 (0부터 시작) 범위: 0 ~ 기본값: 0 <예시> 0
`pageSize`	Integer (int32)	Optional	페이지 크기 범위: 1 ~ 1,000 기본값: 20 <예시> 20
`sort`	List<String>	Optional	정렬 기준 (`property,(asc\\|desc)` 형식) 중첩 필드는 응답 본문 위치 그대로 `.` 으로 접근 (예: `metadata.startDateTime`) 여러 개는 반복 지정 시각 정렬키는 값이 고유하지 않으므로, 순서를 고정하려면 `id` 를 마지막 정렬키로 지정 기본값: `["metadata.startDateTime,desc", "id,asc"]` <예시> `["metadata.startDateTime,desc"]` 항목 패턴: `^(metadata\.startDateTime\\|metadata\.endDateTime\\|id)(,(asc\\|desc))?$`

요청 예시

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

curl --location --request GET 'https://globaldns.apigw.gov-ntruss.com/dns/v2/domains/operations' \
--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
`operations`	List<DomainOperation>	-	페이지 내용 (작업)

DomainOperation

도메인 작업. 공용 작업 자원에 LRO 표준 결과 필드(results)를 더한 형태입니다. 레코드 적용 작업과 달리 확정된 도메인 자원을 돌려줘야 하므로 results 를 둡니다. results 는 생성·수정 작업에만 담기며, 결과 자원이 없는 삭제 작업에는 내려가지 않습니다.

필드	타입	필수 여부	설명
`id`	String (uuid)	-	작업 ID <예시> 3fa85f64-5717-4562-b3fc-2c963f66afa6
`done`	Boolean	-	작업 완료 여부 저장소 반영 시점이 아니라 네임서버에 실제로 반영된 것까지 확인된 시점에 true true 이면 변경이 DNS 질의에 반영된 상태 `true` \| `false` <예시> false
`metadata`	Object<OperationMetadata>	-	작업 메타데이터
`error`	Object<Error> \| Null	-	실패 사유 (완료 및 실패 시에만 존재) 실패는 변경분을 검증해 반영하는 구간(APPLYING)에서만 발생 네임서버 동기화 구간(SYNCHRONIZING)에 들어선 작업은 이미 반영된 변경을 되돌리지 않으므로 실패로 끝나지 않으며, 동기화가 지연되면 완료될 때까지 진행 중으로 남음
`results`	Map<DomainDetailed>	-	작업 결과 자원 맵 (요청 인덱스를 문자열 키로 사용) 단건 작업이므로 `"0"` 하나만 포함 생성·수정 작업이 완료된 경우에만 포함되며, 진행 중이거나 삭제 작업이면 포함되지 않음

Error

에러 정보

필드	타입	필수 여부	설명
`errorCode`	String	-	에러 코드
`message`	String	-	에러 메시지 (기본 영어, 다국어 지원 가능)
`detail`	String	-	에러 상세 정보 (기본 영어, 다국어 지원 가능)
`fieldErrors`	List<FieldError>	-	입력값 에러가 발생한 경우 각 필드별 에러 상세 정보 목록

DomainDetailed

도메인 상세

필드	타입	필수 여부	설명
`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
`description`	String \| null	-	도메인 설명 <예시> my domain
`createdTimestamp`	Integer (int64)	-	생성 시각 (Unix epoch 밀리초) <예시> 1568111263000
`updatedTimestamp`	Integer (int64)	-	수정 시각 (Unix epoch 밀리초) <예시> 1568111263000
`recordCount`	Integer (int64)	-	이 도메인(domainNo)에 속한 레코드 수 <예시> 5
`soa`	Object<SoaRecord>	-	SOA 레코드 항상 객체이며 하위 필드만 null 가능 하위 필드가 모두 null 인 경우: 도메인 설정 적용 전이거나 삭제 처리 중 삭제가 완료된 도메인은 조회 시 403 Forbidden

SoaRecord

SOA 레코드. 사용자가 직접 설정하지 않으며, 도메인 설정 적용 시 시스템이 값을 채웁니다. 적용 전에는 domainName·nameServers·serial·refresh·retry·expire·ttl 이 null 이고, dnssecEnabled 는 항상 값이 있습니다(적용 전에는 false).

필드	타입	필수 여부	설명
`domainName`	String \| null	-	도메인 이름 <예시> example.com
`nameServers`	List<String> \| null	-	네임서버 목록 <예시> `["ns1-1.ns-ncloud.com.", "ns1-2.ns-ncloud.com."]`
`serial`	Integer (int64) \| null	-	SOA serial 번호 <예시> 2019091001
`refresh`	Integer (int64) \| null	-	SOA refresh (초) <예시> 3600
`retry`	Integer (int64) \| null	-	SOA retry (초) <예시> 600
`expire`	Integer (int64) \| null	-	SOA expire (초) <예시> 604800
`ttl`	Integer (int64) \| null	-	SOA 최소 TTL (초) <예시> 300
`dnssecEnabled`	Boolean	-	DNSSEC 적용 여부 `true` \| `false` <예시> true

응답 상태 코드

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

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

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

응답 예시

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

{
  "pageNo": 0,
  "pageSize": 20,
  "totalElements": 100,
  "totalPages": 5,
  "operations": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "done": false,
      "metadata": {
        "operationType": "UPDATE",
        "resourceType": "records",
        "startDateTime": "2026-06-30T12:00:00Z",
        "endDateTime": "2026-06-30T12:00:05Z",
        "phase": "SYNCHRONIZING"
      },
      "results": {
        "key": {
          "domainNo": 1,
          "name": "example.com",
          "applied": true,
          "dnssecEnabled": true,
          "status": "SUCCEEDED",
          "description": "my domain",
          "createdTimestamp": 1568111263000,
          "updatedTimestamp": 1568111263000,
          "recordCount": 5,
          "soa": {
            "domainName": "example.com",
            "nameServers": [
              "ns1-1.ns-ncloud.com.",
              "ns1-2.ns-ncloud.com."
            ],
            "serial": 2019091001,
            "refresh": 3600,
            "retry": 600,
            "expire": 604800,
            "ttl": 300,
            "dnssecEnabled": true
          }
        }
      }
    }
  ]
}