Traffic Policy Health Checkの変更

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

Traffic Policyの Health Check情報を変更します。

リクエスト

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

リクエストヘッダ

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

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

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

リクエストボディ

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

リクエスト例

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

curl --location --request PUT 'https://globaltrafficmanager.apigw.ntruss.com/gtm/v1/policies/****/monitors' \
--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 '{
    "hostHeader": "naver.com",
    "path": "/path",
    "period": 30,
    "port": 80,
    "protocol": "HTTP",
    "thresholdFail": 1,
    "thresholdNormal": 1
}'

レスポンス

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

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

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

レスポンス例

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

"SUCCESS"

エラーコード例

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

{
  "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"
    }
  }
}