MENU
      View traffic policy details

        View traffic policy details


        Article summary

        Available in Classic and VPC

        View the details of a specified traffic policy.

        Request

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

        MethodURI
        GET/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 example

        The following is a sample request.

        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}'
        Curl

        Response

        The following describes the response format.

        Response body

        See PolicyDetailResponse for the response body.

        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.

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

        Error code example

        The following is a sample error code.

        {
          "result": "FAIL",
          "error": {
            "errorCode": "05X000",
            "message": "You don't have permissions for the policy or the policy doesn't exist.",
            "moreInfo": {
              "timestamp": "2022-11-16T17:20:35.778+09:00"
            }
          }
        }
        JSON

        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.