Available in VPC
Search a list of available VPCs.
Request
This section describes the request format. The method and URI are as follows:
Method | URI |
---|---|
GET | /api/v2/cluster/getVpcList (Korea Region) |
GET | /api/sgn-v2/cluster/getVpcList (Singapore Region) |
GET | /api/jpn-v2/cluster/getVpcList (Japan Region) |
Request headers
For information about the headers common to all Search Engine Service APIs, see Search Engine Service request headers.
Request example
The request example is as follows:
curl --location --request GET 'https://vpcsearchengine.apigw.ntruss.com/api/v2/cluster/getVpcList' \
--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 |
---|---|---|---|
code |
Integer | - | Response code |
message |
String | - | Response message |
result |
Object | - | Response result |
result.content |
Array | - | VPC list |
requestId |
String | - | ID for the request
|
result.content
The following describes result.content
.
Field | Type | Required | Description |
---|---|---|---|
createdDate |
Object | - | Creation date and time |
createdDate.formattedDate |
String | - | Creation date
|
createdDate.formattedDateTime |
String | - | Creation date and time
|
createdDate.utc |
Integer | - | Creation date and time (millisecond)
|
ipv4Cidr |
String | - | VPC's IPv4 CIDR block |
regionNo |
String | - | Region number |
statusCode |
String | - | VPC status |
vpcName |
String | - | VPC name |
vpcNo |
Integer | - | VPC number |
permission |
String | - | Sub account availability
|
Response status codes
For response status codes common to all Search Engine Service APIs, see Search Engine Service response status codes.
Response example
The response example is as follows:
{
"code": 0,
"message": "SUCCESS",
"result": {
"content": [
{
"createdDate": {
"formattedDate": "2025-02-18",
"formattedDateTime": "2025-02-18 11:22:39 000936",
"utc": 1739845359936
},
"ipv4Cidr": "10.0.0.0/16",
"regionNo": "1",
"statusCode": "RUN",
"vpcName": "myvpc",
"vpcNo": 9****,
"permission": "Allow"
}
]
},
"requestId": "52bd6303-****-****-****-4e97b5af00f7"
}