getCloudHadoopTargetVpcList

Prev Next

Available in VPC

Get the list of VPCs being used in Cloud Hadoop.

Request

This section describes the request format. The method and URI are as follows:

Method URI
GET | POST /vhadoop/v2/getCloudHadoopTargetVpcList
Note

This guide is based on the GET method. POST method call tests can be performed through Swagger in the API Gateway service of the NAVER Cloud Platform console.

Request headers

For information about the headers common to all Cloud Hadoop APIs, see Cloud Hadoop request headers.

Request query parameters

You can use the following query parameters with your request:

Field Type Required Description
regionCode String Optional Region code
  • Region code of the VPC to query
  • See getRegionList.
    • First Region of the query result (default)
responseFormatType String Optional Format of the response data
  • xml (default) | json

Request example

The request example is as follows:

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}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field Type Required Description
getCloudHadoopTargetVpcListResponse Object - Response result
getCloudHadoopTargetVpcListResponse.requestId String - ID for the request
  • UUID format
getCloudHadoopTargetVpcListResponse.returnCode String - Response code
getCloudHadoopTargetVpcListResponse.returnMessage String - Response message

Response status codes

For response status codes common to all Cloud Hadoop APIs, see Cloud Hadoop response status codes.

Response example

The response example is as follows:

{
    "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"
    }
}