Overview
This is a function that can call the number of domain (profile) queries provided by Global Traffic Manager as a prescribed API.
The allowed API key issued on the dashboard must be used to call the features.
Common Global Traffic Manager settings
The following describes commonly used request and response formats in Global Traffic Manager APIs.
Request
The following describes the common request format.
API URL
The request API URL is as follows:
https://globaltrafficmanager.apigw.ntruss.com
Request headers
The following describes the request headers.
| Field | Required | Description |
|---|---|---|
x-ncp-apigw-timestamp |
Required | This is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC.
|
x-ncp-iam-access-key |
Required | Access key issued on NAVER Cloud Platform
|
x-ncp-apigw-signature-v2 |
Required | Base64-encoded signature that encrypts the request information with a secret key that maps to the access key issued on NAVER Cloud Platform, using the HMAC encryption algorithm (HmacSHA256)
|
Content-Type |
Optional | Request data format
|
Response
The following describes the common response format.
응답 바디
응답 바디에 대한 설명은 다음과 같습니다.
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 | - | 오류 발생 시각 |
Response status codes
Global Traffic Manager APIs use NAVER Cloud Platform's common response status codes. For information about the HTTP status codes common to all NAVER Cloud Platform, see Ncloud API response status codes.