ListMaintenanceRuns
GET {{baseUrl}}/maintenanceRuns?compartmentId=<string>&targetResourceId=<string>&targetResourceType=<string>&maintenanceType=<string>&limit=10&page=<string>&sortBy=TIME_ENDED&sortOrder=ASC&lifecycleState=<string>&availabilityDomain=<string>&maintenanceSubtype=<string>
Gets a list of the maintenance runs in the specified compartment.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
compartmentId | string | (Required) The compartment OCID. | |
targetResourceId | string | The target resource ID. | |
targetResourceType | string | The type of the target resource. | |
maintenanceType | string | The maintenance type. | |
limit | number | The maximum number of items to return per page. | |
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). |
| lifecycleState | string | | A filter to return only resources that match the given lifecycle state exactly. |
| availabilityDomain | string | | A filter to return only resources that match the given availability domain exactly. |
| maintenanceSubtype | string | | The sub-type of the maintenance run. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
[{"id":"\u003cstring\u003e","compartmentId":"\u003cstring\u003e","displayName":"\u003cstring\u003e","lifecycleState":"CANCELED","timeScheduled":"\u003cdateTime\u003e","currentCustomActionTimeoutInMins":"\u003cinteger\u003e","currentPatchingComponent":"\u003cstring\u003e","customActionTimeoutInMins":"\u003cinteger\u003e","description":"\u003cstring\u003e","estimatedComponentPatchingStartTime":"\u003cdateTime\u003e","estimatedPatchingTime":{"estimatedDbServerPatchingTime":"\u003cinteger\u003e","estimatedNetworkSwitchesPatchingTime":"\u003cinteger\u003e","estimatedStorageServerPatchingTime":"\u003cinteger\u003e","totalEstimatedPatchingTime":"\u003cinteger\u003e"},"isCustomActionTimeoutEnabled":"\u003cboolean\u003e","isDstFileUpdateEnabled":"\u003cboolean\u003e","lifecycleDetails":"\u003cstring\u003e","maintenanceSubtype":"DATABASE","maintenanceType":"PLANNED","patchFailureCount":"\u003cinteger\u003e","patchId":"\u003cstring\u003e","patchingEndTime":"\u003cdateTime\u003e","patchingMode":"NONROLLING","patchingStartTime":"\u003cdateTime\u003e","patchingStatus":"PATCHING","peerMaintenanceRunId":"\u003cstring\u003e","targetDbServerVersion":"\u003cstring\u003e","targetResourceId":"\u003cstring\u003e","targetResourceType":"CLOUD_EXADATA_INFRASTRUCTURE","targetStorageServerVersion":"\u003cstring\u003e","timeEnded":"\u003cdateTime\u003e","timeStarted":"\u003cdateTime\u003e"},{"id":"\u003cstring\u003e","compartmentId":"\u003cstring\u003e","displayName":"\u003cstring\u003e","lifecycleState":"SCHEDULED","timeScheduled":"\u003cdateTime\u003e","currentCustomActionTimeoutInMins":"\u003cinteger\u003e","currentPatchingComponent":"\u003cstring\u003e","customActionTimeoutInMins":"\u003cinteger\u003e","description":"\u003cstring\u003e","estimatedComponentPatchingStartTime":"\u003cdateTime\u003e","estimatedPatchingTime":{"estimatedDbServerPatchingTime":"\u003cinteger\u003e","estimatedNetworkSwitchesPatchingTime":"\u003cinteger\u003e","estimatedStorageServerPatchingTime":"\u003cinteger\u003e","totalEstimatedPatchingTime":"\u003cinteger\u003e"},"isCustomActionTimeoutEnabled":"\u003cboolean\u003e","isDstFileUpdateEnabled":"\u003cboolean\u003e","lifecycleDetails":"\u003cstring\u003e","maintenanceSubtype":"QUARTERLY","maintenanceType":"UNPLANNED","patchFailureCount":"\u003cinteger\u003e","patchId":"\u003cstring\u003e","patchingEndTime":"\u003cdateTime\u003e","patchingMode":"NONROLLING","patchingStartTime":"\u003cdateTime\u003e","patchingStatus":"SCHEDULED","peerMaintenanceRunId":"\u003cstring\u003e","targetDbServerVersion":"\u003cstring\u003e","targetResourceId":"\u003cstring\u003e","targetResourceType":"AUTONOMOUS_EXADATA_INFRASTRUCTURE","targetStorageServerVersion":"\u003cstring\u003e","timeEnded":"\u003cdateTime\u003e","timeStarted":"\u003cdateTime\u003e"}]