Edit traffic policy
    • PDF

    Edit traffic policy

    • PDF

    Article summary

    Available in Classic and VPC

    Edit the information for a specified traffic policy.

    Request

    The following describes the request format for the endpoint. The request format is as follows:

    MethodURI
    PUT/policies/{policyId}

    Request headers

    For headers common to all Traffic policy APIs, see Traffic policy API common headers.

    Request path parameters

    The following describes the parameters.

    FieldTypeRequiredDescription
    policyIdIntegerRequiredPolicy ID

    Request body

    See PolicyRequest for the request body.

    Request example

    The following is a sample request.

    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"
                    }
                ]
            }
        ]
    }'
    

    Response

    The following describes the response format.

    Response status codes

    For response status codes common to NAVER Cloud Platform, see Ncloud API response status codes.

    Response example

    The following is a sample response.

    ****
    

    Error code example

    The following is a sample error code.

    {
      "result": "FAIL",
      "error": {
        "errorCode": "05X000",
        "message": "Invalid value.<br>Hover your mouse over the displayed area to see the details in a tooltip.",
        "devMessage": "Invalid value.",
        "moreInfo": {
          "validationInfo": [
            {
              "fieldPath": "monitor.hostHeader",
              "msg": "hostHeader can't be entered unless the protocol is HTTP/HTTPS."
            },
            {
              "fieldPath": "geoMapId",
              "msg": "geoMapId can't be entered unless the load balancer type is Geo/CIDR."
            },
            {
              "fieldPath": "resourceGroups[0].geoMapDetailId",
              "msg": "geoMapDetailId can't be entered unless the load balancer type is Geo/CIDR."
            },
            {
              "fieldPath": "resourceGroups[0].sid",
              "msg": "sid can only be a minimum of 1 and a maximum of 9,223,372,036,854,775,807."
            },
            {
              "fieldPath": "resourceGroups[0].weighted",
              "msg": "weighted can't be entered unless the load balancer type is Weighted RR."
            }
          ],
          "timestamp": "2022-11-16T10:54:47.191+09:00"
        }
      }
    }
    

    Was this article helpful?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.