Traffic Policyの詳細照会

Classic/VPC環境で利用できます。

指定した Traffic Policyの詳細情報を照会します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

リクエストヘッダ

Traffic Policy APIで共通して使用されるヘッダの詳細は、Traffic Policy APIの共通ヘッダをご参照ください。

リクエストパスパラメータ

パラメータの説明は次の通りです。

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request GET 'https://globaltrafficmanager.apigw.ntruss.com/gtm/v1/policies/****' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの詳細は、PolicyDetailResponseをご参照ください。

レスポンスステータスコード

NAVERクラウドプラットフォームでで共通して使用されるレスポンスステータスコードの詳細は、Ncloud APIのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "sid": ****,
    "name": "policy000",
    "memo": null,
    "lbType": "ROUND_ROBIN",
    "createdDate": 1716253070,
    "domainNames": [],
    "monitoringYn": true,
    "resourceGroups": [
        {
            "sid": ****,
            "weighted": null,
            "geoMapDetail": null,
            "active": [
                {
                    "type": "PUBLIC_IP",
                    "content": "175.**.**.**",
                    "healthCheckRegion": {
                        "sid": 1,
                        "name": "KR"
                    },
                    "status": "UNKNOWN"
                }
            ],
            "standby": []
        }
    ],
    "map": null,
    "monitor": {
        "protocol": "TCP",
        "port": 22,
        "path": null,
        "statusCodeList": [],
        "hostHeader": null,
        "thresholdFail": 1,
        "thresholdNormal": 1,
        "period": 30,
        "advancedYn": false
    }
}

エラーコード例

エラーコードのサンプルコードは次の通りです。

{
  "result": "FAIL",
  "error": {
    "errorCode": "05X000",
    "message": "このPolicyの権限がないか、存在しないPolicyです。",
    "moreInfo": {
      "timestamp": "2022-11-16T17:20:35.778+09:00"
    }
  }
}