instance_devices
Creates, updates, deletes, gets or lists an instance_devices resource.
Overview​
| Name | instance_devices |
| Type | Resource |
| Id | oci.compute.instance_devices |
Fields​
The following fields are returned by SELECT queries:
- list
Device Path corresponding to the block devices attached to instances having a name and isAvailable flag.
| Name | Datatype | Description |
|---|---|---|
name | string | The device name. |
isAvailable | boolean | The flag denoting whether device is available. |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list | select | instanceId, region | isAvailable, name, limit, page, opc-request-id, sortBy, sortOrder | Gets a list of all the devices for given instance. You can optionally filter results by device availability. |
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 |
|---|---|---|
instanceId | string | The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance. |
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) |
isAvailable | boolean | A filter to return only available devices or only used devices. |
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 |
name | string | A filter to return only devices that match the given name exactly. |
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). |
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. |
SELECT examples​
- list
Gets a list of all the devices for given instance. You can optionally filter results by device availability.
SELECT
name,
isAvailable
FROM oci.compute.instance_devices
WHERE instanceId = '{{ instanceId }}' -- required
AND region = '{{ region }}' -- required
AND isAvailable = '{{ isAvailable }}'
AND name = '{{ name }}'
AND limit = '{{ limit }}'
AND page = '{{ page }}'
AND opc-request-id = '{{ opc-request-id }}'
AND sortBy = '{{ sortBy }}'
AND sortOrder = '{{ sortOrder }}'
;