概要
Global Traffic Managerが提供する Geo/CIDR Mapの作成、変更、削除機能を、規定の APIを通じて呼び出すことができる機能です。
ダッシュボードで発行した、許可された API Keyを使用すると呼び出せます。
Global Traffic Managerの共通設定
Global Traffic Manager APIで共通して使用されるリクエスト形式とレスポンス形式を説明します。
リクエスト
共通リクエスト形式を説明します。
API URL
リクエスト API URLは次の通りです。
https://globaltrafficmanager.apigw.ntruss.com
リクエストヘッダ
リクエストヘッダの説明は次の通りです。
| フィールド | 必須の有無 | 説明 |
|---|---|---|
x-ncp-apigw-timestamp |
Required | 1970年1月1日00:00:00協定世界時(UTC)からの経過時間(ミリ秒)
|
x-ncp-iam-access-key |
Required | NAVERクラウドプラットフォームから発行された Access Key
|
x-ncp-apigw-signature-v2 |
Required | NAVERクラウドプラットフォームから発行された 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は NAVERクラウドプラットフォームの共通レスポンスステータスコードを使用します。NAVERクラウドプラットフォームで共通して使用されるレスポンスステータスコードの詳細は、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"
}
}
}