Record 개요

개요

Global DNS 에서 제공하는 도메인/레코드 생성/수정/삭제 기능을 규정된 API로 호출할 수 있는 기능입니다.
대시보드에서 발급한 허용된 API Key를 사용해야 호출이 가능합니다.

Global DNS API에서 공통으로 사용하는 요청 형식과 응답 형식을 설명합니다.

공통 요청 형식을 설명합니다.

요청 API URL은 다음과 같습니다.

https://globaldns.apigw.gov-ntruss.com

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

필드	필수 여부	설명
`x-ncp-apigw-timestamp`	Required	1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간(밀리초) API Gateway 서버와 5분 이상 시간차 발생 시 유효하지 않은 요청으로 간주 Unix Timestamp 형식
`x-ncp-iam-access-key`	Required	네이버 클라우드 플랫폼에서 발급받은 Access Key Access Key 발급 및 확인: 인증키 생성 참조 서브 계정의 Access Key 발급 및 확인: 서브 계정 생성 참조
`x-ncp-apigw-signature-v2`	Required	네이버 클라우드 플랫폼에서 발급받은 Access Key에 맵핑되는 Secret Key 및 HMAC 암호화 알고리즘(HmacSHA256)으로 요청 정보를 암호화한 후 Base64로 인코딩한 서명 Secret Key 발급 및 확인: 인증키 생성 참조 서명 생성: 시그니처 생성 참조
`Content-type`	Optional	요청 데이터의 형식 application/json

공통 응답 형식을 설명합니다.

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

error
error는 API 호출 실패 정보를 정의합니다. error에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`result`	String	-	API 호출 결과 `FAIL`: 호출이 실패한 경우 표시
`error`	Object	-	오류 코드 및 메시지 `success`가 `false`인 경우 표시
`error.errorCode`	Integer	-	오류 코드
`error.message`	String	-	오류 메시지

Global DNS API는 네이버 클라우드 플랫폼의 공통 응답 상태 코드를 사용합니다. 네이버 클라우드 플랫폼에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Ncloud API 응답 상태 코드를 참조해 주십시오.

호출이 성공한 경우의 응답 예시는 각 API 명세에서 확인해 주십시오. 호출이 실패한 경우의 응답 예시는 다음과 같습니다.

{
    "result": "FAIL",
    "error": {
        "errorCode": "X00006",
        "message": "권한이 없습니다.",
        "devMessage": "권한이 없습니다."
    }
}