Querying the List of Subnet CIDR Reservations
Function
This API is used to query the list of subnet CIDR reservations of a tenant.
Constraints
You can query all subnet CIDR reservations under your account. A maximum of 2,000 records can be returned for each query. If the number of records exceeds 2,000, the pagination marker will be returned.
Calling Method
For details, see Calling APIs.
URI
GET /v3/{project_id}/vpc/virsubnet-cidr-reservations
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. For details about how to obtain a project ID, see Obtaining a Project ID. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
limit |
No |
Integer |
|
marker |
No |
String |
Start resource ID of pagination query. If the parameter is left blank, only resources on the first page are queried. |
id |
No |
Array of strings |
|
virsubnet_id |
No |
Array of strings |
|
cidr |
No |
Array of strings |
|
ip_version |
No |
Array of integers |
|
name |
No |
Array of strings |
|
description |
No |
Array of strings |
|
enterprise_project_id |
No |
String |
|
Request Parameters
None
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
virsubnet_cidr_reservations |
Array of VirsubnetCidrReservation objects |
Response body of the subnet CIDR reservation list. |
request_id |
String |
Request ID. |
page_info |
PageInfo object |
Pagination information. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
|
virsubnet_id |
String |
|
vpc_id |
String |
|
ip_version |
Integer |
|
cidr |
String |
|
name |
String |
|
description |
String |
|
project_id |
String |
|
created_at |
String |
|
updated_at |
String |
|
Parameter |
Type |
Description |
---|---|---|
previous_marker |
String |
Definition: The first record on the current page. Range: N/A |
current_count |
Integer |
Definition: Total number of resources on the current page. Range: N/A |
next_marker |
String |
Definition: The last record on the current page. The next_marker field does not exist if the page is the last one. Range: N/A |
Example Requests
Query the list of subnet CIDR reservations.
GET https://{Endpoint}/v3/{project_id}/vpc/virsubnet-cidr-reservations
Example Responses
Status code: 200
The GET operation is successful. For more status codes, see Status Codes.
{ "virsubnet_cidr_reservations": [ { "id": "987d7959-9c48-ad49-2fdd-bf4146d6ebc4", "virsubnet_id": "fb0e2bd6-190f-0d1a-7728-a5f6b1d8dd19", "vpc_id": "cef5d621-6c20-d5df-74e8-746271fba734", "ip_version": 4, "cidr": "192.168.21.96/28", "name": "test", "description": "for test", "project_id": "11e8dd119c77479db890e266e68c1ecf", "created_at": "2024-09-09T10:20:35Z", "updated_at": "2024-09-09T10:20:35Z", }, { "id": "ed4edb94-754c-7848-bb77-2d381906c535", "virsubnet_id": "fb0e2bd6-190f-0d1a-7728-a5f6b1d8dd19", "vpc_id": "cef5d621-6c20-d5df-74e8-746271fba734", "ip_version": 4, "cidr": "192.168.21.128/27", "name": "test2", "description": "for test", "project_id": "11e8dd119c77479db890e266e68c1ecf", "created_at": "2024-09-09T11:56:27Z", "updated_at": "2024-09-09T11:56:27Z", } ], "page_info": { "previous_marker": "987d7959-9c48-ad49-2fdd-bf4146d6ebc4", "current_count": 2 }, "request_id": "5cd6bbc22313ccb6933540d6f9302d81" }
Status Codes
Status Code |
Description |
---|---|
200 |
The GET operation is successful. For more status codes, see Status Codes. |
Error Codes
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