Querying VPCs
Function
This API is used to query VPCs using search criteria and to display the VPCs in a list.
URI
GET /v1/{project_id}/vpcs
GET https://{Endpoint}/v1/{project_id}/vpcs?limit=10&marker=13551d6b-755d-4757-b956-536f674975c0
Name |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Specifies the project ID. For details about how to obtain a project ID, see Obtaining a Project ID. |
marker |
No |
String |
Specifies the start resource ID of pagination query. If the parameter is left blank, only resources on the first page are queried. |
limit |
No |
Integer |
|
Response Message
- Response parameter
Table 2 Response parameter Name
Type
Description
vpcs
Array of vpcs objects
Specifies the VPC objects.
Table 3 Description of the vpcs field Name
Type
Description
id
String
Specifies a resource ID in UUID format.
name
String
- Specifies the VPC name.
- The value is a string of no more than 64 characters that can contain letters, digits, underscores (_), hyphens (-), and periods (.).
- Each VPC name of a tenant must be unique if the VPC name is not left blank.
description
String
- Provides supplementary information about the VPC.
- The value is a string of no more than 255 characters and cannot contain angle brackets (< or >).
cidr
String
- Specifies the available IP address ranges for subnets in the VPC.
- Possible values are as follows:
- 10.0.0.0/8~24
- 172.16.0.0/12~24
- 192.168.0.0/16~24
- If cidr is not specified, the default value is left blank.
- The value must be in CIDR format, for example, 192.168.0.0/16.
status
String
- Specifies the VPC status.
- Possible values are as follows:
- CREATING: The VPC is being created.
- OK: The VPC is created successfully.
- Example response
{ "vpcs": [ { "id": "13551d6b-755d-4757-b956-536f674975c0", "name": "default", "description": "test", "cidr": "172.16.0.0/16", "status": "OK" }, { "id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85", "name": "222", "description": "test", "cidr": "192.168.0.0/16", "status": "OK" }, { "id": "99d9d709-8478-4b46-9f3f-2206b1023fd3", "name": "vpc", "description": "test", "cidr": "192.168.0.0/16", "status": "OK" } ] }
Status Code
See Status Codes.
Error Code
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot