リクエスト

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

メソッド	URI
PUT	/policies/{policyId}

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`policyId`	Integer	Required	Policy ID Policyの照会を通じて確認

リクエストボディ

リクエストボディの詳細は、PolicyRequestをご参照ください。

リクエスト例

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

curl --location --request PUT '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}' \
--header 'Content-Type: application/json' \
--data '{
    "lbType": "ROUND_ROBIN",
    "monitor": {
        "hostHeader": "",
        "path": "/path",
        "period": 30,
        "port": 80,
        "protocol": "HTTP",
        "thresholdFail": 1,
        "thresholdNormal": 1
    },
    "name": "policy",
    "resourceGroups": [
        {
            "active": [
                {
                    "content": "***.22.**.1",
                    "healthCheckRegionId": 1,
                    "type": "PUBLIC_IP"
                }
            ],
            "sid": null,
            "standby": [
                {
                    "content": "***.0.**.0",
                    "healthCheckRegionId": 1,
                    "type": "PUBLIC_IP"
                }
            ]
        }
    ]
}'

レスポンス

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

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

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

レスポンス例

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

****

エラーコード例

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

{
  "result": "FAIL",
  "error": {
    "errorCode": "05X000",
    "message": "無効な値です。<br>表示された領域にマウスオーバーすると、ツールチップで詳細内容を確認できます。",
    "devMessage": "無効な値です。",
    "moreInfo": {
      "validationInfo": [
        {
          "fieldPath": "monitor.hostHeader",
          "msg": "protocolが HTTP/HTTPSの場合にのみ hostHeaderを入力できます。"
        },
        {
          "fieldPath": "geoMapId",
          "msg": "Load Balance Typeが GEO/CIDRの場合にのみ geoMapIdを入力できます。"
        },
        {
          "fieldPath": "resourceGroups[0].geoMapDetailId",
          "msg": "Load Balance Typeが GEO/CIDRの場合にのみ geoMapDetailIdを入力できます。"
        },
        {
          "fieldPath": "resourceGroups[0].sid",
          "msg": "sidは1以上9,223,372,036,854,775,807以下で入力できます。"
        },
        {
          "fieldPath": "resourceGroups[0].weighted",
          "msg": "Load Balance Typeが Weighted RRの場合にのみ weightedを入力できます。"
        }
      ],
      "timestamp": "2022-11-16T10:54:47.191+09:00"
    }
  }
}

この記事は役に立ちましたか?

リクエスト
レスポンス

タグ

Global Traffic Manager