autonomous_container_database_backups
Creates, updates, deletes, gets or lists an autonomous_container_database_backups resource.
Overview​
| Name | autonomous_container_database_backups |
| Type | Resource |
| Id | oci.database.autonomous_container_database_backups |
Fields​
The following fields are returned by SELECT queries:
- list
A list of all of the Autonomous Container Database Backups in the specified compartment.
| Name | Datatype | Description |
|---|---|---|
id | string | The [OCID](/Content/General/Concepts/identifiers.htm) of the Autonomous AI Database backup. |
acdDisplayName | string | The user-friendly name for the Autonomous Container Database when the Backup was initiated. This name need not be unique. This field captures the name at the time of backup creation, accounting for possible later updates to the display name. |
autonomousContainerDatabaseId | string | The [OCID](/Content/General/Concepts/identifiers.htm) of the Autonomous Container Database. |
autonomousDatabases | array | List of Autonomous AI Databases that is part of this Autonomous Container Database Backup |
compartmentId | string | The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. |
definedTags | object | Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). |
displayName | string | A user-friendly name for the backup. This name need not be unique. |
freeformTags | object | Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} |
infrastructureType | string | The infrastructure type this resource belongs to. (CLOUD, CLOUD_AT_CUSTOMER) |
isAutomatic | boolean | Indicates whether the backup is user-initiated or automatic. |
isRemoteBackup | boolean | Whether backup is for remote-region or local region |
lifecycleDetails | string | Additional information about the current lifecycle state. |
lifecycleState | string | The current state of the backup. (CREATING, ACTIVE, DELETING, DELETED, FAILED) |
retentionPeriodInDays | integer | Retention period, in days, for long-term backups |
systemTags | object | System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). |
timeEnded | string (date-time) | The date and time the backup completed. |
timeStarted | string (date-time) | The date and time the backup started. |
type | string | The type of backup. (INCREMENTAL, FULL) |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list | select | region | compartmentId, autonomousContainerDatabaseId, isRemote, infrastructureType, lifecycleState, sortBy, opc-request-id, limit, page, sortOrder, displayName | Gets a list of Autonomous Container Database backups by using either the 'autonomousDatabaseId' or 'compartmentId' as your query parameter.<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 |
|---|---|---|
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) |
autonomousContainerDatabaseId | string | The Autonomous Container Database [OCID](/Content/General/Concepts/identifiers.htm). |
compartmentId | string | The compartment [OCID](/Content/General/Concepts/identifiers.htm). |
displayName | string | A filter to return only resources that match the entire display name given. The match is not case sensitive. |
infrastructureType | string | A filter to return only resources that match the given Infrastructure Type. |
isRemote | boolean | call for all remote backups |
lifecycleState | string | A filter to return only resources that match the given lifecycle state exactly. |
limit | integer | The maximum number of items to return per page. |
opc-request-id | string | Unique identifier for the request. |
page | string | The pagination token to continue listing from. |
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: If you do not include the availability domain filter, the resources are grouped by availability domain, then sorted. |
sortOrder | string | The sort order to use, either ascending (ASC) or descending (DESC). |
SELECT examples​
- list
Gets a list of Autonomous Container Database backups by using either the 'autonomousDatabaseId' or 'compartmentId' as your query parameter.<br />
SELECT
id,
acdDisplayName,
autonomousContainerDatabaseId,
autonomousDatabases,
compartmentId,
definedTags,
displayName,
freeformTags,
infrastructureType,
isAutomatic,
isRemoteBackup,
lifecycleDetails,
lifecycleState,
retentionPeriodInDays,
systemTags,
timeEnded,
timeStarted,
type
FROM oci.database.autonomous_container_database_backups
WHERE region = '{{ region }}' -- required
AND compartmentId = '{{ compartmentId }}'
AND autonomousContainerDatabaseId = '{{ autonomousContainerDatabaseId }}'
AND isRemote = '{{ isRemote }}'
AND infrastructureType = '{{ infrastructureType }}'
AND lifecycleState = '{{ lifecycleState }}'
AND sortBy = '{{ sortBy }}'
AND opc-request-id = '{{ opc-request-id }}'
AND limit = '{{ limit }}'
AND page = '{{ page }}'
AND sortOrder = '{{ sortOrder }}'
AND displayName = '{{ displayName }}'
;