Geo and CIDR Mapの詳細照会

Prev Next

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

指定した Geo/CIDR Mapの詳細情報を照会します。

リクエスト

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

メソッド URI
GET /maps/{mapId}

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
mapId Integer Required Geo/CIDR Map ID

リクエスト例

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

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

レスポンス

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

レスポンスボディ

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

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

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

レスポンス例

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

{
    "id": ***,
    "name": "map000",
    "mapType": "GEO",
    "detailedMapList": [
        {
            "id": ***,
            "name": "zone",
            "content": "Afghanistan",
            "geoIdMappings": [
                {
                    "geoName": "Afghanistan",
                    "geoType": "NATION"
                }
            ]
        },
        {
            "id": *,
            "name": "ETC",
            "content": "All countries not defined at the top",
            "geoIdMappings": null
        }
    ],
    "defaultYn": false,
    "createdDate": 1716798589,
    "modifiedDate": 1716798589
}

エラーコード例

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

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