Available in VPC
Get the list of available subnets.
Note
This is a dedicated API for third-generation servers of the KVM hypervisor type.
Request
This section describes the request format. The method and URI are as follows:
Method | URI |
---|---|
POST | /api/v2/cluster/getVpcAvailableSubnetList (Korea Region) |
POST | /api/sgn-v2/cluster/getVpcAvailableSubnetList (Singapore Region) |
POST | /api/jpn-v2/cluster/getVpcAvailableSubnetList (Japan Region) |
Request headers
For information about the headers common to all Search Engine Service APIs, see Search Engine Service request headers.
Request body
You can include the following data in the body of your request:
Field | Type | Required | Description |
---|---|---|---|
isPrivate |
Boolean | Optional | Whether it is a private subnet
|
softwareProductCode |
String | Required | Operating system type code |
vpcNo |
Integer | Required | VPC number
|
Request example
The request example is as follows:
curl --location --request POST 'https://vpcsearchengine.apigw.ntruss.com/api/v2/cluster/getVpcAvailableSubnetList' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '{
"softwareProductCode": "SW.VELST.OS.LNX64.ROCKY.08.G003",
"vpcNo": 4***
}'
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 | - | Subnet list |
requestId |
String | - | ID for the request
|
result.content
The following describes result.content
.
Field | Type | Required | Description |
---|---|---|---|
isPublic |
Boolean | - | Whether it is a public subnet
|
statusCode |
String | - | Subnet status |
subnet |
String | - | Subnet's IPv4 CIDR block |
subnetName |
String | - | Subnet name |
subnetNo |
Integer | - | Subnet number |
vpcName |
String | - | VPC name |
vpcNo |
Integer | - | VPC number |
zoneName |
String | - | Zone name |
zoneNo |
Integer | - | Zone 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": [
{
"isPublic": false,
"statusCode": "RUN",
"subnet": "10.0.20.0/24",
"subnetName": "sb2",
"subnetNo": 33***,
"vpcName": "test-vpc2",
"vpcNo": 4***,
"zoneName": "KR-2",
"zoneNo": 3,
"permission": "Allow"
},
{
"isPublic": true,
"statusCode": "RUN",
"subnet": "10.0.10.0/24",
"subnetName": "sb1",
"subnetNo": 30***,
"vpcName": "test-vpc2",
"vpcNo": 4***,
"zoneName": "KR-2",
"zoneNo": 3,
"permission": "Allow"
}
]
},
"requestId": "bc49929e-****-****-****-edb2ad24f312"
}