이 가이드는 API 명세를 기반으로 자동 생성했습니다.
Classic/VPC 환경에서 이용 가능합니다.
Ncloud API 표준 규격을 적용한 API입니다.
Global DNS는 도메인(zone)과 DNS 레코드 관리 및 질의수 통계 조회를 지원하는 네이버 클라우드 플랫폼의 서비스입니다.
Global DNS 서비스에서는 도메인 관리, 레코드 관리 및 적용, 질의수 조회에 대한 API를 RESTful 형태로 제공합니다.
레코드 변경은 적용(apply) 요청 전까지 네임서버에 반영되지 않습니다. 레코드를 등록·수정·삭제한 뒤에는 적용을 호출해야 하며, 되돌리려면 롤백을 사용합니다. 적용은 요청한 변경분뿐 아니라 도메인의 전체 레코드를 검증하고 네임서버 동기화까지 수행하므로, 다른 비동기 요청과 마찬가지로 작업(Operation) 자원을 반환하며 진행 상태를 폴링해 확인합니다.
비동기로 처리되는 요청은 모두 작업(Operation) 자원을 반환합니다. 도메인 생성·수정·삭제는 GET /domains/operations/{operationId}, 레코드 적용은 GET /domains/{domainNo}/records/operations/{operationId} 로 폴링하며, 응답의 Retry-After 헤더가 권장 폴링 간격을 안내합니다. 도메인 생성·수정 작업은 완료 시 results 에 확정된 도메인 자원을 담으므로, 생성 결과의 domainNo 도 작업 응답에서 얻습니다. done 이 true 가 되는 시점은 변경 내용이 네임서버에 실제로 반영된 것까지 확인된 시점이며, 진행 중인 작업의 구간은 metadata.phase 로 확인할 수 있습니다.
API의 가독성을 높이기 위해 Global DNS API의 v1 버전을 ncloud에서 정의한 표준 표현에 의거하여 v2 버전으로 새롭게 출시하였습니다.
Global DNS 요청 형식
Global DNS API에서 공통으로 사용하는 요청 형식을 설명합니다.
API URL
요청 API URL은 다음과 같습니다.
https://globaldns.apigw.gov-ntruss.com/dns/v2
요청 헤더
요청 헤더에 대한 설명은 다음과 같습니다.
| 필드 | 필수 여부 | 설명 |
|---|---|---|
x-ncp-apigw-timestamp |
Required | 1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간(밀리초)
|
x-ncp-iam-access-key |
Required | 네이버 클라우드 플랫폼에서 발급받은 Access Key
|
x-ncp-apigw-signature-v2 |
Required | 네이버 클라우드 플랫폼에서 발급받은 Access Key에 맵핑되는 Secret Key 및 HMAC 암호화 알고리즘(HmacSHA256)으로 요청 정보를 암호화한 후 Base64로 인코딩한 서명
|
Global DNS 응답 형식
Global DNS API에서 공통으로 사용하는 응답 형식을 설명합니다.
응답 바디
API 오류 시 공통으로 반환하는 응답 바디는 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
error |
Object<Error> | - | 오류 상세
|
Error
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
errorCode |
String | - | 에러 코드 |
message |
String | - | 에러 메시지 (기본 영어, 다국어 지원 가능) |
detail |
String | - | 에러 상세 정보 (기본 영어, 다국어 지원 가능) |
fieldErrors |
List<FieldError> | - | 입력값 에러가 발생한 경우 각 필드별 에러 상세 정보 목록 |
FieldError
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
message |
String | - | 필드 에러 메시지 (기본 영어, 다국어 지원 가능) |
field |
String | - | 입력값 검증 실패 시 해당 필드 이름 |
응답 상태 코드
응답 상태 코드에 대한 설명은 다음과 같습니다.
| HTTP 상태 코드 | 코드 | 메시지 | 설명 |
|---|---|---|---|
| 200 | - | - | 각 API 문서의 응답 상태 코드를 참조 |
| 201 | - | - | 각 API 문서의 응답 상태 코드를 참조 |
| 202 | - | - | 각 API 문서의 응답 상태 코드를 참조 |
| 204 | - | - | 각 API 문서의 응답 상태 코드를 참조 |
| 400 | InvalidParameter | The specified parameter is invalid. | |
| 400 | BadRequest | The request is malformed or contains an error such as an invalid parameter value or a missing required parameter. | |
| 400 | InvalidOperation | The specified operation is invalid. | 각 API 문서의 응답 상태 코드를 참조 |
| 400 | CannotDelete | The delete operation could not be completed. | 각 API 문서의 응답 상태 코드를 참조 |
| 401 | Unauthorized | Invalid authentication credentials. | |
| 403 | Forbidden | You do not have sufficient permissions to perform this action. | 권한이 없거나 보유하지 않은 도메인 번호(존재하지 않는 번호 포함)를 요청한 경우, 또는 도메인 생성 시 다른 회원이 이미 보유한 도메인 이름을 지정한 경우. 권한과 도메인 번호·이름을 확인한 뒤 다시 요청 |
| 404 | ResourceNotFound | The specified resource could not be found. | 각 API 문서의 응답 상태 코드를 참조 |
| 409 | AlreadyExists | A resource with the requested identifier already exists. | 각 API 문서의 응답 상태 코드를 참조 |
| 409 | ResourceInUse | The specified resource is in use. | 각 API 문서의 응답 상태 코드를 참조 |
| 412 | PreconditionFailed | The precondition in one or more of the request fields evaluated to false | 각 API 문서의 응답 상태 코드를 참조 |
| 415 | UnsupportedMediaType | The content type of the request body is not supported. | |
| 500 | InternalServerError | The request processing has failed because of an unknown error, exception, or failure. |
네이버 클라우드 플랫폼에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Ncloud API 응답 상태 코드를 참조해 주십시오.
Global DNS API
Global DNS 서비스에서 제공하는 API에 대한 설명은 다음과 같습니다.
Domains
Domains 관련 API에 대한 설명은 다음과 같습니다.
| API | 설명 |
|---|---|
| createDomain | 도메인 생성 |
| getDomain | 도메인 조회 |
| getDomainsOperation | 도메인 작업 조회 |
| listDomains | 도메인 목록 조회 |
| listDomainsOperations | 도메인 작업 목록 조회 |
| updateDomain | 도메인 수정 |
| deleteDomain | 도메인 삭제 |
Records
Records 관련 API에 대한 설명은 다음과 같습니다.
| API | 설명 |
|---|---|
| createRecord | 레코드 생성 |
| getRecord | 레코드 조회 |
| getRecordsOperation | 레코드 적용 작업 조회 |
| listRecords | 레코드 목록 조회 |
| listRecordsOperations | 레코드 적용 작업 목록 조회 |
| updateRecord | 레코드 수정 |
| deleteRecord | 레코드 삭제 |
| applyRecords | 레코드 적용 |
| batchCreateRecords | 레코드 일괄 생성 |
| batchDeleteRecords | 레코드 일괄 삭제 |
| batchUpdateRecords | 레코드 일괄 수정 |
| rollbackRecords | 레코드 롤백 |
Record Linkable Load Balancers
Record Linkable Load Balancers 관련 API에 대한 설명은 다음과 같습니다.
| API | 설명 |
|---|---|
| listRecordLinkableLoadBalancers | 레코드 연결 가능 로드밸런서 목록 조회 |
Query Statistics
Query Statistics 관련 API에 대한 설명은 다음과 같습니다.
| API | 설명 |
|---|---|
| listMemberQueryStatistics | 회원 질의수 목록 조회 |
| listQueryStatistics | 질의수 목록 조회 |
Global DNS 연관 콘텐츠
Global DNS API에 대한 사용자의 이해를 돕기 위해 다양한 연관 콘텐츠를 제공하고 있습니다.
-
Global DNS API 사용 방법
- API 개요: 네이버 클라우드 플랫폼에서 발급받은 Access Key, Secret Key 발급 및 확인, 요청 헤더에 필요한 서명 생성 방법
- Sub Account 사용 가이드: 서브 계정의 Access Key 발급 및 확인 방법
- API Gateway 사용 가이드: 요청 헤더에 필요한 API Key 확인 방법
-
Global DNS 서비스 사용 방법
- Global DNS 사용 가이드: 네이버 클라우드 플랫폼 콘솔에서 Global DNS 사용하는 방법
- Ncloud 사용 환경 가이드: VPC, Classic 환경 및 지원 여부에 대한 가이드
- 요금 소개, 특징, 상세 기능: Global DNS의 요금 체계, 특징, 상세 기능 요약
- 서비스 최신 소식: Global DNS 관련 최신 소식
- 자주 하는 질문: Global DNS 사용자들이 자주 하는 질문
- 문의하기: 사용 가이드를 통해서도 궁금증이 해결되지 않는 경우 직접 문의