Search subnet list
- Print
- PDF
Search subnet list
- Print
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
Can be used in a VPC environment.
Description
Search a list of available subnets.
Request
Request URL
GET https://vpcsearchengine.apigw.ntruss.com/api/v2/cluster/getSubnetList
?softwareProductCode={softwareProductCode}
&vpcNo={vpcNo} [KR]
GET https://vpcsearchengine.apigw.ntruss.com/api/sgn-v2/cluster/getSubnetList
?softwareProductCode={softwareProductCode}
&vpcNo={vpcNo} [SGN]
GET https://vpcsearchengine.apigw.ntruss.com/api/jpn-v2/cluster/getSubnetList
?softwareProductCode={softwareProductCode}
&vpcNo={vpcNo} [JPN]
Request headers
| Header | Description |
|---|---|
| x-ncp-apigw-timestamp | This is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC. If the time difference compared to the API Gateway server is more than 5 minutes, then the request is considered invalid. x-ncp-apigw-timestamp:{Timestamp} |
| x-ncp-iam-access-key | This is the Access Key ID value issued by the Naver Cloud Platform portal.x-ncp-iam-access-key:{Account Access Key} |
| x-ncp-apigw-signature-v2 | This is the signature encrypted Access Key ID value and Secret Key.x-ncp-apigw-signature-v2:{API Gateway Signature} |
| Content-Type | Specifies the request body content type as application/jsonContent-Type: application/json |
Request parameters
| Parameter | Type | Required status | Description |
|---|---|---|---|
| softwareProductCode | String | Y | This is the OS type to use. You can obtain it through the getOsProductList action. |
| vpcNo | Integer | Y | This is the VPC no. to use. You can obtain it with the getVpcList action. |
Request example
GET https://vpcsearchengine.apigw.ntruss.com/api/v2/cluster/getSubnetList
?softwareProductCode=SW.VELST.OS.LNX64.CNTOS.0708.B050
&vpcNo=1236
HOST: vpcsearchengine.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-signature-v2: zq0FrtlU8JZJi9esTK31bCQUNG3H+jo4CMjMkJDoWSc=
x-ncp-apigw-timestamp: 1593848345548
x-ncp-iam-access-key: 7fIvgFY428mtY6sY8maw
curl -X GET "https://vpcsearchengine.apigw.ntruss.com/api/v2/cluster/getSubnetList
?softwareProductCode=SW.VELST.OS.LNX64.CNTOS.0708.B050
&vpcNo=1236" \
-H "accept: application/json" \
-H "Content-Type: application/json" \
-H "x-ncp-iam-access-key: 7fIvgFY428mtY6sY8maw" \
-H "x-ncp-apigw-timestamp: 1601971222179" \
-H "x-ncp-apigw-signature-v2: zrCelnR48AADdK/uh6Xe3yy468i8KpQoewYHUmeqYh4=" \
Response parameters
public class GetSubnetListResponseVo {
ArrayList<SubnetListDetailVo> content;
}
public class SubnetListDetailVo {
String subnet;
String subnetName;
Integer subnetNo;
String vpcName;
Integer vpcNo;
String zoneName;
Integer zoneNo;
String permission;
}
Field
| Parameter Name | Type | Description |
|---|---|---|
| content | ArrayList<SubnetListDetailVo> | List of subnets |
| subnet | String | Subnet IP address range |
| subnetName | String | Subnet name |
| subnetNo | Integer | Subnet number |
| vpcName | String | VPC name |
| vpcNo | Integer | VPC no. |
| zoneName | String | zone name |
| zoneNo | Integer | zone no. |
| permission | String | This is the availability status of a Subaccount account. If it's set to Deny, it means it is not available as you have no getSubnetDetail permissions. |
Response example
{
"code": 0,
"message": "SUCCESS",
"result": {
"content": [
{
"subnet": "10.0.2.16/28",
"subnetName": "privatesmall",
"subnetNo": 22632,
"vpcName": "test",
"vpcNo": 36752,
"zoneName": "KR-1",
"zoneNo": 2,
"permission": "Allow"
},
{
"subnet": "10.0.1.0/24",
"subnetName": "testpri",
"subnetNo": 22630,
"vpcName": "test",
"vpcNo": 36752,
"zoneName": "KR-1",
"zoneNo": 2,
"permission": "Allow"
}
]
},
"requestId": "79e63e0c-9cdb-4736-89c6-8a61dab0d687"
}
Was this article helpful?