View traffic policy resource details

Prev Next

Available in Classic and VPC

View configured resource information of a specified traffic policy.

Request

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

Method URI
GET /policies/{policyId}/resources

Request headers

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

Request path parameters

The following describes the parameters.

Field Type Required Description
policyId Integer Required Policy ID

Request example

The following is a sample request.

curl --location --request GET '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}'

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": ****,
        "weighted": null,
        "geoMapDetail": null,
        "active": [
            {
                "type": "PUBLIC_IP",
                "content": "175.**.**.**",
                "healthCheckRegion": {
                    "sid": 1,
                    "name": "KR"
                },
                "status": "UNKNOWN"
            }
        ],
        "standby": []
    }
]

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