Classic/VPC 환경에서 이용 가능합니다.
개요
Global Traffic Manager에서 제공하는 Traffic Policy 생성, 수정, 삭제 기능을 규정된 API로 호출할 수 있는 기능입니다.
대시보드에서 발급한 허용된 API Key를 사용해야 호출할 수 있습니다.
Global Traffic Manager 공통 설정
Global Traffic Manager API에서 공통으로 사용하는 요청 형식과 응답 형식을 설명합니다.
요청
공통 요청 형식을 설명합니다.
API URL
요청 API URL은 다음과 같습니다.
https://globaltrafficmanager.apigw.gov-ntruss.com
요청 헤더
헤더에 대한 설명은 다음과 같습니다.
| 필드 | 필수 여부 | 설명 |
|---|---|---|
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로 인코딩한 서명 |
Content-type |
Optional | 요청 데이터의 형식
|
응답
공통 응답 형식을 설명합니다.
응답 바디
응답 바디에 대한 설명은 다음과 같습니다.
error
error는 API 호출 실패 정보를 정의합니다. error에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
result |
String | - | API 호출 결과
|
error |
Object | - | 오류 코드 및 메시지
|
error.errorCode |
Integer | - | 오류 코드 |
error.message |
String | - | 오류 메시지 |
error.devMessage |
String | - | 개발자용 오류 메시지 |
error.moreInfo |
Object | - | 추가 오류 정보 |
error.moreInfo.validationInfo |
Array | - | 유효성 검사 오류 정보 |
error.moreInfo.validationInfo.fieldPath |
String | - | 유효성 검사 오류가 발생한 필드 경로 |
error.moreInfo.validationInfo.msg |
String | - | 유효성 검사 오류 메시지 |
error.moreInfo.timestamp |
String | - | 오류 발생 시각 |
응답 상태 코드
Global Traffic Manager API는 네이버 클라우드 플랫폼의 공통 응답 상태 코드를 사용합니다. 네이버 클라우드 플랫폼에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Ncloud API 응답 상태 코드를 참조해 주십시오.
응답 예시
호출이 성공한 경우의 응답 예시는 각 API 명세에서 확인해 주십시오. 호출이 실패한 경우의 응답 예시는 다음과 같습니다.
{
"result": "FAIL",
"error": {
"errorCode": "05X000",
"message": "유효하지 않는 값입니다.<br>표시된 영역에 마우스오버를 하면 툴팁으로 자세한 내용을 볼 수 있습니다.",
"devMessage": "유효하지 않은 값입니다.",
"moreInfo": {
"validationInfo": [
{
"fieldPath": "monitor.hostHeader",
"msg": "protocol이(가) HTTP/HTTPS이(가) 아니면 hostHeader는(은) 입력할 수 없습니다."
}
],
"timestamp": "2022-11-16T10:54:47.191+09:00"
}
}
}