Traffic Policy Resourceの変更

Prev Next

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

Traffic Policyに設定されたすべての Resource情報を変更します。

参考

Policy Resource変更 APIをリクエストすると、現在設定されている Resource情報をリクエストボディに含まれている Resource情報に置き換えます。特定の Resource情報だけ変更するには、Policyの特定の Resource変更 APIをご参照ください。

リクエスト

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

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

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
policyId Integer Required Policy ID

リクエストボディ

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

リクエスト例

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

curl --location --request PUT 'https://globaltrafficmanager.apigw.ntruss.com/gtm/v1/policies/****/resources' \
--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 '[
    {
        "active": [
            {
                "content": "***.7.**.57",
                "healthCheckRegionId": 1,
                "type": "PUBLIC_IP"
            }
        ],
        "geoMapDetailId": null,
        "sid": ****,
        "standby": [
            {
                "content": "***.53.**.0",
                "healthCheckRegionId": 1,
                "type": "PUBLIC_IP"
            }
        ]
    }
]'

レスポンス

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

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

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

レスポンス例

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

****

エラーコード例

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

{
  "result": "FAIL",
  "error": {
    "errorCode": "05X000",
    "message": "無効な値です。<br>表示された領域にマウスオーバーすると、ツールチップで詳細内容を確認できます。",
    "devMessage": "無効な値です。",
    "moreInfo": {
      "validationInfo": [
        {
          "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"
    }
  }
}