Traffic Profileの照会

Prev Next

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

指定した条件に基づいて Traffic Profile(ドメイン)を照会します。

リクエスト

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

メソッド URI
GET /domains

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
page Integer Optional ページングされた結果のページ番号
  • 0(デフォルト)
size Integer Optional ページごとに表示する結果数
  • 20(デフォルト)
name String Optional Profile名

リクエスト例

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

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

レスポンス

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

レスポンスボディ

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

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

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

レスポンス例

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

{
    "content": [
        {
            "sid": 14***,
            "name": "profile.ncloudgtm.com",
            "delYn": false,
            "policyId": ****,
            "policyName": "policy",
            "lbType": "ROUND_ROBIN",
            "status": "SUCCESS"
        }
    ],
    "pageable": {
        "sort": {
            "sorted": true,
            "unsorted": false,
            "empty": false
        },
        "pageNumber": 0,
        "pageSize": 1,
        "offset": 0,
        "paged": true,
        "unpaged": false
    },
    "last": true,
    "totalPages": 1,
    "totalElements": 1,
    "sort": {
        "sorted": true,
        "unsorted": false,
        "empty": false
    },
    "first": true,
    "number": 0,
    "numberOfElements": 1,
    "size": 1,
    "empty": false
}