virtual_circuit_bandwidth_shapes
Creates, updates, deletes, gets or lists a virtual_circuit_bandwidth_shapes resource.
Overview​
| Name | virtual_circuit_bandwidth_shapes |
| Type | Resource |
| Id | oci.network.virtual_circuit_bandwidth_shapes |
Fields​
The following fields are returned by SELECT queries:
- list
An individual bandwidth level for virtual circuits.<br />
| Name | Datatype | Description |
|---|---|---|
name | string | The name of the bandwidth shape. Example: 10 Gbps |
bandwidthInMbps | integer | The bandwidth in Mbps. Example: 10000 |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list | select | compartmentId, region | limit, page | The operation lists available bandwidth levels for virtual circuits. For the compartment ID, provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of your tenancy (the root compartment).<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 |
|---|---|---|
compartmentId | string | The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. |
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 |
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
The operation lists available bandwidth levels for virtual circuits. For the compartment ID, provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of your tenancy (the root compartment).<br />
SELECT
name,
bandwidthInMbps
FROM oci.network.virtual_circuit_bandwidth_shapes
WHERE compartmentId = '{{ compartmentId }}' -- required
AND region = '{{ region }}' -- required
AND limit = '{{ limit }}'
AND page = '{{ page }}'
;