Traffic Policyの照会

Prev Next

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

指定した条件に基づいて Traffic Policyを照会します。

リクエスト

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

メソッド URI
GET /policies

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
page Integer Optional ページングされた結果のページ番号
  • 0(デフォルト)
size Integer Optional ページごとに表示する結果数
  • 20(デフォルト)
applyYn Boolean Optional 適用するかどうか
  • true | false
    • true: 適用する
    • false: 適用しない
domainName String Optional Profile名
name String Optional Policy名

リクエスト例

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

curl --location --request GET 'https://globaltrafficmanager.apigw.ntruss.com/gtm/v1/policies?size=2&applyYn=false' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンスボディ

レスポンスボディの詳細は、PolicyListResponseをご参照ください。

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

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

レスポンス例

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

{
    "content": [
        {
            "sid": ****,
            "name": "policy000",
            "lbType": "ROUND_ROBIN",
            "memo": null,
            "monitoringYn": true
        }
    ],
    "pageable": {
        "sort": {
            "sorted": false,
            "unsorted": true,
            "empty": true
        },
        "pageNumber": 0,
        "pageSize": 2,
        "offset": 0,
        "paged": true,
        "unpaged": false
    },
    "last": true,
    "totalPages": 1,
    "totalElements": 1,
    "first": true,
    "sort": {
        "sorted": false,
        "unsorted": true,
        "empty": true
    },
    "number": 0,
    "numberOfElements": 1,
    "size": 2,
    "empty": false
}