byoip_allocated_ranges
Creates, updates, deletes, gets or lists a byoip_allocated_ranges resource.
Overview​
| Name | byoip_allocated_ranges |
| Type | Resource |
| Id | oci.network.byoip_allocated_ranges |
Fields​
The following fields are returned by SELECT queries:
- list
The list is being retrieved.
| Name | Datatype | Description |
|---|---|---|
cidrBlock | string | The BYOIP CIDR block range or subrange allocated to an IP pool. This could be all or part of a BYOIP CIDR block. |
publicIpPoolId | string | The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IP pool containing the CIDR block. |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list | select | byoipRangeId, region | opc-request-id, limit, page | Lists the subranges of a BYOIP CIDR block currently allocated to an IP pool.<br />Each ByoipAllocatedRange object also lists the IP pool where it is allocated.<br /> |
Parameters​
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
byoipRangeId | string | The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the ByoipRange resource containing the BYOIP CIDR block. |
region | string | OCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. (default: us-ashburn-1, x-stackQL-envVar: OCI_REGION) |
limit | integer | 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](/iaas/Content/API/Concepts/usingapi.htm#nine). Example: 50 |
opc-request-id | string | Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
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](/iaas/Content/API/Concepts/usingapi.htm#nine). |
SELECT examples​
- list
Lists the subranges of a BYOIP CIDR block currently allocated to an IP pool.<br />Each ByoipAllocatedRange object also lists the IP pool where it is allocated.<br />
SELECT
cidrBlock,
publicIpPoolId
FROM oci.network.byoip_allocated_ranges
WHERE byoipRangeId = '{{ byoipRangeId }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
AND limit = '{{ limit }}'
AND page = '{{ page }}'
;