getVpcList
- Print
- PDF
getVpcList
- Print
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
Can be used in a VPC environment.
Overview
This searches for a VPC list.
Request
Request parameters
| Parameter name | Required | Type | Restrictions | Description |
|---|---|---|---|---|
| regionCode | No | String | Region code You can decide the region in which the VPC list will be queried. regionCode can be obtained through the getRegionList action. Default: Select the first region of the getRegionList search results | |
| vpcStatusCode | No | String | VPC status code You can search by filtering with a VPC status code. Options : INIT | CREATING | RUN | TERMTING | |
| vpcName | No | String | VPC name You can search by filtering with a VPC name. | |
| vpcNoList.N | No | List<String> | VPC number list You can search by filtering with a VPC number. vpcNo can be obtained through the getVpcList action. ex) vpcNoList.1=1234&vpcNoList.2=2345 | |
| responseFormatType | No | String | Format type of the response results Options : xml | json Default : xml |
Response
Response body
Example
Request Example
GET {API_URL}/vpc/v2/getVpcList
?regionCode=KR
&vpcStatusCode=RUN
&vpcName=test-***
&vpcNoList.1=***04
Response Example
<getVpcListResponse>
<requestId>9b37ea3e-3ca9-462f-abad-6e23a35fcb76</requestId>
<returnCode>0</returnCode>
<returnMessage>success</returnMessage>
<totalRows>1</totalRows>
<vpcList>
<vpc>
<vpcNo>***04</vpcNo>
<vpcName>test-***</vpcName>
<ipv4CidrBlock>***.***.0.0/16</ipv4CidrBlock>
<vpcStatus>
<code>RUN</code>
<codeName>run</codeName>
</vpcStatus>
<regionCode>KR</regionCode>
<createDate>2020-07-16T22:23:50+0900</createDate>
</vpc>
</vpcList>
</getVpcListResponse>
Was this article helpful?