maintenance_run_history
Creates, updates, deletes, gets or lists a maintenance_run_history resource.
Overview​
| Name | maintenance_run_history |
| Type | Resource |
| Id | oci.database.maintenance_run_history |
Fields​
The following fields are returned by SELECT queries:
- list
Details of a maintenance run history.
| Name | Datatype | Description |
|---|---|---|
id | string | The OCID of the maintenance run history. |
dbServersHistoryDetails | array | List of database server history details. |
granularMaintenanceHistory | array | The list of granular maintenance history details. |
maintenanceRunDetails | object | Details of a maintenance run. |
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). |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list | select | compartmentId, region | targetResourceId, targetResourceType, maintenanceType, limit, page, sortBy, sortOrder, lifecycleState, availabilityDomain, maintenanceSubtype | Gets a list of the maintenance run histories in the specified 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 compartment [OCID](/Content/General/Concepts/identifiers.htm). |
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) |
availabilityDomain | string | A filter to return only resources that match the given availability domain exactly. |
lifecycleState | string | The state of the maintenance run history. |
limit | integer | The maximum number of items to return per page. |
maintenanceSubtype | string | The sub-type of the maintenance run. |
maintenanceType | string | The maintenance type. |
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 TIME_SCHEDULED and TIME_ENDED 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). |
targetResourceId | string | The target resource ID. |
targetResourceType | string | The type of the target resource. |
SELECT examples​
- list
Gets a list of the maintenance run histories in the specified compartment.<br />
SELECT
id,
dbServersHistoryDetails,
granularMaintenanceHistory,
maintenanceRunDetails,
systemTags
FROM oci.database.maintenance_run_history
WHERE compartmentId = '{{ compartmentId }}' -- required
AND region = '{{ region }}' -- required
AND targetResourceId = '{{ targetResourceId }}'
AND targetResourceType = '{{ targetResourceType }}'
AND maintenanceType = '{{ maintenanceType }}'
AND limit = '{{ limit }}'
AND page = '{{ page }}'
AND sortBy = '{{ sortBy }}'
AND sortOrder = '{{ sortOrder }}'
AND lifecycleState = '{{ lifecycleState }}'
AND availabilityDomain = '{{ availabilityDomain }}'
AND maintenanceSubtype = '{{ maintenanceSubtype }}'
;