Querying Common Pools
Function
This API is used to query common pools.
URI
GET /v3/{project_id}/eip/publicip-pools/common-pools
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String |
Minimum length: 0 Maximum length: 32 |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| fields | No | String |
Minimum length: 0 Maximum length: 1024 |
| name | No | String |
Minimum length: 0 Maximum length: 36 |
| public_border_group | No | String |
Minimum length: 0 Maximum length: 64 |
Request Parameter
None
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| common_pools | Array of CommonPoolDict objects | Common pool. |
| request_id | String | Request ID. |
| Parameter | Type | Description |
|---|---|---|
| name | String |
Minimum length: 0 Maximum length: 36 |
| status | String |
Minimum length: 0 Maximum length: 36 |
| type | String |
Minimum length: 0 Maximum length: 36 |
| used | Integer |
Minimum value: 0 Maximum value: 99999 |
| public_border_group | String |
Minimum length: 1 Maximum length: 64 |
| id | String |
Minimum length: 0 Maximum length: 36 |
| allow_share_bandwidth_types | Array of strings |
Maximum length: 64 |
Example Request
None
Example Response
Status code: 200
Normal response to the GET operation
{
"common_pools" : [ {
"name" : "5_bgp",
"status" : "active",
"type" : "bgp",
"used" : 99,
"public_border_group" : "center",
"allow_share_bandwidth_types" : [ "share" ]
} ],
"request_id" : "4a06c169-cc67-4d94-a786-2d70ef09b100"
} Status Codes
See Status Codes.
Error Codes
See Error Codes.