Search subnet list
- Print
- PDF
Search subnet list
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Can be used in a VPC environment.
Description
Search a list of available subnets.
Request
Request URL
POST https://clouddatastreamingservice.apigw.ntruss.com/api/v1/cluster/getSubnetList [KR]
POST https://clouddatastreamingservice.apigw.ntruss.com/api/sgn-v1/cluster/getSubnetList [SGN]
POST https://clouddatastreamingservice.apigw.ntruss.com/api/jpn-v1/cluster/getSubnetList [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.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 number to use. You can obtain it through the getVpcList action. |
Request example
POST https://clouddatastreamingservice.apigw.ntruss.com/api/v1/cluster/getSubnetList
HOST: clouddatastreamingservice.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
{
"softwareProductCode": "SW.VELST.OS.LNX64.CNTOS.0703.B050",
"vpcNo": 36752
}
curl -X POST "https://clouddatastreamingservice.apigw.ntruss.com/api/v1/cluster/getSubnetList" \
-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=" \
-d \
'{
"softwareProductCode": "SW.VELST.OS.LNX64.CNTOS.0703.B050",
"vpcNo": 36752
}'
Response parameters
public class GetSubnetListResponseVo {
ArrayList<SubnetListDetailVo> content;
}
public class SubnetListDetailVo {
Boolean isPublic;
String subnet;
String subnetName;
Integer subnetNo;
String vpcName;
Integer vpcNo;
String zoneName;
Integer zoneNo;
String permission;
}
Field
| Parameter name | Type | Description |
|---|---|---|
| content | ArrayList | List of subnets |
| isPublic | Boolean | Public subnet status |
| subnet | String | Subnet IP address range |
| 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 | This is the availability status of a Subaccount's account. If it's set to Deny, it means that it is not available since you have no getSubnetDetail permissions. |
Response example
{
"code": 0,
"message": "SUCCESS",
"result": {
"error": null,
"content": [{
"isPublic": false,
"subnet": "10.0.2.0/24",
"subnetName": "clean-private2",
"subnetNo": 1507,
"vpcName": "clean",
"vpcNo": 1236,
"zoneName": "KR-2",
"zoneNo": 3,
"actionName": "View/getSubnetDetail",
"permission": "Allow"
}, {
"isPublic": false,
"subnet": "10.0.1.0/24",
"subnetName": "clean-private",
"subnetNo": 1301,
"vpcName": "clean",
"vpcNo": 1236,
"zoneName": "KR-1",
"zoneNo": 2,
"actionName": "View/getSubnetDetail",
"permission": "Allow"
}, {
"isPublic": true,
"subnet": "10.0.0.0/24",
"subnetName": "clean-pub",
"subnetNo": 1300,
"vpcName": "clean",
"vpcNo": 1236,
"zoneName": "KR-1",
"zoneNo": 2,
"actionName": "View/getSubnetDetail",
"permission": "Allow"
}]
},
"requestId": "2fc8b391-fcb8-4280-aae2-a88571b842e4"
}
Was this article helpful?