Search VPC list
- Print
- PDF
Search VPC list
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Available in VPC
Description
Search a list of available VPCs.
Request
Request URL
GET https://vpcsearchengine.apigw.ntruss.com/api/v2/cluster/getVpcList [KR]
GET https://vpcsearchengine.apigw.ntruss.com/api/sgn-v2/cluster/getVpcList [SGN]
GET https://vpcsearchengine.apigw.ntruss.com/api/jpn-v2/cluster/getVpcList [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 example
GET https://vpcsearchengine.apigw.ntruss.com/api/v2/cluster/getVpcList
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/getVpcList" \
-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 GetVpcListResponseVo {
ArrayList<VpcListDetailVo> content;
}
public class VpcListDetailVo {
DateTimeVo createdDate;
String ipv4Cidr;
String regionNo;
String statusCode;
String vpcName;
Integer vpcNo;
String permission;
}
public class DateTimeVo {
@JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd", timezone = "Asia/Seoul")
Date formattedDate;
@JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd HH:mm:ss SSSSSS", timezone = "Asia/Seoul")
Date formattedDateTime;
Long utc;
}
Field
| Parameter Name | Type | Description |
|---|---|---|
| content | ArrayList<SubnetListDetailVo> | List of VPCs |
| createdDate | DateTimeVo | Created date |
| ipv4Cidr | String | VPC range |
| regionNo | String | NCP region no. |
| statusCode | String | VPC status code |
| vpcName | String | VPC name |
| vpcNo | Integer | VPC no. |
| permission | String | This is the availability status of a Subaccount account. If it's set to Deny, then it means it is not available since you have no getVPCDetail permissions. |
| formattedDate | Date | Creation date |
| formattedDateTime | Date | Creation date and time |
| utc | Long | Convert the UTC time created into milliseconds |
Response example
{
"code": 0,
"message": "SUCCESS",
"result": {
"content": [
{
"createdDate": {
"formattedDate": "2020-06-22",
"formattedDateTime": "2020-06-22 10:18:24 000686",
"utc": 1592788704686
},
"ipv4Cidr": "10.0.0.0/20",
"regionNo": "1",
"statusCode": "RUN",
"vpcName": "test",
"vpcNo": 36752,
"permission": "Allow"
}
]
},
"requestId": "73cb1de6-c3e1-4a9d-9215-470158dd199f"
}
Was this article helpful?