ListPublicIpPools
GET {{baseUrl}}/publicIpPools?limit=801&sortBy=TIMECREATED&sortOrder=DESC&compartmentId={{compartment_ocid}}
Lists the public IP pools in the specified compartment. You can filter the list using query parameters.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
limit | number | For list pagination. The maximum number of results per page, or items to return in a paginated | |
"List" call. For important details about how pagination works, see | |||
List Pagination. |
Example: 50
|
| page
| string | | For list pagination. The value of the opc-next-page
response header from the previous "List"
call. For important details about how pagination works, see
List Pagination.
|
| displayName
| string | | A filter to return only resources that match the given display name exactly.
|
| byoipRangeId
| string | | A filter to return only resources that match the given BYOIP CIDR block.
|
| sortBy
| string | | The field to sort by. You can provide one sort order (sortOrder
). Default order for
TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME
sort order is case sensitive.
Note: In general, some "List" operations (for example, ListInstances
) let you
optionally filter by availability domain if the scope of the resource type is within a
single availability domain. If you call one of these "List" operations without specifying
an availability domain, the resources are grouped by availability domain, then sorted.
|
| sortOrder
| string | | The sort order to use, either ascending (ASC
) or descending (DESC
). The DISPLAYNAME sort order
is case sensitive.
|
| compartmentId
| string | | (Required) The OCID of the compartment. |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
opc-request-id | string | Unique identifier for the request. | |
If you need to contact Oracle about a particular request, please provide the request ID. | |||
Date | string | (Required) Current Date | |
Authorization | string | (Required) Signature Authentication on Authorization header |
RESPONSES
status: OK
{"items":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}]}