applyRecords

Prev Next

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

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

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

적용 대기 중인 레코드 변경분을 네임서버에 적용합니다. 적용은 요청한 변경분만이 아니라 해당 도메인의 전체 레코드를 검증하고 네임서버 동기화까지 수행하는 작업이므로, 완료를 기다리지 않고 즉시 작업(Operation) 자원을 반환합니다. 진행 상태는 응답의 id 로 작업 조회 API 를 폴링해 확인하며, id 를 잃어버린 경우에는 GET /domains/{domainNo}/records/operations 로 작업 목록에서 다시 찾을 수 있습니다. 작업은 변경분을 검증해 반영하는 구간(metadata.phase = APPLYING)과 네임서버 반영을 확인하는 구간(SYNCHRONIZING)을 차례로 지나며, 두 구간이 모두 끝나야 done 이 true 가 됩니다.

요청

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

메서드 URI
POST /domains/{domainNo}/records/apply

요청 헤더

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

요청 경로 파라미터

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

필드 타입 필수 여부 설명
domainNo Integer (int64) Required 도메인 번호
  • 보유하지 않았거나 존재하지 않는 번호는 403 Forbidden (두 경우를 구분하지 않음)
  • <예시> 120

요청 예시

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

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

응답

응답 형식을 설명합니다.

응답 헤더

응답 헤더에 대한 설명은 다음과 같습니다.

필드 필수 여부 설명
Retry-After Optional 권장 폴링 대기 시간(초)
  • 아직 진행 중인 작업·자원에만 포함 (202 응답)

응답 바디

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

필드 타입 필수 여부 설명
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)에 들어선 작업은 이미 반영된 변경을 되돌리지 않으므로 실패로 끝나지 않으며, 동기화가 지연되면 완료될 때까지 진행 중으로 남음

Error

에러 정보

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

응답 상태 코드

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

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

HTTP 상태 코드 코드 메시지 설명
202 - - Accepted (작업 접수). 응답 본문은 작업(Operation) 자원이며 접수 시점에는 done 이 false 입니다. GET /domains/{domainNo}/records/operations/{operationId} 로 폴링해 done 이 true 가 되면 변경분이 네임서버까지 반영된 것입니다. 폴링 간격은 Retry-After 헤더를 따릅니다.

응답 예시

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

{
  "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"
  }
}