getCloudHadoopTargetVpcList

VPC環境で利用できます。

Cloud Hadoopで使用中の VPCリストを照会します。

リクエスト

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

メソッド	URI
GET \| POST	/vhadoop/v2/getCloudHadoopTargetVpcList

参考

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

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`regionCode`	String	Optional	リージョンコード照会対象の VPCのリージョンコード getRegionListを参照照会結果の最初のリージョン(デフォルト)
`responseFormatType`	String	Optional	レスポンスデータの形式 `xml`(デフォルト) \| `json`

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vhadoop/v2/getCloudHadoopTargetVpcList?regionCode=KR&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}'

レスポンス

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

レスポンスボディ

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

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

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

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

レスポンス例

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

{
    "getCloudHadoopTargetVpcListResponse": {
        "totalRows": 1,
        "targetVpcList": [
            {
                "vpcNo": "9****",
                "vpcName": "vpc4hadoop",
                "ipv4Cidr": "**.**.**.**/**",
                "regionCode": "KR",
                "createdDate": "2025-02-18T11:22:39+0900"
            }
        ],
        "requestId": "8740f6f8-****-****-****-c083e05de339",
        "returnCode": "0",
        "returnMessage": "success"
    }
}