getVpcList
- Print
- PDF
getVpcList
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Available in VPC
View the list of VPCs based on the conditions the user specifies.Request
The following describes the request format for the endpoint. The request format is as follows:
| Method | URI |
|---|---|
| GET, POST | /getVpcList |
Request headers
For headers common to all VPC APIs, see VPC common headers.
Request query parameters
The following describes the parameters.
| Field | Type | Required | Description |
|---|---|---|---|
regionCode | String | Optional | Region code whose network VPC list you want to view |
vpcStatusCode | String | Optional | View the VPC list with the VPC status code
|
vpcName | String | Optional | View the VPC list with the VPC name |
vpcNoList.N | List<String> | Optional | View the VPC list with the VPC numbervpcNo can be obtained through getVpcList |
responseFormatType | String | Optional | Response result format
|
Request example
The following is a sample request.
curl --location 'https://ncloud.apigw.ntruss.com/vpc/v2/getVpcList
?regionCode=KR
&vpcStatusCode=RUN
&vpcName=test-***
&vpcNoList.1=***04
&responseFormatType=xml'
--header 'x-ncp-apigw-timestamp:: {Timestamp}'
--header 'x-ncp-iam-access-key: {Access Key}'
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
Response
The following describes the response format.
Response body
See VpcList for the response body.
Response status codes
For response status codes common to NAVER Cloud Platform, see Ncloud API response status codes.
Response example
The following is a sample response.
<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?