volume_backup_policy_asset_assignments
Creates, updates, deletes, gets or lists a volume_backup_policy_asset_assignments resource.
Overview​
| Name | volume_backup_policy_asset_assignments |
| Type | Resource |
| Id | oci.block_storage.volume_backup_policy_asset_assignments |
Fields​
The following fields are returned by SELECT queries:
- get
Specifies the volume that the volume backup policy is assigned to.<br /><br />For more information about Oracle defined backup policies and custom backup policies,<br />see [Policy-Based Backups](/iaas/Content/Block/Tasks/schedulingvolumebackups.htm).<br />
| Name | Datatype | Description |
|---|---|---|
id | string | The OCID of the volume backup policy assignment. |
assetId | string | The OCID of the volume the policy has been assigned to. |
policyId | string | The OCID of the volume backup policy that has been assigned to the volume. |
timeCreated | string (date-time) | The date and time the volume backup policy was assigned to the volume. The format is defined by [RFC3339](https:​//tools.ietf.org/html/rfc3339). |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | assetId, region | limit, page | Gets the volume backup policy assignment for the specified volume. The<br />assetId query parameter is required, and the returned list will contain at most<br />one item, since volume can only have one volume backup policy assigned at a time.<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 |
|---|---|---|
assetId | string | The OCID of an asset (e.g. a volume). |
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​
- get
Gets the volume backup policy assignment for the specified volume. The<br />assetId query parameter is required, and the returned list will contain at most<br />one item, since volume can only have one volume backup policy assigned at a time.<br />
SELECT
id,
assetId,
policyId,
timeCreated
FROM oci.block_storage.volume_backup_policy_asset_assignments
WHERE assetId = '{{ assetId }}' -- required
AND region = '{{ region }}' -- required
AND limit = '{{ limit }}'
AND page = '{{ page }}'
;