getRegionList

VPC環境で利用できます。

リージョンリストを照会します。

リクエスト

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

メソッド	URI
GET \| POST	/vserver/v2/getRegionList

参考

ガイドは GETメソッドを基準に説明します。POSTメソッドの呼び出しテストは、NAVERクラウドプラットフォームコンソールの API Gatewayサービスの Swaggerで行えます。

リクエストヘッダ

Server APIで共通して使用されるヘッダの詳細は、Serverのリクエストヘッダをご参照ください。

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

リクエストクエリパラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`responseFormatType`	String	Optional	レスポンスデータの形式 `xml`(デフォルト) \| `json`

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vserver/v2/getRegionList
?responseFormatType=json' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`getRegionListResponse`	Object	-	レスポンス結果 RegionListを参照
`getRegionListResponse.requestId`	String	-	リクエスト ID UUID形式
`getRegionListResponse.returnCode`	String	-	レスポンスコード
`getRegionListResponse.returnMessage`	String	-	レスポンスメッセージ

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

Server APIで共通して使用されるレスポンスステータスコードの詳細は、Serverのレスポンスステータスコードをご参照ください。

レスポンス例

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

{
  "getRegionListResponse": {
    "totalRows": 3,
    "regionList": [
      {
        "regionCode": "KR",
        "regionName": "Korea"
      },
      {
        "regionCode": "SGN",
        "regionName": "Singapore(New)"
      },
      {
        "regionCode": "JPN",
        "regionName": "Japan(New)"
      }
    ],
    "requestId": "77725bd7-****-****-****-4933305ee670",
    "returnCode": "0",
    "returnMessage": "success"
  }
}