Traffic Profileの詳細照会

Prev Next

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

指定した Traffic Profile(ドメイン)の詳細情報を照会します。

リクエスト

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

メソッド URI
GET /domains/{domainId}

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
domainId Integer Required Profile ID

リクエスト例

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

curl --location --request GET 'https://globaltrafficmanager.apigw.ntruss.com/gtm/v1/domains/14***' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンスボディ

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

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

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

レスポンス例

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

{
    "sid": 14***,
    "name": "profile.ncloudgtm.com",
    "delYn": false,
    "policyId": ****,
    "policyName": "policy",
    "lbType": "ROUND_ROBIN",
    "createdDate": 1716791888,
    "monitoringYn": false,
    "ttl": 400,
    "claRegion": null,
    "resourceGroups": [
        {
            "sid": ****,
            "weighted": null,
            "geoMapDetail": null,
            "active": [
                {
                    "type": "PUBLIC_IP",
                    "content": "125.**.87.**",
                    "healthCheckRegion": {
                        "sid": 1,
                        "name": null
                    },
                    "status": "UNKNOWN"
                }
            ],
            "standby": []
        }
    ],
    "status": "SUCCESS"
}

エラーコード例

エラーコードのサンプルコードは次の通りです。

{
  "result": "FAIL",
  "error": {
    "errorCode": "05X000",
    "message": "この Profileの権限がないか、存在しない Profileです。",
    "moreInfo": {
      "timestamp": "2022-11-16T17:01:37.635+09:00"
    }
  }
}