openapi: 3.2.0
info:
description: "Use the Full Stack Disaster Recovery (DR) API to manage disaster recovery for business applications.\nFull Stack DR is an OCI disaster recovery orchestration and management service that provides comprehensive disaster \nrecovery capabilities for all layers of an application stack, including infrastructure, middleware, database, \nand application.\n"
title: Full Stack Disaster Recovery API
version: '20220125'
x-provenance:
method: harvested
first_party: true
publisher: Oracle
source: https://docs.oracle.com/en-us/iaas/api/specs/1ded494ac548eb031485a9ea3998c83e08ab0923e3ac8e6afa8a6e890fc34c21.yaml
harvested: '2026-08-04'
note: Published by Oracle as the contract for the Full Stack Disaster Recovery API OCI service and stored verbatim; API Evangelist added only this provenance block.
x-evidence:
- url: https://docs.oracle.com/en-us/iaas/api/specs/index.json
what: Oracle's own index of every OCI service specification
- url: https://docs.oracle.com/en-us/iaas/api/specs/1ded494ac548eb031485a9ea3998c83e08ab0923e3ac8e6afa8a6e890fc34c21.yaml
what: the harvested document for Full Stack Disaster Recovery API
servers:
- url: http://127.0.0.1/20220125
- url: https://127.0.0.1/20220125
tags:
- name: disasterRecovery
paths:
/automaticDrConfigurations:
get:
description: Get a summary list of automatic DR configurations for a DR protection group.
operationId: ListAutomaticDrConfigurations
parameters:
- $ref: '#/components/parameters/DrProtectionGroupIdMandatoryQueryParam'
- $ref: '#/components/parameters/AutomaticDrConfigurationIdQueryParam'
- $ref: '#/components/parameters/AutomaticDrConfigurationLifecycleStateQueryParam'
- $ref: '#/components/parameters/AutomaticDrConfigurationLifecycleStateNotEqualToQueryParam'
- $ref: '#/components/parameters/DisplayNameQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/SortByQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: A list of Automatic DR configuration summaries.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then a partial list might have been returned. Include this value as the `page` parameter for the
subsequent GET request to get the next batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/AutomaticDrConfigurationCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: List Automatic DR configurations.
tags:
- disasterRecovery
x-example: 'Example 1: List Automatic DR configurations by DR protection group ID
GET /20220125/automaticDrConfigurations?drProtectionGroupId=<drProtectionGroup_uniqueID>
Host: iaas.us-ashburn-1.oraclecloud.com
<authorization and other headers>
Example 2: List Automatic DR configurations by DR protection group ID and Automatic DR configuration ID
GET /20220125/automaticDrConfigurations?drProtectionGroupId=<drProtectionGroup_uniqueID>&automaticDrConfigurationId=<automaticDrConfiguration_uniqueID>
Host: iaas.us-ashburn-1.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/AutomaticDrConfiguration'
post:
description: Create a Automatic DR configuration.
operationId: CreateAutomaticDrConfiguration
parameters:
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
201:
description: The Automatic DR configuration is being created.
headers:
etag:
description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
'
schema:
type: string
location:
description: A URI for the new resource which was created by the request.
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier (OCID) for the asynchronous request. You can use this to query status of the asynchronous operation. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/AutomaticDrConfiguration'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Create a Automatic DR configuration.
tags:
- disasterRecovery
x-example: "POST /20220125/automaticDrConfigurations\nHost: iaas.us-ashburn-1.oraclecloud.com\n<authorization and other headers>\n{\n \"drProtectionGroupId\": \"ocid1.drprotectiongroup.oc1..uniqueID\",\n \"displayName\": \"Switchover From IAD To PHX\",\n \"members\": [\n {\n \"memberId\": \"ocid1.autonomousdatabase.oc1..uniqueID\",\n \"memberType\": \"AUTONOMOUS_DATABASE\",\n \"isAutoSwitchoverEnabled\": true,\n \"isAutoFailoverEnabled\": true\n },\n {\n \"memberId\": \"ocid1.autonomousdatabase.oc1..uniqueID\",\n \"memberType\": \"AUTONOMOUS_DATABASE\"\n \"isAutoFailoverEnabled\": true\n }\n ],\n \"defaultSwitchoverDrPlanId\": \"ocid1.drplan.oc1..uniqueID\",\n \"defaultFailoverDrPlanId\": \"ocid1.drplan.oc1..uniqueID1\",\n \"freeformTags\": {\n \"Department\": \"Finance\"\n },\n \"definedTags\": {\n \"Operations\": {\n \"CostCenter\": \"42\"\n }\n }\n}\n"
x-related-resource: '#/definitions/AutomaticDrConfiguration'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateAutomaticDrConfigurationDetails'
description: Details for creating the new Automatic DR configuration.
required: true
/automaticDrConfigurations/{automaticDrConfigurationId}:
delete:
description: Delete the automatic DR configuration identified by *automaticDrConfigurationId*.
operationId: DeleteAutomaticDrConfiguration
parameters:
- $ref: '#/components/parameters/AutomaticDrConfigurationIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
204:
description: The automatic DR configuration has been deleted.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Delete automatic DR configuration.
tags:
- disasterRecovery
x-example: 'DELETE /20220125/automaticDrConfigurations?automaticDrConfigurationId=<automaticDrConfiguration_uniqueID>
Host: iaas.us-ashburn-1.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/AutomaticDrConfiguration'
get:
description: Get details for the Automatic DR configuration identified by *automaticDrConfigurationId*.
operationId: GetAutomaticDrConfiguration
parameters:
- $ref: '#/components/parameters/AutomaticDrConfigurationIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: Automatic DR Configuration.
headers:
etag:
description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/AutomaticDrConfiguration'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Get a Automatic DR configuration.
tags:
- disasterRecovery
x-example: 'GET /20220125/automaticDrConfigurations/<automaticDrConfiguration_uniqueID>
Host: iaas.us-ashburn-1.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/AutomaticDrConfiguration'
put:
description: Update the Automatic DR configuration identified by *automaticDrConfigurationId*.
operationId: UpdateAutomaticDrConfiguration
parameters:
- $ref: '#/components/parameters/AutomaticDrConfigurationIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
202:
description: Accepted the request. The Automatic DR configuration will be updated.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier (OCID) for the asynchronous request. You can use this to query status of the asynchronous operation. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Update Automatic DR configuration.
tags:
- disasterRecovery
x-example: "PUT /20220125/automaticDrConfigurations?automaticDrConfigurationId=<automaticDrConfiguration_uniqueID>\nHost: iaas.us-ashburn-1.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\": \"Switchover From IAD To PHX\",\n \"members\": [\n {\n \"memberId\": \"ocid1.autonomousdatabase.oc1..uniqueID\",\n \"memberType\": \"AUTONOMOUS_DATABASE\",\n \"isAutoSwitchoverEnabled\": true,\n \"isAutoFailoverEnabled\": true\n },\n {\n \"memberId\": \"ocid1.autonomousdatabase.oc1..uniqueID\",\n \"memberType\": \"AUTONOMOUS_DATABASE\",\n \"isAutoFailoverEnabled\": true\n }\n ],\n \"defaultSwitchoverDrPlanId\": \"ocid1.drplan.oc1..uniqueID\",\n \"defaultFailoverDrPlanId\": \"ocid1.drplan.oc1..uniqueID1\",\n \"freeformTags\": {\n \"Department\": \"Finance\"\n },\n \"definedTags\": {\n \"Operations\": {\n \"CostCenter\": \"42\"\n }\n }\n}\n"
x-related-resource: '#/definitions/AutomaticDrConfiguration'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateAutomaticDrConfigurationDetails'
description: Details for updating the Automatic DR configuration.
required: true
/drPlanExecutions:
get:
description: Get a summary list of all DR plan executions for a DR protection group.
operationId: ListDrPlanExecutions
parameters:
- $ref: '#/components/parameters/DrProtectionGroupIdMandatoryQueryParam'
- $ref: '#/components/parameters/DrPlanExecutionLifecycleStateQueryParam'
- $ref: '#/components/parameters/DrPlanExecutionIdQueryParam'
- $ref: '#/components/parameters/DisplayNameQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/SortByQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: A list of DR plan executions.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then a partial list might have been returned. Include this value as the `page` parameter for the
subsequent GET request to get the next batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/DrPlanExecutionCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: List DR plan executions.
tags:
- disasterRecovery
x-example: 'Example 1: List DR plan executions by DR protection group ID and lifecycle state.
GET /20220125/drPlanExecutions?drProtectionGroupId=<drProtectionGroup_uniqueID>&lifecycleState=<IN_PROGRESS>
Host: iaas.us-ashburn-1.oraclecloud.com
<authorization and other headers>
Example 2: List DR plan executions by DR protection group ID.
GET /20220125/drPlanExecutions?drProtectionGroupId=<drProtectionGroup_uniqueID>
Host: iaas.us-ashburn-1.oraclecloud.com
<authorization and other headers>
Example 3: List DR plan executions by DR protection group ID and DR plan execution ID.
GET /20220125/drPlanExecutions?drProtectionGroupId=<drProtectionGroup_uniqueID>&drPlanExecutionId=<drPlanExecution_uniqueID>
Host: iaas.us-ashburn-1.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/DrPlanExecution'
post:
description: Execute a DR plan for a DR protection group.
operationId: CreateDrPlanExecution
parameters:
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
201:
description: The DR plan execution is being created.
headers:
etag:
description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
'
schema:
type: string
location:
description: A URI for the new resource which was created by the request.
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier (OCID) for the asynchronous request. You can use this to query status of the asynchronous operation. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/DrPlanExecution'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Execute a DR plan.
tags:
- disasterRecovery
x-example: "Example 1: Execute a switchover precheck\nPOST /20220125/drPlanExecutions\nHost: iaas.us-ashburn-1.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\": \"Precheck Switchover from PHX to IAD\",\n \"planId\": \"ocid1.drplan.oc1..uniqueID\",\n \"executionOptions\": {\n \"planExecutionType\": \"SWITCHOVER_PRECHECK\"\n }\n}\n\nExample 2: Execute a switchover with prechecks enabled\nPOST /20220125/drPlanExecutions\nHost: iaas.us-ashburn-1.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\": \"Switchover from PHX to IAD\",\n \"planId\": \"ocid1.drplan.oc1..uniqueID\",\n \"executionOptions\": {\n \"planExecutionType\": \"SWITCHOVER\",\n \"arePrechecksEnabled\": true\n }\n}\n\nExample 3: Execute a failover with prechecks disabled\nPOST /20220125/drPlanExecutions\nHost: iaas.us-ashburn-1.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\": \"Failover from PHX to IAD\",\n \"planId\": \"ocid1.drplan.oc1..uniqueID\",\n \"executionOptions\": {\n \"planExecutionType\": \"FAILOVER\",\n \"arePrechecksEnabled\": false\n }\n}\n"
x-related-resource: '#/definitions/DrPlanExecution'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateDrPlanExecutionDetails'
description: Details for creating the DR plan execution.
required: true
/drPlanExecutions/{drPlanExecutionId}:
delete:
description: Delete the DR plan execution identified by *drPlanExecutionId*.
operationId: DeleteDrPlanExecution
parameters:
- $ref: '#/components/parameters/DrPlanExecutionIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
202:
description: Accepted the request. The DR plan execution will be deleted.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier (OCID) for the asynchronous request. You can use this to query status of the asynchronous operation. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Delete a DR plan execution.
tags:
- disasterRecovery
x-example: 'DELETE /20220125/drPlanExecutions/<drPlanExecution_uniqueID>
Host: iaas.us-ashburn-1.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/DrPlanExecution'
get:
description: Get details for the DR plan execution identified by *drPlanExecutionId*.
operationId: GetDrPlanExecution
parameters:
- $ref: '#/components/parameters/DrPlanExecutionIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The DR plan execution details.
headers:
etag:
description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/DrPlanExecution'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Get a DR plan execution.
tags:
- disasterRecovery
x-example: 'GET /20220125/drPlanExecutions/<drPlanExecution_uniqueID>
Host: iaas.us-ashburn-1.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/DrPlanExecution'
put:
description: Update the DR plan execution identified by *drPlanExecutionId*.
operationId: UpdateDrPlanExecution
parameters:
- $ref: '#/components/parameters/DrPlanExecutionIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: Accepted the request. The DR Execution will be updated.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier (OCID) for the asynchronous request. You can use this to query status of the asynchronous operation. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Update a DR plan execution.
tags:
- disasterRecovery
x-example: "PUT /20220125/drPlanExecutions/<drPlanExecution_uniqueID>\nHost: iaas.us-ashburn-1.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\": \"Switchover (updated) from PHX to IAD\",\n}\n"
x-related-resource: '#/definitions/DrPlanExecution'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateDrPlanExecutionDetails'
description: Details for updating the DR plan execution.
required: true
/drPlanExecutions/{drPlanExecutionId}/actions/cancel:
post:
description: Cancel the DR plan execution identified by *drPlanExecutionId*.
operationId: CancelDrPlanExecution
parameters:
- $ref: '#/components/parameters/DrPlanExecutionIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
202:
description: Accepted the request. The DR plan execution will be canceled.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier (OCID) for the asynchronous request. You can use this to query status of the asynchronous operation. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Cancel a DR plan execution.
tags:
- disasterRecovery
x-example: "POST /20220125/drPlanExecutions/<drPlanExecution_uniqueID>/actions/cancel\nHost: iaas.us-ashburn-1.oraclecloud.com\n<authorization and other headers>\n{\n \"actionType\": \"CANCEL\"\n}\n"
x-related-resource: '#/definitions/DrPlanExecution'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CancelDrPlanExecutionDetails'
description: Details for canceling the DR plan execution.
required: true
/drPlanExecutions/{drPlanExecutionId}/actions/ignore:
post:
description: Ignore the failed group or step in DR plan execution identified by *drPlanExecutionId* and resume execution.
operationId: IgnoreDrPlanExecution
parameters:
- $ref: '#/components/parameters/DrPlanExecutionIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
202:
description: Accepted the request. The failed group or step will be ignored and DR plan execution will resume.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier (OCID) for the asynchronous request. You can use this to query status of the asynchronous operation. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Ignore a failed group or step execution.
tags:
- disasterRecovery
x-example: "POST /20220125/drPlanExecutions/<drPlanExecution_uniqueID>/actions/ignore\nHost: iaas.us-ashburn-1.oraclecloud.com\n<authorization and other headers>\n{\n \"groupId\": \"sgid1.group..uniqueID\",\n \"stepId\": \"sgid1.step..uniqueID\"\n}\n"
x-related-resource: '#/definitions/DrPlanExecution'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/IgnoreDrPlanExecutionDetails'
description: Details for ignoring the failed group or step and resuming execution.
required: true
/drPlanExecutions/{drPlanExecutionId}/actions/pause:
post:
description: Pause the DR plan execution identified by *drPlanExecutionId*.
operationId: PauseDrPlanExecution
parameters:
- $ref: '#/components/parameters/DrPlanExecutionIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
202:
description: Accepted the request. The DR plan execution will be paused.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier (OCID) for the asynchronous request. You can use this to query status of the asynchronous operation. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Pause a DR plan execution.
tags:
- disasterRecovery
x-example: "POST /20220125/drPlanExecutions/<drPlanExecution_uniqueID>/actions/pause\nHost: iaas.us-ashburn-1.oraclecloud.com\n<authorization and other headers>\n{\n \"actionType\": \"PAUSE\"\n}\n"
x-related-resource: '#/definitions/DrPlanExecution'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PauseDrPlanExecutionDetails'
description: Details for pausing the DR plan execution.
required: true
/drPlanExecutions/{drPlanExecutionId}/actions/resume:
post:
description: Resume the DR plan execution identified by *drPlanExecutionId*.
operationId: ResumeDrPlanExecution
parameters:
- $ref: '#/components/parameters/DrPlanExecutionIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
202:
description: Accepted the request. The DR plan execution will be resumed.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier (OCID) for the asynchronous request. You can use this to query status of the asynchronous operation. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Resume a DR plan execution.
tags:
- disasterRecovery
x-example: "POST /20220125/drPlanExecutions/<drPlanExecution_uniqueID>/actions/resume\nHost: iaas.us-ashburn-1.oraclecloud.com\n<authorization and other headers>\n{\n \"actionType\": \"RESUME\"\n}\n"
x-related-resource: '#/definitions/DrPlanExecution'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ResumeDrPlanExecutionDetails'
description: Details for resuming the DR plan execution.
required: true
/drPlanExecutions/{drPlanExecutionId}/actions/retry:
post:
description: Retry the failed group or step in DR plan execution identified by *drPlanExecutionId* and resume execution.
operationId: RetryDrPlanExecution
parameters:
- $ref: '#/components/parameters/DrPlanExecutionIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
202:
description: Accepted the request. The failed group or step will be retried and DR plan execution will resume.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier (OCID) for the asynchronous request. You can use this to query status of the asynchronous operation. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Retry a failed group or step execution.
tags:
- disasterRecovery
x-example: "POST /20220125/drPlanExecutions/<drPlanExecution_uniqueID>/actions/retry\nHost: iaas.us-ashburn-1.oraclecloud.com\n<authorization and other headers>\n{\n \"groupId\": \"sgid1.group..uniqueID\",\n \"stepId\": \"sgid1.step..uniqueID\"\n}\n"
x-related-resource: '#/definitions/DrPlanExecution'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RetryDrPlanExecutionDetails'
description: Details for retrying execution of the failed group or step.
required: true
/drPlans:
get:
description: Get a summary list of all DR plans for a DR protection group.
operationId: ListDrPlans
parameters:
- $ref: '#/components/parameters/DrProtectionGroupIdMandatoryQueryParam'
- $ref: '#/components/parameters/DrPlanLifecycleStateQueryParam'
- $ref: '#/components/parameters/DrPlanIdQueryParam'
- $ref: '#/components/parameters/DrPlanTypeQueryParam'
- $ref: '#/components/parameters/DisplayNameQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/SortByQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/DrPlanLifecycleSubStateQueryParam'
responses:
200:
description: A list of DR plan summaries.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then a partial list might have been returned. Include this value as the `page` parameter for the
subsequent GET request to get the next batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/DrPlanCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: List DR plans.
tags:
- disasterRecovery
x-example: 'Example 1: List DR plans by DR protection group ID and lifecycle state
GET /20220125/drPlans?drProtectionGroupId=<drProtectionGroup_uniqueID>&lifecycle_state=<ACTIVE>
Host: iaas.us-ashburn-1.oraclecloud.com
<authorization and other headers>
Example 2: List DR plans by DR protection group ID and DR plan ID
GET /20220125/drPlans?drProtectionGroupId=<drProtectionGroup_uniqueID>&drPlanId=<drPlan_uniqueID>
Host: iaas.us-ashburn-1.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/DrPlan'
post:
description: Create a DR plan of the specified DR plan type.
operationId: CreateDrPlan
parameters:
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
201:
description: The DR plan is being created.
headers:
etag:
description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
'
schema:
type: string
location:
description: A URI for the new resource which was created by the request.
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier (OCID) for the asynchronous request. You can use this to query status of the asynchronous operation. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/DrPlan'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Create a DR plan.
tags:
- disasterRecovery
x-example: "POST /20220125/drPlans\nHost: iaas.us-ashburn-1.oraclecloud.com\n<authorization and other headers>\n{\n \"drProtectionGroupId\": \"ocid1.drprotectiongroup.oc1..uniqueID\",\n \"displayName\": \"Switchover from PHX to IAD\",\n \"type\": \"SWITCHOVER\"\n}\n"
x-related-resource: '#/definitions/DrPlan'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateDrPlanDetails'
description: Details for creating the new DR plan.
required: true
/drPlans/{drPlanId}:
delete:
description: Delete the DR plan identified by *drPlanId*.
operationId: DeleteDrPlan
parameters:
- $ref: '#/components/parameters/DrPlanIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
204:
description: The DR plan has been deleted.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Delete a DR plan.
tags:
- disasterRecovery
x-example: 'DELETE /20220125/drPlans?drPlanId=<drPlan_uniqueID>
Host: iaas.us-ashburn-1.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/DrPlan'
get:
description: Get details for the DR plan identified by *drPlanId*.
operationId: GetDrPlan
parameters:
- $ref: '#/components/parameters/DrPlanIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: A DR plan.
headers:
etag:
description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/DrPlan'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Get a DR plan.
tags:
- disasterRecovery
x-example: 'GET /20220125/drPlans/<drPlan_uniqueID>
Host: iaas.us-ashburn-1.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/DrPlan'
put:
description: Update the DR plan identified by *drPlanId*.
operationId: UpdateDrPlan
parameters:
- $ref: '#/components/parameters/DrPlanIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
202:
description: Accepted the request. The DR plan will be updated.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier (OCID) for the asynchronous request. You can use this to query status of the asynchronous operation. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Update a DR plan.
tags:
- disasterRecovery
x-example: "PUT /20220125/drPlans/<drPlan_uniqueID>\nHost: iaas.us-ashburn-1.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\": \"Switchover From PHX To IAD\",\n \"planGroups\": [\n {\n \"id\": \"sgid1.group..uniqueID1\",\n \"type\": \"BUILT_IN_PRECHECK\",\n \"displayName\": \"Built-In Prechecks\",\n \"steps\": [\n {\n \"id\": \"sgid1.step..uniqueID1\",\n \"groupId\": \"sgid1.group..uniqueID1\",\n \"memberId\": \"ocid1.volumegroup.oc1..uniqueID\",\n \"type\": \"VOLUME_GROUP_RESTORE_SWITCHOVER_PRECHECK\",\n \"displayName\": \"My EBS volume group\",\n \"errorMode\": \"STOP_ON_ERROR\",\n \"timeout\": 3600,\n \"isEnabled\": true,\n \"userDefinedStep\": null\n },\n {\n \"id\": \"sgid1.step..uniqueID2\",\n \"groupId\": \"sgid1.group..uniqueID1\",\n \"memberId\": \"ocid1.instance.oc1..uniqueID\",\n \"type\": \"COMPUTE_INSTANCE_LAUNCH_PRECHECK\",\n \"displayName\": \"My EBS server\",\n \"errorMode\": \"STOP_ON_ERROR\",\n \"timeout\": 3600,\n \"isEnabled\": true,\n \"userDefinedStep\": null\n }\n ]\n },\n {\n \"id\": \"sgid1.group..uniqueID2\",\n \"type\": \"BUILT_IN\",\n \"displayName\": \"Switchover Volume Groups (Standby)\",\n \"steps\": [\n {\n \"id\": \"sgid1.step..uniqueID3\",\n \"groupId\": \"sgid1.group..uniqueID2\",\n \"memberId\": \"ocid1.volumegroup.oc1..uniqueID\",\n \"type\": \"VOLUME_GROUP_RESTORE_SWITCHOVER\",\n \"displayName\": \"My EBS volume group\",\n \"errorMode\": \"STOP_ON_ERROR\",\n \"timeout\": 3600,\n \"isEnabled\": true,\n \"userDefinedStep\": null\n }\n ]\n },\n {\n \"id\": \"sgid1.group..uniqueID3\",\n \"type\": \"BUILT_IN\",\n \"displayName\": \"Launch Compute Instances (Standby)\",\n \"steps\": [\n {\n \"id\": \"sgid1.step..uniqueID4\",\n \"groupId\": \"sgid1.group..uniqueID3\",\n \"memberId\": \"ocid1.instance.oc1..uniqueID\",\n \"type\": \"COMPUTE_INSTANCE_LAUNCH\",\n \"displayName\": \"My EBS server\",\n \"errorMode\": \"STOP_ON_ERROR\",\n \"timeout\": 3600,\n \"isEnabled\": true,\n \"userDefinedStep\": null\n }\n ]\n }\n ],\n \"freeformTags\": {\n \"Department\": \"Finance\"\n },\n \"definedTags\": {\n \"Operations\": {\n \"CostCenter\": \"42\"\n }\n }\n}\n"
x-related-resource: '#/definitions/DrPlan'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateDrPlanDetails'
description: Details for updating the DR plan.
required: true
/drPlans/{drPlanId}/actions/refresh:
post:
description: Refresh DR Plan identified by *drPlanId*.
operationId: RefreshDrPlan
parameters:
- $ref: '#/components/parameters/DrPlanIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
202:
description: Accepted the request. The DR plan will be refreshed.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier (OCID) for the asynchronous request. You can use this to query status of the asynchronous operation. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Refresh DR Plan.
tags:
- disasterRecovery
x-example: 'POST /20220125/drPlan/<drPlan_uniqueID>/actions/refresh
Host: iaas.us-ashburn-1.oraclecloud.com
<authorization and other headers>
{}
'
x-obmcs-terraform:
actionType: SPECIAL_UPDATE
x-related-resource: '#/definitions/DrPlan'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RefreshDrPlanDetails'
description: Details for refreshing a DR plan.
required: true
/drPlans/{drPlanId}/actions/verify:
post:
description: Verify DR Plan identified by *drPlanId*.
operationId: VerifyDrPlan
parameters:
- $ref: '#/components/parameters/DrPlanIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
202:
description: Accepted the request. The DR plan will be verified.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier (OCID) for the asynchronous request. You can use this to query status of the asynchronous operation. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Verify DR Plan.
tags:
- disasterRecovery
x-example: 'POST /20220125/drPlan/<drPlan_uniqueID>/actions/verify
Host: iaas.us-ashburn-1.oraclecloud.com
<authorization and other headers>
{}
'
x-obmcs-terraform:
actionType: SPECIAL_UPDATE
x-related-resource: '#/definitions/DrPlan'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/VerifyDrPlanDetails'
description: Details for verifying a DR plan.
required: true
/drProtectionGroups:
get:
description: Get a summary list of all DR protection groups in a compartment.
operationId: ListDrProtectionGroups
parameters:
- $ref: '#/components/parameters/CompartmentIdMandatoryQueryParam'
- $ref: '#/components/parameters/DrProtectionGroupLifecycleStateQueryParam'
- $ref: '#/components/parameters/DrProtectionGroupIdQueryParam'
- $ref: '#/components/parameters/DisplayNameQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/SortByQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/DrProtectionGroupRoleQueryParam'
- $ref: '#/components/parameters/DrProtectionGroupLifecycleSubStateQueryParam'
responses:
200:
description: A list of DR protection group summaries.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then a partial list might have been returned. Include this value as the `page` parameter for the
subsequent GET request to get the next batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/DrProtectionGroupCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Get a list of DR protection groups.
tags:
- disasterRecovery
x-example: 'GET /20220125/drProtectionGroups?compartmentId=<compartment_uniqueID>
Host: iaas.us-ashburn-1.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/DrProtectionGroup'
post:
description: Create a DR protection group.
operationId: CreateDrProtectionGroup
parameters:
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
201:
description: The DR protection group is being created.
headers:
etag:
description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
'
schema:
type: string
location:
description: A URI for the new resource which was created by the request.
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier (OCID) for the asynchronous request. You can use this to query status of the asynchronous operation. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/DrProtectionGroup'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Create a DR protection group.
tags:
- disasterRecovery
x-example: "POST /20220125/drProtectionGroups\nHost: iaas.us-ashburn-1.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\": \"ocid1.compartment.oc1..uniqueID\",\n \"displayName\": \"My DR protection group\",\n \"logLocation\": {\n \"namespace\": \"namespace_string\",\n \"bucket\": \"bucket_name\"\n },\n \"association\": {\n \"peerRegion\": \"us-phoenix-1\",\n \"peerId\": \"ocid1.drprotectiongroup.oc1..uniqueID2\",\n \"role\": \"STANDBY\"\n },\n \"members\": [\n {\n \"memberId\": \"ocid1.instance.oc1..uniqueID\",\n \"memberType\": \"COMPUTE_INSTANCE_MOVABLE\",\n \"isRetainFaultDomain\": false,\n \"destinationCapacityReservationId\": \"ocid1.capacityreservation.oc1..uniqueID\",\n \"destinationCompartmentId\": \"ocid1.compartment.oc1..uniqueID\",\n \"vnicMappings\": [\n {\n \"sourceVnicId\": \"ocid1.vnic.oc1..uniqueID\",\n \"destinationSubnetId\": \"ocid1.subnet.oc1..uniqueID\",\n \"destinationPrimaryPrivateIpAddress\": \"10.0.3.1\",\n \"destinationPrimaryPrivateIpHostnameLabel\": \"myhost1\",\n \"destinationReservedPublicIpId\": \"ocid1.publicip.oc1..uniqueID1\",\n \"destinationNsgIdList\": [\n \"ocid1.nsg.oc1..uniqueID1\",\n \"ocid1.nsg.oc1..uniqueID2\"\n ]\n },\n {\n \"sourceVnicId\": \"ocid1.vnic.oc1..uniqueID\",\n \"destinationSubnetId\": \"ocid1.subnet.oc1..uniqueID\",\n \"destinationPrimaryPrivateIpAddress\": \"10.0.3.2\",\n \"destinationPrimaryPrivateIpHostnameLabel\": \"myhost2\",\n \"destinationReservedPublicIpId\": \"ocid1.publicip.oc1..uniqueID1\",\n \"destinationNsgIdList\": [\n \"ocid1.nsg.oc1..uniqueID1\",\n \"ocid1.nsg.oc1..uniqueID2\"\n ]\n }\n ],\n \"fileSystemOperations\": [\n {\n \"exportPath\": \"/fs-export-path\",\n \"mountPoint\": \"/mnt/yourmountpoint\",\n \"mountDetails\": {\n \"mountTargetId\": \"ocid1.mounttarget.oc1..uniqueID\"\n },\n \"unmountDetails\": {\n \"mountTargetId\": \"ocid1.mounttarget.oc1..uniqueID\"\n }\n }\n ]\n },\n {\n \"memberId\": \"ocid1.instance.oc1..uniqueID\",\n \"memberType\": \"COMPUTE_INSTANCE_NON_MOVABLE\",\n \"isStartStopEnabled\": true,\n \"fileSystemOperations\": [\n {\n \"exportPath\": \"/fs-export-path\",\n \"mountPoint\": \"/mnt/yourmountpoint\",\n \"mountDetails\": {\n \"mountTargetId\": \"ocid1.mounttarget.oc1..uniqueID\"\n },\n \"unmountDetails\": {\n \"mountTargetId\": \"ocid1.mounttarget.oc1..uniqueID\"\n }\n }\n ],\n \"blockVolumeOperations\": [\n {\n \"blockVolumeId\": \"ocid1.volume.oc1..uniqueID\",\n \"attachmentDetails\": {\n \"volumeAttachmentReferenceInstanceId\": \"ocid1.instance.oc1..uniqueID\"\n },\n \"mountDetails\": {\n \"mountPoint\": \"/mnt/yourmountpoint\"\n }\n }\n ]\n },\n {\n \"memberId\": \"ocid1.volumegroup.oc1..uniqueID\",\n \"memberType\": \"VOLUME_GROUP\"\n },\n {\n \"memberId\": \"ocid1.database.oc1..uniqueID\",\n \"memberType\": \"DATABASE\",\n \"passwordVaultSecretId\": \"ocid1.vaultsecret.oc1..uniqueID\"\n },\n {\n \"memberId\": \"ocid1.autonomouscontainerdatabase.oc1..uniqueID\",\n \"memberType\": \"AUTONOMOUS_CONTAINER_DATABASE\",\n \"connectionStringType\": \"SNAPSHOT_SERVICE\"\n },\n {\n \"memberId\": \"ocid1.autonomousdatabase.oc1..uniqueID2\",\n \"memberType\": \"AUTONOMOUS_DATABASE\",\n \"autonomousDatabaseStandbyTypeForDrDrills\": \"SNAPSHOT_STANDBY\"\n },\n {\n \"memberId\": \"ocid1.autonomousdatabase.oc1..uniqueID\",\n \"memberType\": \"AUTONOMOUS_DATABASE\"\n },\n {\n \"memberType\": \"OKE_CLUSTER\",\n \"memberId\": \"ocid1.cluster.oc1..uniqueID\",\n \"peerClusterId\": \"ocid1.cluster.oc1..uniqueID\",\n \"backupLocation\": {\n \"namespace\": \"namespace_string\",\n \"bucket\": \"bucket_name\"\n },\n \"backupConfig\": {\n \"backupSchedule\": \"FREQ=HOURLY;BYHOUR=1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16;INTERVAL=1\",\n \"namespaces\": [\n \"namespace_string_1\",\n \"namespace_string_2\"\n ],\n \"excludeNamespaces\": [\n \"namespace_string_3\",\n \"namespace_string_4\"\n ],\n \"replicateImages\": \"ENABLE\",\n \"maxNumberOfBackupsRetained\": 2,\n \"imageReplicationVaultSecretId\": \"ocid1.vaultsecret.oc1..uniqueID\"\n },\n \"loadBalancerMappings\": [\n {\n \"sourceLoadBalancerId\": \"ocid1.loadbalancer.oc1..uniqueID\",\n \"destinationLoadBalancerId\": \"ocid1.loadbalancer.oc1..uniqueID\"\n }\n ],\n \"networkLoadBalancerMappings\": [\n {\n \"sourceNetworkLoadBalancerId\": \"ocid1.networkloadbalancer.oc1..uniqueID\",\n \"destinationNetworkLoadBalancerId\": \"ocid1.networkloadbalancer.oc1..uniqueID\"\n }\n ],\n \"vaultMappings\":[\n {\n \"sourceVaultId\": \"ocid1.vault.oc1..uniqueID\",\n \"destinationVaultId\": \"ocid1.vault.oc1..uniqueID\"\n }\n ],\n \"managedNodePoolConfigs\": [\n {\n \"id\": \"ocid1.nodepool.oc1..uniqueID\",\n \"minimum\": 1,\n \"maximum\": 10\n }\n ],\n \"virtualNodePoolConfigs\": [\n {\n \"id\": \"ocid1.virtualnodepool.oc1..uniqueID\",\n \"minimum\": 1,\n \"maximum\": 10\n }\n ]\n ,\"resourceModifierMappings\": [\n {\n \"namespace\": \"namespace_string_5\",\n \"configMap\": \"resource-modifier\"\n }\n ]\n }\n ],\n \"freeformTags\": {\n \"Department\": \"Finance\"\n },\n \"definedTags\": {\n \"Operations\": {\n \"CostCenter\": \"42\"\n }\n }\n}\n\nExample using 'blockVolumeAttachAndMountOperations' for providing block volume operations instead of deprecated attribute 'blockVolumeOperations':\nPOST /20220125/drProtectionGroups\nHost: iaas.us-ashburn-1.oraclecloud.com\n<authorization and other headers>\n{\n\"compartmentId\": \"ocid1.compartment.oc1..uniqueID\",\n\"displayName\": \"My DR protection group\",\n\"logLocation\": {\n \"namespace\": \"namespace_string\",\n \"bucket\": \"bucket_name\"\n},\n\"association\": {\n \"peerRegion\": \"us-phoenix-1\",\n \"peerId\": \"ocid1.drprotectiongroup.oc1..uniqueID2\",\n \"role\": \"STANDBY\"\n},\n\"members\": [\n {\n \"memberId\": \"ocid1.instance.oc1..uniqueID\",\n \"memberType\": \"COMPUTE_INSTANCE_MOVABLE\",\n \"isRetainFaultDomain\": false,\n \"destinationCapacityReservationId\": \"ocid1.capacityreservation.oc1..uniqueID\",\n \"destinationCompartmentId\": \"ocid1.compartment.oc1..uniqueID\",\n \"vnicMappings\": [\n {\n \"sourceVnicId\": \"ocid1.vnic.oc1..uniqueID\",\n \"destinationSubnetId\": \"ocid1.subnet.oc1..uniqueID\",\n \"destinationPrimaryPrivateIpAddress\": \"10.0.3.1\",\n \"destinationPrimaryPrivateIpHostnameLabel\": \"myhost1\",\n \"destinationReservedPublicIpId\": \"ocid1.publicip.oc1..uniqueID1\",\n \"destinationNsgIdList\": [\n \"ocid1.nsg.oc1..uniqueID1\",\n \"ocid1.nsg.oc1..uniqueID2\"\n ]\n },\n {\n \"sourceVnicId\": \"ocid1.vnic.oc1..uniqueID\",\n \"destinationSubnetId\": \"ocid1.subnet.oc1..uniqueID\",\n \"destinationPrimaryPrivateIpAddress\": \"10.0.3.2\",\n \"destinationPrimaryPrivateIpHostnameLabel\": \"myhost2\",\n \"destinationReservedPublicIpId\": \"ocid1.publicip.oc1..uniqueID1\",\n \"destinationNsgIdList\": [\n \"ocid1.nsg.oc1..uniqueID1\",\n \"ocid1.nsg.oc1..uniqueID2\"\n ]\n }\n ],\n \"fileSystemOperations\": [\n {\n \"exportPath\": \"/fs-export-path\",\n \"mountPoint\": \"/mnt/yourmountpoint\",\n \"mountDetails\": {\n \"mountTargetId\": \"ocid1.mounttarget.oc1..uniqueID\"\n },\n \"unmountDetails\": {\n \"mountTargetId\": \"ocid1.mounttarget.oc1..uniqueID\"\n }\n }\n ]\n },\n {\n \"memberId\": \"ocid1.instance.oc1..uniqueID\",\n \"memberType\": \"COMPUTE_INSTANCE_NON_MOVABLE\",\n \"isStartStopEnabled\": true,\n \"fileSystemOperations\": [\n {\n \"exportPath\": \"/fs-export-path\",\n \"mountPoint\": \"/mnt/yourmountpoint\",\n \"mountDetails\": {\n \"mountTargetId\": \"ocid1.mounttarget.oc1..uniqueID\"\n },\n \"unmountDetails\": {\n \"mountTargetId\": \"ocid1.mounttarget.oc1..uniqueID\"\n }\n }\n ],\n \"blockVolumeAttachAndMountOperations\": {\n \"attachments\": [\n {\n \"blockVolumeId\": \"ocid1.volume.oc1..uniqueID1\",\n \"volumeAttachmentReferenceInstanceId\": \"ocid1.instance.oc1..uniqueID\"\n },\n {\n \"blockVolumeId\": \"ocid1.volume.oc1..uniqueID2\"\n }\n ],\n \"mounts\": [\n {\n \"mountPoint\": \"/mnt/yourmountpoint1\"\n },\n {\n \"mountPoint\": \"/mnt/yourmountpoint2\"\n }\n ]\n }\n },\n {\n \"memberId\": \"ocid1.volumegroup.oc1..uniqueID\",\n \"memberType\": \"VOLUME_GROUP\"\n },\n {\n \"memberId\": \"ocid1.database.oc1..uniqueID\",\n \"memberType\": \"DATABASE\",\n \"passwordVaultSecretId\": \"ocid1.vaultsecret.oc1..uniqueID\"\n },\n {\n \"memberId\": \"ocid1.autonomouscontainerdatabase.oc1..uniqueID\",\n \"memberType\": \"AUTONOMOUS_CONTAINER_DATABASE\",\n \"connectionStringType\": \"SNAPSHOT_SERVICE\"\n },\n {\n \"memberId\": \"ocid1.autonomousdatabase.oc1..uniqueID2\",\n \"memberType\": \"AUTONOMOUS_DATABASE\",\n \"autonomousDatabaseStandbyTypeForDrDrills\": \"SNAPSHOT_STANDBY\"\n },\n {\n \"memberId\": \"ocid1.autonomousdatabase.oc1..uniqueID\",\n \"memberType\": \"AUTONOMOUS_DATABASE\"\n },\n {\n \"memberType\": \"OKE_CLUSTER\",\n \"memberId\": \"ocid1.cluster.oc1..uniqueID\",\n \"peerClusterId\": \"ocid1.cluster.oc1..uniqueID\",\n \"backupLocation\": {\n \"namespace\": \"namespace_string\",\n \"bucket\": \"bucket_name\"\n },\n \"backupConfig\": {\n \"backupSchedule\": \"FREQ=HOURLY;BYHOUR=1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16;INTERVAL=1\",\n \"namespaces\": [\n \"namespace_string_1\",\n \"namespace_string_2\"\n ],\n \"excludeNamespaces\": [\n \"namespace_string_3\",\n \"namespace_string_4\"\n ],\n \"replicateImages\": \"ENABLE\",\n \"maxNumberOfBackupsRetained\": 2,\n \"imageReplicationVaultSecretId\": \"ocid1.vaultsecret.oc1..uniqueID\"\n },\n \"loadBalancerMappings\": [\n {\n \"sourceLoadBalancerId\": \"ocid1.loadbalancer.oc1..uniqueID\",\n \"destinationLoadBalancerId\": \"ocid1.loadbalancer.oc1..uniqueID\"\n }\n ],\n \"networkLoadBalancerMappings\": [\n {\n \"sourceNetworkLoadBalancerId\": \"ocid1.networkloadbalancer.oc1..uniqueID\",\n \"destinationNetworkLoadBalancerId\": \"ocid1.networkloadbalancer.oc1..uniqueID\"\n }\n ],\n \"vaultMappings\": [\n {\n \"sourceVaultId\": \"ocid1.vault.oc1..uniqueID\",\n \"destinationVaultId\": \"ocid1.vault.oc1..uniqueID\"\n }\n ],\n \"managedNodePoolConfigs\": [\n {\n \"id\": \"ocid1.nodepool.oc1..uniqueID\",\n \"minimum\": 1,\n \"maximum\": 10\n }\n ],\n \"virtualNodePoolConfigs\": [\n {\n \"id\": \"ocid1.virtualnodepool.oc1..uniqueID\",\n \"minimum\": 1,\n \"maximum\": 10\n }\n ]\n ,\"resourceModifierMappings\": [\n {\n \"namespace\": \"namespace_string_5\",\n \"configMap\": \"resource-modifier\"\n }\n ]\n }\n ],\n \"freeformTags\": {\n \"Department\": \"Finance\"\n },\n \"definedTags\": {\n \"Operations\": {\n \"CostCenter\": \"42\"\n }\n }\n}\n"
x-related-resource: '#/definitions/DrProtectionGroup'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateDrProtectionGroupDetails'
description: Details for creating the DR protection group.
required: true
/drProtectionGroups/{drProtectionGroupId}:
delete:
description: Delete the DR protection group identified by *drProtectionGroupId*.
operationId: DeleteDrProtectionGroup
parameters:
- $ref: '#/components/parameters/DrProtectionGroupIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
202:
description: Accepted the request. The DR protection group will be deleted.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier (OCID) for the asynchronous request. You can use this to query status of the asynchronous operation. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Delete a DR protection group.
tags:
- disasterRecovery
x-example: 'DELETE /20220125/drProtectionGroups/<drProtectionGroup_uniqueID>>;
Host: iaas.us-ashburn-1.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/DrProtectionGroup'
get:
description: Get the DR protection group identified by *drProtectionGroupId*.
operationId: GetDrProtectionGroup
parameters:
- $ref: '#/components/parameters/DrProtectionGroupIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: A DR protection group.
headers:
etag:
description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/DrProtectionGroup'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Get a DR protection group.
tags:
- disasterRecovery
x-example: 'GET /20220125/drProtectionGroups/<drProtectionGroup_uniqueID>>;
Host: iaas.us-ashburn-1.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/DrProtectionGroup'
put:
description: Update the DR protection group identified by *drProtectionGroupId*.
operationId: UpdateDrProtectionGroup
parameters:
- $ref: '#/components/parameters/DrProtectionGroupIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
202:
description: Accepted the request. The DR protection group will be updated.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier (OCID) for the asynchronous request. You can use this to query status of the asynchronous operation. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Update a DR protection group.
tags:
- disasterRecovery
x-example: "PUT /20220125/drProtectionGroups/<drProtectionGroup_uniqueID>>;\nHost: iaas.us-ashburn-1.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\": \"My DR protection group\",\n \"members\": [\n {\n \"memberId\": \"ocid1.instance.oc1..uniqueID\",\n \"memberType\": \"COMPUTE_INSTANCE_MOVABLE\",\n \"isRetainFaultDomain\": false,\n \"destinationCapacityReservationId\": \"ocid1.capacityreservation.oc1..uniqueID\",\n \"destinationCompartmentId\": \"ocid1.compartment.oc1..uniqueID\",\n \"vnicMappings\": [\n {\n \"sourceVnicId\": \"ocid1.vnic.oc1..uniqueID\",\n \"destinationSubnetId\": \"ocid1.subnet.oc1..uniqueID\",\n \"destinationPrimaryPrivateIpAddress\": \"10.0.3.1\",\n \"destinationPrimaryPrivateIpHostnameLabel\": \"myhost1\",\n \"destinationReservedPublicIpId\": \"ocid1.publicip.oc1..uniqueID1\",\n \"destinationNsgIdList\": [\n \"ocid1.nsg.oc1..uniqueID1\",\n \"ocid1.nsg.oc1..uniqueID2\"\n ]\n },\n {\n \"sourceVnicId\": \"ocid1.vnic.oc1..uniqueID\",\n \"destinationSubnetId\": \"ocid1.subnet.oc1..uniqueID\",\n \"destinationPrimaryPrivateIpAddress\": \"10.0.3.2\",\n \"destinationPrimaryPrivateIpHostnameLabel\": \"myhost2\",\n \"destinationReservedPublicIpId\": \"ocid1.publicip.oc1..uniqueID1\",\n \"destinationNsgIdList\": [\n \"ocid1.nsg.oc1..uniqueID1\",\n \"ocid1.nsg.oc1..uniqueID2\"\n ]\n }\n ],\n \"fileSystemOperations\": [\n {\n \"exportPath\": \"/fs-export-path\",\n \"mountPoint\": \"/mnt/yourmountpoint\",\n \"mountDetails\": {\n \"mountTargetId\": \"ocid1.mounttarget.oc1..uniqueID\"\n },\n \"unmountDetails\": {\n \"mountTargetId\": \"ocid1.mounttarget.oc1..uniqueID\"\n }\n }\n ]\n },\n {\n \"memberId\": \"ocid1.volumegroup.oc1..uniqueID\",\n \"memberType\": \"VOLUME_GROUP\"\n },\n {\n \"memberId\": \"ocid1.database.oc1..uniqueID\",\n \"memberType\": \"DATABASE\",\n \"passwordVaultSecretId\": \"ocid1.vaultsecret.oc1..uniqueID\"\n },\n {\n \"memberType\": \"OKE_CLUSTER\",\n \"memberId\": \"ocid1.cluster.oc1..uniqueID\",\n \"peerClusterId\": \"ocid1.cluster.oc1..uniqueID\",\n \"backupLocation\": {\n \"namespace\": \"namespace_string\",\n \"bucket\": \"bucket_name\"\n },\n \"backupConfig\": {\n \"backupSchedule\": \"FREQ=HOURLY;BYHOUR=1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16;INTERVAL=1\",\n \"namespaces\": [\n \"namespace_string_1\",\n \"namespace_string_2\"\n ],\n \"excludeNamespaces\": [\n \"namespace_string_3\",\n \"namespace_string_4\"\n ],\n \"replicateImages\": \"ENABLE\",\n \"maxNumberOfBackupsRetained\": 2,\n \"imageReplicationVaultSecretId\": \"ocid1.vaultsecret.oc1..uniqueID\"\n },\n \"loadBalancerMappings\": [\n {\n \"sourceLoadBalancerId\": \"ocid1.loadbalancer.oc1..uniqueID\",\n \"destinationLoadBalancerId\": \"ocid1.loadbalancer.oc1..uniqueID\"\n }\n ],\n \"networkLoadBalancerMappings\": [\n {\n \"sourceNetworkLoadBalancerId\": \"ocid1.networkloadbalancer.oc1..uniqueID\",\n \"destinationNetworkLoadBalancerId\": \"ocid1.networkloadbalancer.oc1..uniqueID\"\n }\n ],\n \"vaultMappings\":[\n {\n \"sourceVaultId\": \"ocid1.vault.oc1..uniqueID\",\n \"destinationVaultId\": \"ocid1.vault.oc1..uniqueID\"\n }\n ],\n \"managedNodePoolConfigs\": [\n {\n \"id\": \"ocid1.nodepool.oc1..uniqueID\",\n \"minimum\": 1,\n \"maximum\": 10\n }\n ],\n \"virtualNodePoolConfigs\": [\n {\n \"id\": \"ocid1.virtualnodepool.oc1..uniqueID\",\n \"minimum\": 1,\n \"maximum\": 10\n }\n ]\n ,\"resourceModifierMappings\": [\n {\n \"namespace\": \"namespace_string_5\",\n \"configMap\": \"resource-modifier\"\n }\n ]\n }\n ]\n}\n"
x-related-resource: '#/definitions/DrProtectionGroup'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateDrProtectionGroupDetails'
description: Details for updating the the DR protection group.
required: true
/drProtectionGroups/{drProtectionGroupId}/actions/associate:
post:
description: 'Create an association between the DR protection group identified by *drProtectionGroupId* and
another DR protection group.
'
operationId: AssociateDrProtectionGroup
parameters:
- $ref: '#/components/parameters/DrProtectionGroupIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
202:
description: Accepted the request. An association with the specified DR protection group will be created.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier (OCID) for the asynchronous request. You can use this to query status of the asynchronous operation. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: 'Create an association between two DR protection groups.
'
tags:
- disasterRecovery
x-example: "POST /20220125/drProtectionGroups/<drProtectionGroup_uniqueID>>/actions/associate\nHost: iaas.us-ashburn-1.oraclecloud.com\n<authorization and other headers>\n{\n \"peerRegion\": \"us-phoenix-1\",\n \"peerId\": \"ocid1.drprotectiongroup.oc1..uniqueID\",\n \"role\": \"STANDBY\"\n}\n"
x-related-resource: '#/definitions/DrProtectionGroup'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AssociateDrProtectionGroupDetails'
description: Details for creating an association between two DR protection groups.
required: true
/drProtectionGroups/{drProtectionGroupId}/actions/changeCompartment:
post:
description: Move the DR protection group identified by *drProtectionGroupId* to a different compartment.
operationId: ChangeDrProtectionGroupCompartment
parameters:
- $ref: '#/components/parameters/DrProtectionGroupIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
202:
description: Accepted the request. The DR protection group will be moved into a different compartment.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier (OCID) for the asynchronous request. You can use this to query status of the asynchronous operation. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request.
'
schema:
type: string
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
summary: Move a DR protection group.
tags:
- disasterRecovery
x-example: "POST /20220125/drProtectionGroups/<drProtectionGroup_uniqueID>>/actions/changeCompartment\nHost: iaas.us-ashburn-1.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\": \"ocid1.compartment.oc1..uniqueID\"\n} \n"
x-related-resource: '#/definitions/DrProtectionGroup'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeDrProtectionGroupCompartmentDetails'
description: Details for changing the DR protection group compartment.
required: true
/drProtectionGroups/{drProtectionGroupId}/actions/disassociate:
post:
description: 'Delete the association between the DR protection group identified by *drProtectionGroupId*.
and its peer DR protection group.
'
operationId: DisassociateDrProtectionGroup
parameters:
- $ref: '#/components/parameters/DrProtectionGroupIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
202:
description: Accepted the request. The association will be deleted.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier (OCID) for the asynchronous request. You can use this to query status of the asynchronous operation. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: 'Delete the association between two DR protection groups.
'
tags:
- disasterRecovery
x-example: "POST /20220125/drProtectionGroups/<drProtectionGroup_uniqueID>>/actions/disassociate\nHost: iaas.us-ashburn-1.oraclecloud.com\n<authorization and other headers>\n{\n \"type\": \"DEFAULT\"\n}\n"
x-obmcs-terraform:
actionType: SPECIAL_UPDATE
x-related-resource: '#/definitions/DrProtectionGroup'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DisassociateDrProtectionGroupDetails'
description: Details for deleting the association between two DR protection groups.
required: true
/drProtectionGroups/{drProtectionGroupId}/actions/updateRole:
post:
description: Update the role of the DR protection group identified by *drProtectionGroupId*.
operationId: UpdateDrProtectionGroupRole
parameters:
- $ref: '#/components/parameters/DrProtectionGroupIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
202:
description: Accepted the request. The role of the DR protection group will be updated.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier (OCID) for the asynchronous request. You can use this to query status of the asynchronous operation. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Update the role of a DR protection group.
tags:
- disasterRecovery
x-example: "POST /20220125/drProtectionGroups/<drProtectionGroup_uniqueID>>/actions/updateRole\nHost: iaas.us-ashburn-1.oraclecloud.com\n<authorization and other headers>\n{\n \"role\": \"STANDBY\"\n}\n"
x-related-resource: '#/definitions/DrProtectionGroup'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateDrProtectionGroupRoleDetails'
description: The role details for the DR protection group to be updated.
required: true
/workRequests:
get:
description: 'Lists the work requests in a compartment.
'
operationId: ListWorkRequests
parameters:
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/WorkRequestIdQueryParam'
- $ref: '#/components/parameters/WorkRequestStatusQueryParam'
- $ref: '#/components/parameters/ResourceIdentifierQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/WorkRequestSortByQueryParam'
responses:
200:
description: The list is being retrieved.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then a partial list might have been returned. Include this value as the `page` parameter for the
subsequent GET request to get the next batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/WorkRequestSummaryCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: List work requests
tags:
- disasterRecovery
x-example: 'Example 1: List work requests by compartment ID and status.
GET /20220125/workRequests?compartmentId=<compartment_uniqueID>&status=<status>
Host: iaas.us-ashburn-1.oraclecloud.com
<authorization and other headers>
Example 2: List work requests by compartment ID and resource ID.
GET /20220125/workRequests?compartmentId=<compartment_uniqueID>&resourceId=<resource_uniqueID>
Host: iaas.us-ashburn-1.oraclecloud.com
<authorization and other headers>
Example 3: List work requests by work request ID.
GET /20220125/workRequests?workRequestId=<workRequest_uniqueID>
Host: iaas.us-ashburn-1.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/WorkRequest'
/workRequests/{workRequestId}:
delete:
description: Cancel the work request identified by *workRequestId*.
operationId: CancelWorkRequest
parameters:
- $ref: '#/components/parameters/WorkRequestIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
202:
description: The work request will be canceled.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Cancel a work request
tags:
- disasterRecovery
x-example: 'DELETE /20220125/workRequests/<workRequest_uniqueID>
Host: iaas.us-ashburn-1.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/WorkRequest'
get:
description: Get the status of the work request identified by *workRequestId*.
operationId: GetWorkRequest
parameters:
- $ref: '#/components/parameters/WorkRequestIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The details of the work request.
headers:
etag:
description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
retry-after:
description: A decimal number representing the number of seconds the client should wait before polling this endpoint again.
schema:
type: number
format: float
content:
application/json:
schema:
$ref: '#/components/schemas/WorkRequest'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Get work request status
tags:
- disasterRecovery
x-example: 'GET /20220125/workRequests/<workRequest_uniqueID>
Host: iaas.us-ashburn-1.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/WorkRequest'
/workRequests/{workRequestId}/errors:
get:
description: 'Get a list of work request errors for the work request identified by *workRequestId*.
'
operationId: ListWorkRequestErrors
parameters:
- $ref: '#/components/parameters/WorkRequestIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/WorkRequestSortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
responses:
200:
description: List of work request errors.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then a partial list might have been returned. Include this value as the `page` parameter for the
subsequent GET request to get the next batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/WorkRequestErrorCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: List work request errors.
tags:
- disasterRecovery
x-example: 'GET /20220125/workRequests/<workRequest_uniqueID>/errors
Host: iaas.us-ashburn-1.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/WorkRequestError'
/workRequests/{workRequestId}/logs:
get:
description: 'Get a list of logs for the work request identified by *workRequestId*.
'
operationId: ListWorkRequestLogs
parameters:
- $ref: '#/components/parameters/WorkRequestIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/WorkRequestSortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
responses:
200:
description: List of work request logs.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then a partial list might have been returned. Include this value as the `page` parameter for the
subsequent GET request to get the next batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/WorkRequestLogEntryCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: List work request logs
tags:
- disasterRecovery
x-example: 'GET /20220125/workRequests/<workRequest_uniqueID>/logs
Host: iaas.us-ashburn-1.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/WorkRequestLogEntry'
components:
parameters:
DrPlanTypeQueryParam:
description: The DR plan type.
in: query
name: drPlanType
required: false
x-default-description: 'null'
x-obmcs-top-level-enum: '#/definitions/DrPlanType'
schema:
type: string
enum:
- SWITCHOVER
- FAILOVER
- START_DRILL
- STOP_DRILL
IfMatchHeader:
description: 'For optimistic concurrency control. In the PUT or DELETE call
for a resource, set the `if-match` parameter to the value of the
etag from a previous GET or POST response for that resource.
The resource will be updated or deleted only if the etag you
provide matches the resource''s current etag value.
'
in: header
name: if-match
required: false
schema:
type: string
DrProtectionGroupIdMandatoryQueryParam:
description: 'The OCID of the DR protection group. Mandatory query param.
Example: `ocid1.drprotectiongroup.oc1..uniqueID`
'
in: query
name: drProtectionGroupId
required: true
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
SortOrderQueryParam:
description: 'The sort order to use, either ''asc'' or ''desc''.
'
in: query
name: sortOrder
x-obmcs-top-level-enum: '#/definitions/SortOrder'
schema:
type: string
enum:
- ASC
- DESC
default: ASC
DrProtectionGroupIdPathParam:
description: 'The OCID of the DR protection group.
Example: `ocid1.drprotectiongroup.oc1..uniqueID`
'
in: path
name: drProtectionGroupId
required: true
schema:
type: string
maxLength: 255
minLength: 1
DrPlanExecutionLifecycleStateQueryParam:
description: 'A filter to return only DR plan executions that match the given lifecycle state.
'
in: query
name: lifecycleState
required: false
x-default-description: 'null'
x-obmcs-top-level-enum: '#/definitions/DrPlanExecutionLifecycleState'
schema:
type: string
enum:
- ACCEPTED
- IN_PROGRESS
- WAITING
- CANCELING
- CANCELED
- SUCCEEDED
- FAILED
- DELETING
- DELETED
- PAUSING
- PAUSED
- RESUMING
AutomaticDrConfigurationIdQueryParam:
description: 'The OCID of the automatic DR configuration.
Example: `ocid1.automaticDrConfiguration.oc1..uniqueID`
'
in: query
name: automaticDrConfigurationId
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
DrPlanExecutionIdQueryParam:
description: 'The OCID of the DR plan execution.
Example: `ocid1.drplanexecution.oc1..uniqueID`
'
in: query
name: drPlanExecutionId
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
DrPlanExecutionIdPathParam:
description: 'The OCID of the DR plan execution.
Example: `ocid1.drplanexecution.oc1..uniqueID`
'
in: path
name: drPlanExecutionId
required: true
schema:
type: string
maxLength: 255
minLength: 1
RequestIdHeader:
description: 'The client request ID for tracing.
'
in: header
name: opc-request-id
schema:
type: string
DrPlanIdQueryParam:
description: 'The OCID of the DR plan.
Example: `ocid1.drplan.oc1..uniqueID`
'
in: query
name: drPlanId
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
SortByQueryParam:
description: 'The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending.
Default order for displayName is ascending. If no value is specified timeCreated is default.
Example: `MyResourceDisplayName`
'
in: query
name: sortBy
schema:
type: string
enum:
- timeCreated
- displayName
default: timeCreated
ResourceIdentifierQueryParam:
description: 'The ID (OCID) of the resource affected by the work request.
Example: `ocid1.drplanexecution.oc1..uniqueID`
'
in: query
name: resourceId
x-default-description: 'null'
schema:
type: string
WorkRequestStatusQueryParam:
description: 'A filter to return only resources whose lifecycleState matches the given OperationStatus.
'
in: query
name: status
required: false
x-default-description: 'null'
x-obmcs-top-level-enum: '#/definitions/OperationStatus'
schema:
type: string
enum:
- ACCEPTED
- IN_PROGRESS
- WAITING
- CANCELING
- CANCELED
- SUCCEEDED
- FAILED
- NEEDS_ATTENTION
DrPlanIdPathParam:
description: 'The OCID of the DR plan.
Example: `ocid1.drplan.oc1..uniqueID`
'
in: path
name: drPlanId
required: true
schema:
type: string
maxLength: 255
minLength: 1
WorkRequestIdPathParam:
description: 'The ID (OCID) of the asynchronous request.
Example: `ocid1.workrequest.oc1..uniqueID`
'
in: path
name: workRequestId
required: true
schema:
type: string
AutomaticDrConfigurationIdPathParam:
description: 'The OCID of the Automatic DR configuration.
Example: `ocid1.automaticDrConfiguration.oc1..uniqueID`
'
in: path
name: automaticDrConfigurationId
required: true
schema:
type: string
maxLength: 255
minLength: 1
DrPlanLifecycleStateQueryParam:
description: 'A filter to return only DR plans that match the given lifecycle state.
'
in: query
name: lifecycleState
required: false
x-default-description: 'null'
x-obmcs-top-level-enum: '#/definitions/DrPlanLifecycleState'
schema:
type: string
enum:
- CREATING
- UPDATING
- ACTIVE
- INACTIVE
- DELETING
- DELETED
- FAILED
- NEEDS_ATTENTION
DisplayNameQueryParam:
description: 'A filter to return only resources that match the given display name.
Example: `MyResourceDisplayName`
'
in: query
name: displayName
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
PaginationTokenQueryParam:
description: '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).
'
in: query
name: page
schema:
type: string
minLength: 1
DrProtectionGroupRoleQueryParam:
description: The DR protection group Role.
in: query
name: role
required: false
x-default-description: 'null'
x-obmcs-top-level-enum: '#/definitions/DrProtectionGroupRole'
schema:
type: string
enum:
- PRIMARY
- STANDBY
- UNCONFIGURED
DrPlanLifecycleSubStateQueryParam:
description: 'A filter to return only DR plans that match the given lifecycle sub-state.
'
in: query
name: lifecycleSubState
required: false
x-default-description: 'null'
x-obmcs-top-level-enum: '#/definitions/DrPlanLifecycleSubState'
schema:
type: string
enum:
- NEEDS_REFRESH
- NEEDS_VERIFICATION
- REFRESHING
- VERIFYING
DrProtectionGroupLifecycleStateQueryParam:
description: 'A filter to return only DR protection groups that match the given lifecycle state.
'
in: query
name: lifecycleState
required: false
x-default-description: 'null'
x-obmcs-top-level-enum: '#/definitions/DrProtectionGroupLifecycleState'
schema:
type: string
enum:
- CREATING
- ACTIVE
- UPDATING
- INACTIVE
- NEEDS_ATTENTION
- DELETING
- DELETED
- FAILED
WorkRequestIdQueryParam:
description: 'The ID (OCID) of the asynchronous work request.
Example: `ocid1.workrequest.oc1..uniqueID`
'
in: query
name: workRequestId
x-default-description: 'null'
schema:
type: string
AutomaticDrConfigurationLifecycleStateNotEqualToQueryParam:
description: 'A filter to return only Automatic DR configurations that do not match the given lifecycle state.
'
in: query
name: lifecycleStateNotEqualTo
required: false
x-default-description: 'null'
x-obmcs-top-level-enum: '#/definitions/AutomaticDrConfigurationLifecycleState'
schema:
type: string
enum:
- CREATING
- UPDATING
- ACTIVE
- INACTIVE
- NEEDS_ATTENTION
- DELETING
- DELETED
- FAILED
RetryTokenHeader:
description: 'A token that uniquely identifies a request so it can be retried in case of a timeout or
server error without risk of executing that same action again. Retry tokens expire after 24
hours, but can be invalidated before then due to conflicting operations. For example, if a resource
has been deleted and purged from the system, then a retry of the original creation request
might be rejected.
'
in: header
name: opc-retry-token
required: false
schema:
type: string
maxLength: 64
minLength: 1
WorkRequestSortByQueryParam:
description: 'The field to sort by. Only one sort order may be provided.
Default order for timeAccepted is descending.
'
in: query
name: sortBy
schema:
type: string
enum:
- timeAccepted
default: timeAccepted
DrProtectionGroupLifecycleSubStateQueryParam:
description: 'A filter to return only DR protection groups that match the given lifecycle sub-state.
'
in: query
name: lifecycleSubState
required: false
x-default-description: 'null'
x-obmcs-top-level-enum: '#/definitions/DrProtectionGroupLifecycleSubState'
schema:
type: string
enum:
- DR_DRILL_IN_PROGRESS
- DR_PLAN_EXECUTION_IN_PROGRESS
- AUTOMATIC_DR_PLAN_EXECUTION_IN_PROGRESS
AutomaticDrConfigurationLifecycleStateQueryParam:
description: 'A filter to return only Automatic DR configurations that match the given lifecycle state.
'
in: query
name: lifecycleState
required: false
x-default-description: 'null'
x-obmcs-top-level-enum: '#/definitions/AutomaticDrConfigurationLifecycleState'
schema:
type: string
enum:
- CREATING
- UPDATING
- ACTIVE
- INACTIVE
- NEEDS_ATTENTION
- DELETING
- DELETED
- FAILED
CompartmentIdQueryParam:
description: 'The ID (OCID) of the compartment in which to list resources.
Example: `ocid1.compartment.oc1..uniqueID`
'
in: query
name: compartmentId
required: false
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
PaginationLimitQueryParam:
description: 'For list pagination. The maximum number of results per page,
or items to return in a paginated "List" call.
1 is the minimum, 1000 is the maximum.
For important details about how pagination works,
see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
Example: `100`
'
in: query
name: limit
schema:
type: integer
default: 10
maximum: 1000
minimum: 1
CompartmentIdMandatoryQueryParam:
description: 'The ID (OCID) of the compartment in which to list resources.
Example: `ocid1.compartment.oc1..uniqueID`
'
in: query
name: compartmentId
required: true
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
DrProtectionGroupIdQueryParam:
description: 'The OCID of the DR protection group. Optional query param.
Example: `ocid1.drprotectiongroup.oc1..uniqueID`
'
in: query
name: drProtectionGroupId
required: false
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
schemas:
UpdateDrPlanExecutionDetails:
description: The details for updating a DR plan exection.
properties:
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: 'The display name of the DR protection group to update.
Example: `EBS IAD Group`
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"Department": "Finance"}`
'
type: object
type: object
x-example: "{\n \"displayName\": \"Switchover From IAD To PHX\",\n \"freeformTags\": {\n \"Department\": \"Finance\"\n },\n \"definedTags\": {\n \"Operations\": {\n \"CostCenter\": \"42\"\n }\n }\n}\n"
UpdateObjectStorageLogLocationDetails:
description: The details for updating an object storage log location for a DR protection group.
properties:
bucket:
description: 'The bucket name inside the object storage namespace.
Example: `operation_logs`
'
maxLength: 255
minLength: 1
type: string
namespace:
description: 'The namespace in object storage (Note - this is usually the tenancy name).
Example: `myocitenancy`
'
maxLength: 255
minLength: 1
type: string
required:
- namespace
- bucket
type: object
x-example: "{\n \"namespace\": \"namespace_string\",\n \"bucket\": \"bucket_name\"\n}\n"
DrPlanExecutionSummary:
description: The summary of a DR plan execution.
properties:
compartmentId:
description: 'The OCID of the compartment containing this plan execution.
Example: `ocid1.compartment.oc1..uniqueID`
'
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: 'The display name of the DR plan execution.
Example: `Execution - EBS Switchover PHX to IAD`
'
maxLength: 1024
minLength: 1
type: string
drProtectionGroupId:
description: 'The OCID of the DR protection group to which this DR plan execution belongs.
Example: `ocid1.drprotectiongroup.oc1..uniqueID`
'
maxLength: 255
minLength: 1
type: string
executionDurationInSec:
description: 'The total duration in seconds taken to complete the DR plan execution.
Example: `750`
'
format: int32
type: integer
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"Department": "Finance"}`
'
type: object
id:
description: 'The OCID of the DR plan execution.
Example: `ocid1.drplanexecution.oc1..uniqueID`
'
maxLength: 255
minLength: 1
type: string
lifeCycleDetails:
description: 'A message describing the DR plan execution''s current state in more detail.
'
type: string
lifecycleState:
description: 'The current state of the DR plan execution.
'
enum:
- ACCEPTED
- IN_PROGRESS
- WAITING
- CANCELING
- CANCELED
- SUCCEEDED
- FAILED
- DELETING
- DELETED
- PAUSING
- PAUSED
- RESUMING
type: string
x-obmcs-top-level-enum: '#/definitions/DrPlanExecutionLifecycleState'
logLocation:
$ref: '#/components/schemas/ObjectStorageLogLocation'
peerDrProtectionGroupId:
description: 'The OCID of peer DR protection group associated with this DR plan execution''s
DR protection group.
Example: `ocid1.drprotectiongroup.oc1..uniqueID`
'
maxLength: 255
minLength: 1
type: string
peerRegion:
description: 'The region of the peer DR protection group associated with this DR plan execution''s
DR protection group.
Example: `us-ashburn-1`
'
maxLength: 255
minLength: 1
type: string
planExecutionType:
description: 'The type of the DR plan execution.
'
enum:
- SWITCHOVER
- SWITCHOVER_PRECHECK
- FAILOVER
- FAILOVER_PRECHECK
- START_DRILL
- START_DRILL_PRECHECK
- STOP_DRILL
- STOP_DRILL_PRECHECK
type: string
x-obmcs-top-level-enum: '#/definitions/DrPlanExecutionType'
planId:
description: 'The OCID of the DR plan for this DR plan execution.
Example: `ocid1.drplan.oc1..uniqueID`
'
maxLength: 255
minLength: 1
type: string
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.
Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
'
type: object
timeCreated:
description: 'The date and time at which DR plan execution was created. An RFC3339 formatted datetime string.
Example: `2019-03-29T09:36:42Z`
'
format: date-time
type: string
timeEnded:
description: 'The date and time at which DR plan execution succeeded, failed, was paused, or canceled.
An RFC3339 formatted datetime string.
Example: `2019-03-29T09:36:42Z`
'
format: date-time
type: string
timeStarted:
description: 'The date and time at which DR plan execution began. An RFC3339 formatted datetime string.
Example: `2019-03-29T09:36:42Z`
'
format: date-time
type: string
timeUpdated:
description: 'The time when this DR plan execution was last updated.
Example: `2019-03-29T09:36:42Z`
'
format: date-time
type: string
required:
- id
- compartmentId
- displayName
- planId
- planExecutionType
- drProtectionGroupId
- peerDrProtectionGroupId
- peerRegion
- logLocation
- timeCreated
- timeUpdated
- lifecycleState
type: object
x-example: "{\n \"id\": \"ocid1.drplanexecution.oc1..uniqueID\",\n \"compartmentId\": \"ocid1.compartment.oc1..uniqueID\",\n \"displayName\": \"Execution - EBS Switchover PHX to IAD\",\n \"planId\": \"ocid1.drplan.oc1..uniqueID\",\n \"planExecutionType\": \"SWITCHOVER\",\n \"drProtectionGroupId\": \"ocid1.drprotectiongroup.oc1..uniqueID1\",\n \"peerDrProtectionGroupId\": \"ocid1.drprotectiongroup.oc1..uniqueID2\",\n \"peerRegion\": \"us-ashburn-1\",\n \"logLocation\": {\n \"namespace\": \"namespace_string\",\n \"bucket\": \"bucket_name\",\n \"object\": \"object_name\"\n },\n \"timeCreated\": \"2023-09-07T22:37:18.153Z\",\n \"timeStarted\": \"2023-09-07T22:39:18.253Z\",\n \"timeUpdated\": \"2023-09-07T22:39:45.354Z\",\n \"timeEnded\": \"2023-09-07T22:57:42.389Z\",\n \"executionDurationInSec\": 1224,\n \"lifecycleState\": \"SUCCEEDED\",\n \"lifeCycleDetails\": \"\",\n \"freeformTags\": {\n \"Department\": \"Finance\"\n },\n \"definedTags\": {\n \"Operations\": {\n \"CostCenter\": \"42\"\n }\n }\n}\n"
Error:
description: Error information.
properties:
code:
description: 'A short error code that defines the error, meant for programmatic parsing.
Example: `429`
'
type: string
message:
description: 'A human-readable error string.
Example: `Too many requests`
'
type: string
required:
- code
- message
DrPlanExecutionWarningStepStatusCounts:
description: 'A summary of steps that encountered warnings during a DR plan execution.
'
properties:
totalWarnings:
description: 'The total number of steps that encountered warnings in a DR plan execution.
'
format: int32
type: integer
warningsIgnored:
description: 'The total number of steps with warnings that were ignored during a DR plan execution.
'
format: int32
type: integer
required:
- totalWarnings
- warningsIgnored
type: object
x-example: "{\n \"totalWarnings\": 2,\n \"warningsIgnored\": 2\n}\n"
AutomaticDrConfigurationMember:
description: Details of a member in an Automatic DR configuration.
discriminator:
propertyName: memberType
properties:
memberId:
description: 'The unique id of the member. Must not be modified by user.
Example: `ocid1.database.oc1..uniqueID`
'
maxLength: 255
minLength: 1
type: string
memberType:
description: 'The type of the member.
'
enum:
- DATABASE
- AUTONOMOUS_DATABASE
- AUTONOMOUS_CONTAINER_DATABASE
type: string
x-obmcs-top-level-enum: '#/definitions/AutomaticDrConfigurationMemberType'
required:
- memberId
- memberType
type: object
x-example: "{\n \"memberId\": \"ocid1.autonomousdatabase.oc1..uniqueID\",\n \"memberType\": \"AUTONOMOUS_DATABASE\"\n}\n"
DrPlanStepExecution:
description: The details of a step execution in a DR plan execution.
properties:
displayName:
description: 'The display name of the step execution.
Example: `DATABASE_SWITCHOVER`
'
maxLength: 255
minLength: 1
type: string
executionDurationInSec:
description: 'The total duration in seconds taken to complete the step execution.
Example: `35`
'
format: int32
type: integer
groupId:
description: 'The unique id of the group to which this step belongs. Must not be modified by user.
Example: `sgid1.group..uniqueID`
'
maxLength: 255
minLength: 1
type: string
logLocation:
$ref: '#/components/schemas/ObjectStorageLogLocation'
status:
description: 'The status of the step execution.
'
enum:
- QUEUED
- DISABLED
- IN_PROGRESS
- SUCCEEDED
- SUCCEEDED_WITH_WARNING
- FAILED
- FAILED_IGNORED
- TIMED_OUT
- TIMED_OUT_IGNORED
- PAUSED
- CANCELED
type: string
x-obmcs-top-level-enum: '#/definitions/DrPlanStepExecutionStatus'
statusDetails:
description: 'Additional details on the step execution status.
Example: `This step failed to complete due to a timeout`
'
type: string
stepId:
description: 'The unique id of the step. Must not be modified by user.
Example: `sgid1.step..uniqueID`
'
maxLength: 255
minLength: 1
type: string
timeEnded:
description: 'The time when execution ended. An RFC3339 formatted datetime string.
Example: `2019-03-29T09:36:42Z`
'
format: date-time
type: string
timeStarted:
description: 'The time when step execution began. An RFC3339 formatted datetime string.
Example: `2019-03-29T09:36:42Z`
'
format: date-time
type: string
type:
description: 'The step type.
'
enum:
- COMPUTE_INSTANCE_STOP_PRECHECK
- COMPUTE_INSTANCE_LAUNCH_PRECHECK
- COMPUTE_INSTANCE_TERMINATE_PRECHECK
- COMPUTE_INSTANCE_REMOVE_PRECHECK
- VOLUME_GROUP_RESTORE_SWITCHOVER_PRECHECK
- VOLUME_GROUP_RESTORE_FAILOVER_PRECHECK
- DATABASE_SWITCHOVER_PRECHECK
- DATABASE_FAILOVER_PRECHECK
- AUTONOMOUS_DATABASE_SWITCHOVER_PRECHECK
- AUTONOMOUS_DATABASE_FAILOVER_PRECHECK
- AUTONOMOUS_CONTAINER_DATABASE_SWITCHOVER_PRECHECK
- AUTONOMOUS_CONTAINER_DATABASE_FAILOVER_PRECHECK
- AUTONOMOUS_CONTAINER_DATABASE_START_DRILL_CONVERT_TO_SNAPSHOT_STANDBY_PRECHECK
- AUTONOMOUS_CONTAINER_DATABASE_STOP_DRILL_CONVERT_TO_PHYSICAL_STANDBY_PRECHECK
- AUTONOMOUS_CONTAINER_DATABASE_SWITCHOVER
- AUTONOMOUS_CONTAINER_DATABASE_FAILOVER
- AUTONOMOUS_CONTAINER_DATABASE_START_DRILL_CONVERT_TO_SNAPSHOT_STANDBY
- AUTONOMOUS_CONTAINER_DATABASE_STOP_DRILL_CONVERT_TO_PHYSICAL_STANDBY
- AUTONOMOUS_DATABASE_START_DRILL_CREATE_CLONE_STANDBY_PRECHECK
- AUTONOMOUS_DATABASE_STOP_DRILL_DELETE_CLONE_STANDBY_PRECHECK
- AUTONOMOUS_DATABASE_START_DRILL_CONVERT_TO_SNAPSHOT_STANDBY_PRECHECK
- AUTONOMOUS_DATABASE_STOP_DRILL_CONVERT_TO_PHYSICAL_STANDBY_PRECHECK
- AUTONOMOUS_DATABASE_START_DRILL_CREATE_CLONE_STANDBY
- AUTONOMOUS_DATABASE_STOP_DRILL_DELETE_CLONE_STANDBY
- AUTONOMOUS_DATABASE_START_DRILL_CONVERT_TO_SNAPSHOT_STANDBY
- AUTONOMOUS_DATABASE_STOP_DRILL_CONVERT_TO_PHYSICAL_STANDBY
- DATABASE_START_DRILL_CONVERT_TO_SNAPSHOT_STANDBY_PRECHECK
- DATABASE_STOP_DRILL_CONVERT_TO_PHYSICAL_STANDBY_PRECHECK
- DATABASE_START_DRILL_CONVERT_TO_SNAPSHOT_STANDBY
- DATABASE_STOP_DRILL_CONVERT_TO_PHYSICAL_STANDBY
- USER_DEFINED_PRECHECK
- COMPUTE_INSTANCE_LAUNCH
- COMPUTE_INSTANCE_STOP
- COMPUTE_INSTANCE_TERMINATE
- COMPUTE_INSTANCE_REMOVE
- DATABASE_SWITCHOVER
- DATABASE_FAILOVER
- AUTONOMOUS_DATABASE_SWITCHOVER
- AUTONOMOUS_DATABASE_FAILOVER
- VOLUME_GROUP_RESTORE_SWITCHOVER
- VOLUME_GROUP_RESTORE_FAILOVER
- VOLUME_GROUP_REVERSE
- VOLUME_GROUP_DELETE
- VOLUME_GROUP_REMOVE
- VOLUME_GROUP_TERMINATE
- USER_DEFINED
- USER_DEFINED_CUSTOM_PRECHECK
- VOLUME_GROUP_RESTORE_START_DRILL_PRECHECK
- VOLUME_GROUP_REMOVE_PRECHECK
- VOLUME_GROUP_TERMINATE_PRECHECK
- VOLUME_GROUP_RESTORE_START_DRILL
- AUTONOMOUS_DATABASE_CREATE_CLONE_PRECHECK
- AUTONOMOUS_DATABASE_DELETE_CLONE_PRECHECK
- LOAD_BALANCER_UPDATE_PRIMARY_BACKEND_SET_PRECHECK
- LOAD_BALANCER_UPDATE_STANDBY_BACKEND_SET_PRECHECK
- FILE_SYSTEM_SWITCHOVER_PRECHECK
- FILE_SYSTEM_FAILOVER_PRECHECK
- FILE_SYSTEM_START_DRILL_PRECHECK
- FILE_SYSTEM_STOP_DRILL_PRECHECK
- FILE_SYSTEM_REMOVE_PRECHECK
- FILE_SYSTEM_TERMINATE_PRECHECK
- FILE_SYSTEM_MOUNT_PRECHECK
- FILE_SYSTEM_UNMOUNT_PRECHECK
- COMPUTE_INSTANCE_START_PRECHECK
- COMPUTE_INSTANCE_ATTACH_BLOCK_VOLUMES_PRECHECK
- COMPUTE_INSTANCE_DETACH_BLOCK_VOLUMES_PRECHECK
- COMPUTE_INSTANCE_MOUNT_BLOCK_VOLUMES_PRECHECK
- COMPUTE_INSTANCE_UNMOUNT_BLOCK_VOLUMES_PRECHECK
- COMPUTE_CAPACITY_RESERVATION_START_DRILL_PRECHECK
- COMPUTE_CAPACITY_AVAILABILITY_START_DRILL_PRECHECK
- AUTONOMOUS_DATABASE_CREATE_CLONE
- AUTONOMOUS_DATABASE_DELETE_CLONE
- LOAD_BALANCER_UPDATE_PRIMARY_BACKEND_SET
- LOAD_BALANCER_UPDATE_STANDBY_BACKEND_SET
- FILE_SYSTEM_SWITCHOVER
- FILE_SYSTEM_FAILOVER
- FILE_SYSTEM_REMOVE
- FILE_SYSTEM_REVERSE
- FILE_SYSTEM_TERMINATE
- FILE_SYSTEM_START_DRILL
- FILE_SYSTEM_STOP_DRILL
- COMPUTE_INSTANCE_START
- COMPUTE_INSTANCE_ATTACH_BLOCK_VOLUMES
- COMPUTE_INSTANCE_DETACH_BLOCK_VOLUMES
- FILE_SYSTEM_MOUNT
- FILE_SYSTEM_UNMOUNT
- COMPUTE_CAPACITY_RESERVATION_SWITCHOVER_PRECHECK
- COMPUTE_CAPACITY_RESERVATION_FAILOVER_PRECHECK
- COMPUTE_CAPACITY_AVAILABILITY_SWITCHOVER_PRECHECK
- COMPUTE_CAPACITY_AVAILABILITY_FAILOVER_PRECHECK
- OKE_CLUSTER_SWITCHOVER_CLEANUP_PRIMARY_PRECHECK
- OKE_CLUSTER_SWITCHOVER_RESTORE_STANDBY_PRECHECK
- OKE_CLUSTER_FAILOVER_RESTORE_STANDBY_PRECHECK
- OKE_CLUSTER_STOP_DRILL_CLEANUP_STANDBY_PRECHECK
- OKE_CLUSTER_START_DRILL_RESTORE_STANDBY_PRECHECK
- OKE_CLUSTER_SWITCHOVER_CLEANUP_PRIMARY
- OKE_CLUSTER_SWITCHOVER_SCALE_UP_STANDBY
- OKE_CLUSTER_SWITCHOVER_RESTORE_STANDBY
- OKE_CLUSTER_SWITCHOVER_REVERSE_BACKUP_STANDBY
- OKE_CLUSTER_SWITCHOVER_SCALE_DOWN_PRIMARY
- OKE_CLUSTER_FAILOVER_RESTORE_STANDBY
- OKE_CLUSTER_FAILOVER_SCALE_UP_STANDBY
- OKE_CLUSTER_START_DRILL_RESTORE_STANDBY
- OKE_CLUSTER_START_DRILL_SCALE_UP_STANDBY
- OKE_CLUSTER_STOP_DRILL_CLEANUP_STANDBY
- OKE_CLUSTER_STOP_DRILL_SCALE_DOWN_STANDBY
- OBJECT_STORAGE_BUCKET_SWITCHOVER_DELETE_REPLICATION_PRIMARY_PRECHECK
- OBJECT_STORAGE_BUCKET_SWITCHOVER_SETUP_REVERSE_REPLICATION_STANDBY_PRECHECK
- OBJECT_STORAGE_BUCKET_FAILOVER_DELETE_REPLICATION_STANDBY_PRECHECK
- OBJECT_STORAGE_BUCKET_FAILOVER_SETUP_REVERSE_REPLICATION_STANDBY_PRECHECK
- OBJECT_STORAGE_BUCKET_SWITCHOVER_DELETE_REPLICATION_PRIMARY
- OBJECT_STORAGE_BUCKET_SWITCHOVER_SETUP_REVERSE_REPLICATION_STANDBY
- OBJECT_STORAGE_BUCKET_FAILOVER_DELETE_REPLICATION_STANDBY
- OBJECT_STORAGE_BUCKET_FAILOVER_SETUP_REVERSE_REPLICATION_STANDBY
- MYSQL_DB_SYSTEM_SWITCHOVER_PRECHECK
- MYSQL_DB_SYSTEM_SWITCHOVER
- MYSQL_DB_SYSTEM_FAILOVER_PRECHECK
- MYSQL_DB_SYSTEM_FAILOVER
- MYSQL_DB_SYSTEM_START_DRILL_PRECHECK
- MYSQL_DB_SYSTEM_START_DRILL
- MYSQL_DB_SYSTEM_STOP_DRILL_PRECHECK
- MYSQL_DB_SYSTEM_STOP_DRILL
- INTEGRATION_INSTANCE_SWITCHOVER_PRECHECK
- INTEGRATION_INSTANCE_SWITCHOVER
- INTEGRATION_INSTANCE_FAILOVER_PRECHECK
- INTEGRATION_INSTANCE_FAILOVER
type: string
x-obmcs-top-level-enum: '#/definitions/DrPlanStepType'
typeDisplayName:
description: 'The display name of the DR Plan step type.
Example: `Database Switchover`
'
maxLength: 255
minLength: 1
type: string
required:
- stepId
- type
- groupId
- displayName
- typeDisplayName
- logLocation
- status
type: object
x-example: "{\n \"stepId\": \"sgid1.step..uniqueID\",\n \"type\": \"COMPUTE_INSTANCE_LAUNCH\",\n \"groupId\": \"sgid1.group..uniqueID\",\n \"displayName\": \"myhost1\",\n \"logLocation\": {\n \"namespace\": \"namespace_string\",\n \"bucket\": \"bucket_name\",\n \"object\": \"object_name\"\n },\n \"status\": \"SUCCEEDED\",\n \"statusDetails\": \"\",\n \"timeStarted\": \"2023-09-07T22:39:19.253Z\",\n \"timeEnded\": \"2023-09-07T22:39:21.253Z\",\n \"executionDurationInSec\": 120\n}\n"
UpdateDrPlanUserDefinedStepDetails:
description: The details for updating a user-defined step in a DR plan.
discriminator:
propertyName: stepType
properties:
stepType:
description: "The type of the user-defined step.\n\n **RUN_OBJECTSTORE_SCRIPT_PRECHECK** - A built-in step which performs a precheck on a script stored\n in OCI object storage. This step cannot be added, deleted, or customized by the user.\n\n **RUN_LOCAL_SCRIPT_PRECHECK** - A built-in step which performs a precheck on a script which resides\n locally on a compute instance. This step cannot be added, deleted, or customized by the user.\n\n **INVOKE_FUNCTION_PRECHECK** - A built-in step which performs a precheck on an OCI function. This \n step cannot be added, deleted, or customized by the user.\n See https://docs.oracle.com/en-us/iaas/Content/Functions/home.htm.\n\n **RUN_OBJECTSTORE_SCRIPT** - A step which runs a script stored in OCI object storage.\n\n **RUN_LOCAL_SCRIPT** - A step which runs a script that resides locally on a compute instance.\n\n **INVOKE_FUNCTION** - A step which invokes an OCI function.\n See https://docs.oracle.com/en-us/iaas/Content/Functions/home.htm.\n\n **RUN_OBJECTSTORE_SCRIPT_USER_DEFINED_CUSTOM_PRECHECK** - A user-defined step which performs a precheck by executing a user-provided script stored\n in OCI object storage.\n\n **RUN_LOCAL_SCRIPT_USER_DEFINED_CUSTOM_PRECHECK** - A user-defined step which performs a precheck by executing a user-provided script which resides\n locally on a compute instance.\n\n **INVOKE_FUNCTION_USER_DEFINED_CUSTOM_PRECHECK** - A user-defined step which performs a precheck by executing a user-provided OCI function.\n See https://docs.oracle.com/en-us/iaas/Content/Functions/home.htm.\n"
enum:
- RUN_OBJECTSTORE_SCRIPT_PRECHECK
- RUN_LOCAL_SCRIPT_PRECHECK
- INVOKE_FUNCTION_PRECHECK
- RUN_OBJECTSTORE_SCRIPT
- RUN_LOCAL_SCRIPT
- INVOKE_FUNCTION
- RUN_OBJECTSTORE_SCRIPT_USER_DEFINED_CUSTOM_PRECHECK
- RUN_LOCAL_SCRIPT_USER_DEFINED_CUSTOM_PRECHECK
- INVOKE_FUNCTION_USER_DEFINED_CUSTOM_PRECHECK
type: string
required:
- stepType
x-example: "Example for updating a user-defined step for a script stored in object storage.\n{\n \"stepType\": \"OBJECTSTORE_SCRIPT\",\n \"runOnInstanceId\": \"ocid1.instance.oc1..uniqueID\",\n \"runOnInstanceRegion\": \"us-ashburn-1\",\n \"objectStorageScriptLocation\": {\n \"namespace\": \"namespace_string\",\n \"bucket\": \"bucket_name\"\n \"object\": \"script.py\"\n }\n}\n\nExample for updating a user-defined step for a script that resides locally on a host.\n{\n \"stepType\": \"RUN_LOCAL_SCRIPT\",\n \"runOnInstanceId\": \"ocid1.instance.oc1..uniqueID\",\n \"runOnInstanceRegion\": \"us-ashburn-1\",\n \"scriptCommand\": \"/home/oracle/scripts/myscript.sh\",\n \"runAsUser\": \"oracle\"\n}\n\nExample for updating a user-defined step for an OCI function.\n{\n \"stepType\": \"INVOKE_FUNCTION\",\n \"functionId\": \"ocid1.fnfunc.oc1..uniqueID\",\n \"functionRegion\": \"us-ashburn-1\",\n \"requestBody\": \"{\\\"name\\\": \\\"John\\\"}\"\n}\n\nExample for updating a user-defined custom precheck step for a script stored in object storage.\n{\n \"stepType\": \"RUN_OBJECTSTORE_SCRIPT_USER_DEFINED_CUSTOM_PRECHECK\",\n \"runOnInstanceId\": \"ocid1.instance.oc1..uniqueID\",\n \"runOnInstanceRegion\": \"us-ashburn-1\",\n \"objectStorageScriptLocation\": {\n \"namespace\": \"namespace_string\",\n \"bucket\": \"bucket_name\"\n \"object\": \"script.py\"\n }\n}\n\nExample for updating a user-defined custom precheck step for a script that resides locally on a host.\n{\n \"stepType\": \"RUN_LOCAL_SCRIPT_USER_DEFINED_CUSTOM_PRECHECK\",\n \"runOnInstanceId\": \"ocid1.instance.oc1..uniqueID\",\n \"runOnInstanceRegion\": \"us-ashburn-1\",\n \"scriptCommand\": \"/home/oracle/scripts/myscript.sh\",\n \"runAsUser\": \"oracle\"\n}\n\nExample for updating a user-defined custom precheck step for an OCI function.\n{\n \"stepType\": \"INVOKE_FUNCTION_USER_DEFINED_CUSTOM_PRECHECK\",\n \"functionId\": \"ocid1.fnfunc.oc1..uniqueID\",\n \"functionRegion\": \"us-ashburn-1\",\n \"requestBody\": \"{\\\"name\\\": \\\"John\\\"}\"\n}\n"
CreateDrPlanDetails:
description: The details for creating a DR plan.
properties:
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: 'The display name of the DR plan being created.
Example: `EBS Switchover PHX to IAD`
'
maxLength: 1024
minLength: 1
type: string
drProtectionGroupId:
description: 'The OCID of the DR protection group to which this DR plan belongs.
Example: `ocid1.drprotectiongroup.oc1..uniqueID`
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"Department": "Finance"}`
'
type: object
sourcePlanId:
description: 'The OCID of the source DR plan that should be cloned.
Example: `ocid1.drplan.oc1..uniqueID`
'
maxLength: 255
minLength: 1
type: string
type:
description: 'The type of DR plan to be created.
'
enum:
- SWITCHOVER
- FAILOVER
- START_DRILL
- STOP_DRILL
type: string
x-obmcs-top-level-enum: '#/definitions/DrPlanType'
required:
- displayName
- type
- drProtectionGroupId
type: object
x-example: "{\n \"drProtectionGroupId\": \"ocid1.drprotectiongroup.oc1..uniqueID\",\n \"displayName\": \"Switchover From IAD To PHX\",\n \"type\": \"SWITCHOVER\",\n \"freeformTags\": {\n \"Department\": \"Finance\"\n },\n \"definedTags\": {\n \"Operations\": {\n \"CostCenter\": \"42\"\n }\n }\n}\n"
WorkRequestSummaryCollection:
description: 'The results of a workRequestSummary search. Contains both WorkRequestSummary items
and other information, such as metadata.
'
properties:
items:
description: 'A list of work request summaries.
'
items:
$ref: '#/components/schemas/WorkRequestSummary'
type: array
required:
- items
type: object
x-example: "{\n \"items\": [ \n {\n \"operationType\": \"CREATE_DR_PROTECTION_GROUP\",\n \"status\": \"ACCEPTED\",\n \"id\": \"ocid1.drworkrequest.oc1..uniqueID\",\n \"compartmentId\": \"ocid1.compartment.oc1..uniqueID\",\n \"resources\": [\n {\n \"entityType\": \"drprotectiongroup\",\n \"actionType\": \"CREATED\",\n \"identifier\": \"ocid1.drprotectiongroup.oc1..uniqueID\",\n \"entityUri\": \"/drProtectionGroups/ocid1.drprotectiongroup.oc1..uniqueID\"\n }\n ],\n \"percentComplete\": 100.0,\n \"timeAccepted\": \"2023-09-07T23:55:52.028Z\",\n \"timeStarted\": \"2023-09-07T23:56:05.094Z\",\n \"timeFinished\": \"2023-09-07T23:59:32.018Z\"\n }\n ]\n}\n"
VerifyDrPlanDetails:
description: The details for verifying a DR plan.
discriminator:
propertyName: type
properties:
type:
description: 'The default type.
'
enum:
- DEFAULT
type: string
required:
- type
type: object
x-example: "{\n \"type\": \"DEFAULT\"\n}\n"
UpdateDrPlanDetails:
description: The details for updating a DR plan.
properties:
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: 'The display name of the DR plan being updated.
Example: `EBS Switchover PHX to IAD`
'
maxLength: 1024
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"Department": "Finance"}`
'
type: object
planGroups:
description: 'An ordered list of groups in a DR plan.
'
items:
$ref: '#/components/schemas/UpdateDrPlanGroupDetails'
type: array
type: object
x-example: "{\n \"displayName\": \"Switchover From IAD To PHX\",\n \"planGroups\": [\n {\n \"id\": \"sgid1.group..uniqueID\",\n \"type\": \"BUILT_IN_PRECHECK\",\n \"displayName\": \"Built-In Prechecks\",\n \"steps\": [\n {\n \"id\": \"sgid1.step..uniqueID\",\n \"groupId\": \"sgid1.group..uniqueID\",\n \"memberId\": \"ocid1.volumegroup.oc1..uniqueID\",\n \"type\": \"VOLUME_GROUP_RESTORE_SWITCHOVER_PRECHECK\",\n \"displayName\": \"My Volume Group\",\n \"errorMode\": \"STOP_ON_ERROR\",\n \"timeout\": 3600,\n \"isEnabled\": true,\n \"userDefinedStep\": null\n }\n ]\n }\n ],\n \"freeformTags\": {\n \"Department\": \"Finance\"\n },\n \"definedTags\": {\n \"Operations\": {\n \"CostCenter\": \"42\"\n }\n }\n}\n"
DrPlanStep:
description: Details of a step in a DR plan.
properties:
displayName:
description: 'The display name of the group.
Example: `DATABASE_SWITCHOVER`
'
maxLength: 255
minLength: 1
type: string
errorMode:
description: 'The error mode for this step.
'
enum:
- STOP_ON_ERROR
- CONTINUE_ON_ERROR
type: string
x-obmcs-top-level-enum: '#/definitions/DrPlanStepErrorMode'
groupId:
description: 'The unique id of the group to which this step belongs. Must not be modified by user.
Example: `sgid1.group..uniqueID`
'
maxLength: 255
minLength: 1
type: string
id:
description: 'The unique id of the step. Must not be modified by the user.
Example: `sgid1.step..uniqueID`
'
maxLength: 255
minLength: 1
type: string
isEnabled:
description: 'A flag indicating whether this step should be enabled for execution.
Example: `true`
'
type: boolean
memberId:
description: 'The OCID of the member associated with this step.
Example: `ocid1.database.oc1..uniqueID`
'
maxLength: 255
minLength: 1
type: string
refreshStatus:
description: 'The DR plan step refresh status.
Example: `STEP_ADDED`
'
enum:
- STEP_ADDED
- STEP_DELETED
type: string
x-obmcs-top-level-enum: '#/definitions/DrPlanStepRefreshStatus'
timeout:
description: 'The timeout in seconds for executing this step.
Example: `600`
'
format: int32
maximum: 86400
minimum: 1
type: integer
type:
description: 'The plan step type.
'
enum:
- COMPUTE_INSTANCE_STOP_PRECHECK
- COMPUTE_INSTANCE_LAUNCH_PRECHECK
- COMPUTE_INSTANCE_TERMINATE_PRECHECK
- COMPUTE_INSTANCE_REMOVE_PRECHECK
- VOLUME_GROUP_RESTORE_SWITCHOVER_PRECHECK
- VOLUME_GROUP_RESTORE_FAILOVER_PRECHECK
- DATABASE_SWITCHOVER_PRECHECK
- DATABASE_FAILOVER_PRECHECK
- AUTONOMOUS_DATABASE_SWITCHOVER_PRECHECK
- AUTONOMOUS_DATABASE_FAILOVER_PRECHECK
- AUTONOMOUS_CONTAINER_DATABASE_SWITCHOVER_PRECHECK
- AUTONOMOUS_CONTAINER_DATABASE_FAILOVER_PRECHECK
- AUTONOMOUS_CONTAINER_DATABASE_START_DRILL_CONVERT_TO_SNAPSHOT_STANDBY_PRECHECK
- AUTONOMOUS_CONTAINER_DATABASE_STOP_DRILL_CONVERT_TO_PHYSICAL_STANDBY_PRECHECK
- AUTONOMOUS_CONTAINER_DATABASE_SWITCHOVER
- AUTONOMOUS_CONTAINER_DATABASE_FAILOVER
- AUTONOMOUS_CONTAINER_DATABASE_START_DRILL_CONVERT_TO_SNAPSHOT_STANDBY
- AUTONOMOUS_CONTAINER_DATABASE_STOP_DRILL_CONVERT_TO_PHYSICAL_STANDBY
- AUTONOMOUS_DATABASE_START_DRILL_CREATE_CLONE_STANDBY_PRECHECK
- AUTONOMOUS_DATABASE_STOP_DRILL_DELETE_CLONE_STANDBY_PRECHECK
- AUTONOMOUS_DATABASE_START_DRILL_CONVERT_TO_SNAPSHOT_STANDBY_PRECHECK
- AUTONOMOUS_DATABASE_STOP_DRILL_CONVERT_TO_PHYSICAL_STANDBY_PRECHECK
- AUTONOMOUS_DATABASE_START_DRILL_CREATE_CLONE_STANDBY
- AUTONOMOUS_DATABASE_STOP_DRILL_DELETE_CLONE_STANDBY
- AUTONOMOUS_DATABASE_START_DRILL_CONVERT_TO_SNAPSHOT_STANDBY
- AUTONOMOUS_DATABASE_STOP_DRILL_CONVERT_TO_PHYSICAL_STANDBY
- DATABASE_START_DRILL_CONVERT_TO_SNAPSHOT_STANDBY_PRECHECK
- DATABASE_STOP_DRILL_CONVERT_TO_PHYSICAL_STANDBY_PRECHECK
- DATABASE_START_DRILL_CONVERT_TO_SNAPSHOT_STANDBY
- DATABASE_STOP_DRILL_CONVERT_TO_PHYSICAL_STANDBY
- USER_DEFINED_PRECHECK
- COMPUTE_INSTANCE_LAUNCH
- COMPUTE_INSTANCE_STOP
- COMPUTE_INSTANCE_TERMINATE
- COMPUTE_INSTANCE_REMOVE
- DATABASE_SWITCHOVER
- DATABASE_FAILOVER
- AUTONOMOUS_DATABASE_SWITCHOVER
- AUTONOMOUS_DATABASE_FAILOVER
- VOLUME_GROUP_RESTORE_SWITCHOVER
- VOLUME_GROUP_RESTORE_FAILOVER
- VOLUME_GROUP_REVERSE
- VOLUME_GROUP_DELETE
- VOLUME_GROUP_REMOVE
- VOLUME_GROUP_TERMINATE
- USER_DEFINED
- USER_DEFINED_CUSTOM_PRECHECK
- VOLUME_GROUP_RESTORE_START_DRILL_PRECHECK
- VOLUME_GROUP_REMOVE_PRECHECK
- VOLUME_GROUP_TERMINATE_PRECHECK
- VOLUME_GROUP_RESTORE_START_DRILL
- AUTONOMOUS_DATABASE_CREATE_CLONE_PRECHECK
- AUTONOMOUS_DATABASE_DELETE_CLONE_PRECHECK
- LOAD_BALANCER_UPDATE_PRIMARY_BACKEND_SET_PRECHECK
- LOAD_BALANCER_UPDATE_STANDBY_BACKEND_SET_PRECHECK
- FILE_SYSTEM_SWITCHOVER_PRECHECK
- FILE_SYSTEM_FAILOVER_PRECHECK
- FILE_SYSTEM_START_DRILL_PRECHECK
- FILE_SYSTEM_STOP_DRILL_PRECHECK
- FILE_SYSTEM_REMOVE_PRECHECK
- FILE_SYSTEM_TERMINATE_PRECHECK
- FILE_SYSTEM_MOUNT_PRECHECK
- FILE_SYSTEM_UNMOUNT_PRECHECK
- COMPUTE_INSTANCE_START_PRECHECK
- COMPUTE_INSTANCE_ATTACH_BLOCK_VOLUMES_PRECHECK
- COMPUTE_INSTANCE_DETACH_BLOCK_VOLUMES_PRECHECK
- COMPUTE_INSTANCE_MOUNT_BLOCK_VOLUMES_PRECHECK
- COMPUTE_INSTANCE_UNMOUNT_BLOCK_VOLUMES_PRECHECK
- COMPUTE_CAPACITY_RESERVATION_START_DRILL_PRECHECK
- COMPUTE_CAPACITY_AVAILABILITY_START_DRILL_PRECHECK
- AUTONOMOUS_DATABASE_CREATE_CLONE
- AUTONOMOUS_DATABASE_DELETE_CLONE
- LOAD_BALANCER_UPDATE_PRIMARY_BACKEND_SET
- LOAD_BALANCER_UPDATE_STANDBY_BACKEND_SET
- FILE_SYSTEM_SWITCHOVER
- FILE_SYSTEM_FAILOVER
- FILE_SYSTEM_REMOVE
- FILE_SYSTEM_REVERSE
- FILE_SYSTEM_TERMINATE
- FILE_SYSTEM_START_DRILL
- FILE_SYSTEM_STOP_DRILL
- COMPUTE_INSTANCE_START
- COMPUTE_INSTANCE_ATTACH_BLOCK_VOLUMES
- COMPUTE_INSTANCE_DETACH_BLOCK_VOLUMES
- FILE_SYSTEM_MOUNT
- FILE_SYSTEM_UNMOUNT
- COMPUTE_CAPACITY_RESERVATION_SWITCHOVER_PRECHECK
- COMPUTE_CAPACITY_RESERVATION_FAILOVER_PRECHECK
- COMPUTE_CAPACITY_AVAILABILITY_SWITCHOVER_PRECHECK
- COMPUTE_CAPACITY_AVAILABILITY_FAILOVER_PRECHECK
- OKE_CLUSTER_SWITCHOVER_CLEANUP_PRIMARY_PRECHECK
- OKE_CLUSTER_SWITCHOVER_RESTORE_STANDBY_PRECHECK
- OKE_CLUSTER_FAILOVER_RESTORE_STANDBY_PRECHECK
- OKE_CLUSTER_STOP_DRILL_CLEANUP_STANDBY_PRECHECK
- OKE_CLUSTER_START_DRILL_RESTORE_STANDBY_PRECHECK
- OKE_CLUSTER_SWITCHOVER_CLEANUP_PRIMARY
- OKE_CLUSTER_SWITCHOVER_SCALE_UP_STANDBY
- OKE_CLUSTER_SWITCHOVER_RESTORE_STANDBY
- OKE_CLUSTER_SWITCHOVER_REVERSE_BACKUP_STANDBY
- OKE_CLUSTER_SWITCHOVER_SCALE_DOWN_PRIMARY
- OKE_CLUSTER_FAILOVER_RESTORE_STANDBY
- OKE_CLUSTER_FAILOVER_SCALE_UP_STANDBY
- OKE_CLUSTER_START_DRILL_RESTORE_STANDBY
- OKE_CLUSTER_START_DRILL_SCALE_UP_STANDBY
- OKE_CLUSTER_STOP_DRILL_CLEANUP_STANDBY
- OKE_CLUSTER_STOP_DRILL_SCALE_DOWN_STANDBY
- OBJECT_STORAGE_BUCKET_SWITCHOVER_DELETE_REPLICATION_PRIMARY_PRECHECK
- OBJECT_STORAGE_BUCKET_SWITCHOVER_SETUP_REVERSE_REPLICATION_STANDBY_PRECHECK
- OBJECT_STORAGE_BUCKET_FAILOVER_DELETE_REPLICATION_STANDBY_PRECHECK
- OBJECT_STORAGE_BUCKET_FAILOVER_SETUP_REVERSE_REPLICATION_STANDBY_PRECHECK
- OBJECT_STORAGE_BUCKET_SWITCHOVER_DELETE_REPLICATION_PRIMARY
- OBJECT_STORAGE_BUCKET_SWITCHOVER_SETUP_REVERSE_REPLICATION_STANDBY
- OBJECT_STORAGE_BUCKET_FAILOVER_DELETE_REPLICATION_STANDBY
- OBJECT_STORAGE_BUCKET_FAILOVER_SETUP_REVERSE_REPLICATION_STANDBY
- MYSQL_DB_SYSTEM_SWITCHOVER_PRECHECK
- MYSQL_DB_SYSTEM_SWITCHOVER
- MYSQL_DB_SYSTEM_FAILOVER_PRECHECK
- MYSQL_DB_SYSTEM_FAILOVER
- MYSQL_DB_SYSTEM_START_DRILL_PRECHECK
- MYSQL_DB_SYSTEM_START_DRILL
- MYSQL_DB_SYSTEM_STOP_DRILL_PRECHECK
- MYSQL_DB_SYSTEM_STOP_DRILL
- INTEGRATION_INSTANCE_SWITCHOVER_PRECHECK
- INTEGRATION_INSTANCE_SWITCHOVER
- INTEGRATION_INSTANCE_FAILOVER_PRECHECK
- INTEGRATION_INSTANCE_FAILOVER
type: string
x-obmcs-top-level-enum: '#/definitions/DrPlanStepType'
typeDisplayName:
description: 'The display name of the DR Plan step type.
Example: `Database Switchover`
'
maxLength: 255
minLength: 1
type: string
userDefinedStep:
$ref: '#/components/schemas/DrPlanUserDefinedStep'
required:
- id
- groupId
- type
- displayName
- typeDisplayName
- timeout
- errorMode
- isEnabled
type: object
x-example: "{\n \"id\": \"sgid1.step..uniqueID\",\n \"groupId\": \"sgid1.group..uniqueID\",\n \"memberId\": \"ocid1.instance.oc1..uniqueID\",\n \"type\": \"COMPUTE_INSTANCE_LAUNCH\",\n \"displayName\": \"myhost1\",\n \"errorMode\": \"STOP_ON_ERROR\",\n \"timeout\": 86400,\n \"isEnabled\": true,\n \"userDefinedStep\": null\n}\n"
UpdateDrPlanStepDetails:
description: The details for updating a DR plan step.
properties:
displayName:
description: 'The display name of the step in a group.
Example: `My_STEP_3A - EBS Start - STAGE A`
'
maxLength: 255
minLength: 1
type: string
errorMode:
description: "The error mode for this step. \nThe default error mode for the step is `STOP_ON_ERROR`.\n"
enum:
- STOP_ON_ERROR
- CONTINUE_ON_ERROR
type: string
x-obmcs-top-level-enum: '#/definitions/DrPlanStepErrorMode'
id:
description: 'The unique id of the step.
Example: `sgid1.step..uniqueID`
'
maxLength: 255
minLength: 1
type: string
isEnabled:
description: 'A flag indicating whether this step should be enabled for execution.
The default value for the isEnabled flag is `true`.
Example: `true`
'
type: boolean
timeout:
description: "The timeout in seconds for executing this step.\nWhen creating a new step, if no timeout is specified, the default timeout is set to `3600` seconds. \n\nExample: `600`\n"
format: int32
maximum: 86400
minimum: 1
type: integer
userDefinedStep:
$ref: '#/components/schemas/UpdateDrPlanUserDefinedStepDetails'
type: object
x-example: "{\n \"id\": \"sgid1.step..uniqueID\",\n \"groupId\": \"sgid1.group..uniqueID\",\n \"memberId\": \"ocid1.volumegroup.oc1..uniqueID\",\n \"type\": \"VOLUME_GROUP_RESTORE_SWITCHOVER_PRECHECK\",\n \"displayName\": \"My Volume Group\",\n \"errorMode\": \"STOP_ON_ERROR\",\n \"timeout\": 3600,\n \"isEnabled\": true,\n \"userDefinedStep\": null\n}\n"
AutomaticDrConfigurationSummary:
description: The summary of an Automatic DR configuration.
properties:
compartmentId:
description: 'The OCID of the compartment containing the Automatic DR configuration.
Example: `ocid1.compartment.oc1..uniqueID`
'
maxLength: 255
minLength: 1
type: string
defaultFailoverDrPlanId:
description: 'The unique id of a Failover DR Plan.
Example: `ocid1.drplan.oc1..uniqueID`
'
maxLength: 255
minLength: 0
type: string
defaultSwitchoverDrPlanId:
description: 'The unique id of a Switchover DR Plan.
Example: `ocid1.drplan.oc1..uniqueID`
'
maxLength: 255
minLength: 0
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: 'The display name of the Automatic DR configuration.
'
maxLength: 255
minLength: 1
type: string
drProtectionGroupId:
description: 'The OCID of the DR protection group to which this Automatic DR configuration belongs.
Example: `ocid1.drprotectiongroup.oc1..uniqueID`
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"Department": "Finance"}`
'
type: object
id:
description: 'The OCID of the Automatic DR configuration.
Example: `ocid1.automaticdrconfiguration.oc1..uniqueID`
'
maxLength: 255
minLength: 1
type: string
lifecycleDetails:
description: 'A message describing the Automatic DR configuration''s current state in more detail.
'
type: string
lifecycleState:
description: 'The current state of the Automatic DR configuration.
'
enum:
- CREATING
- UPDATING
- ACTIVE
- INACTIVE
- NEEDS_ATTENTION
- DELETING
- DELETED
- FAILED
type: string
x-obmcs-top-level-enum: '#/definitions/AutomaticDrConfigurationLifecycleState'
lifecycleSubState:
description: 'The current sub-state of the Automatic DR configuration.
'
enum:
- RESOURCE_PRINCIPAL_VALIDATION_FAILED
- DR_PLAN_NEEDS_ATTENTION
- DR_PLAN_INACTIVE
type: string
x-obmcs-top-level-enum: '#/definitions/AutomaticDrConfigurationLifecycleSubState'
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.
Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
'
type: object
timeCreated:
description: 'The date and time the Automatic DR configuration was created. An RFC3339 formatted datetime string.
Example: `2024-03-29T09:36:42Z`
'
format: date-time
type: string
timeUpdated:
description: 'The date and time the Automatic DR configuration was updated. An RFC3339 formatted datetime string.
Example: `2024-03-29T09:36:42Z`
'
format: date-time
type: string
required:
- id
- compartmentId
- displayName
- timeCreated
- timeUpdated
- lifecycleState
- drProtectionGroupId
type: object
x-example: "{\n \"id\": \"ocid1.automaticdrconfiguration.oc1..uniqueID\",\n \"displayName\": \"Automatic DR configuration\",\n \"compartmentId\": \"ocid1.compartment.oc1..uniqueID\",\n \"timeCreated\": \"2024-07-05T23:09:45.614Z\",\n \"timeUpdated\": \"2024-07-05T23:09:45.615Z\",\n \"drProtectionGroupId\": \"ocid1.drprotectiongroup.oc1..uniqueID\",\n \"lifecycleState\": \"ACTIVE\",\n \"freeformTags\": {\n \"Department\": \"Finance\"\n },\n \"definedTags\": {\n \"Operations\": {\n \"CostCenter\": \"42\"\n }\n }\n}\n"
DrPlanGroup:
description: Details of a group in a DR plan.
properties:
displayName:
description: 'The display name of the group.
Example: `DATABASE_SWITCHOVER`
'
maxLength: 255
minLength: 1
type: string
id:
description: 'The unique id of the group. Must not be modified by user.
Example: `sgid1.group..uniqueID`
'
maxLength: 255
minLength: 1
type: string
isPauseEnabled:
description: 'A flag indicating whether this group should be enabled for execution.
This flag is only applicable to the `USER_DEFINED_PAUSE` group. The flag should be null for the remaining group types.
Example: `true`
'
type: boolean
refreshStatus:
description: 'The DR plan group refresh status.
Example: `GROUP_MODIFIED`
'
enum:
- GROUP_ADDED
- GROUP_DELETED
- GROUP_MODIFIED
type: string
x-obmcs-top-level-enum: '#/definitions/DrPlanGroupRefreshStatus'
steps:
description: 'The list of steps in the group.
'
items:
$ref: '#/components/schemas/DrPlanStep'
type: array
type:
description: 'The group type.
Example: `BUILT_IN`
'
enum:
- USER_DEFINED
- BUILT_IN
- BUILT_IN_PRECHECK
- USER_DEFINED_PAUSE
type: string
x-obmcs-top-level-enum: '#/definitions/DrPlanGroupType'
required:
- id
- type
- displayName
- steps
type: object
x-example: "{\n \"id\": \"sgid1.group..uniqueID\",\n \"type\": \"BUILT-IN\",\n \"displayName\": \"Launch Compute Instances (Standby)\",\n \"steps\": [\n {\n \"id\": \"sgid1.step..uniqueID\",\n \"groupId\": \"sgid1.group..uniqueID\",\n \"memberId\": \"ocid1.instance.oc1..uniqueID\",\n \"type\": \"COMPUTE_INSTANCE_LAUNCH\",\n \"displayName\": \"myhost1\",\n \"errorMode\": \"STOP_ON_ERROR\",\n \"timeout\": 86400,\n \"isEnabled\": true,\n \"userDefinedStep\": null\n }\n ]\n}\n"
UpdateAutomaticDrConfigurationMemberDetails:
description: Update properties for a member in an Automatic DR configuration.
discriminator:
propertyName: memberType
properties:
memberId:
description: 'The OCID of the member.
Example: `ocid1.database.oc1..uniqueID`
'
maxLength: 255
minLength: 1
type: string
memberType:
description: 'The type of the member.
'
enum:
- DATABASE
- AUTONOMOUS_DATABASE
- AUTONOMOUS_CONTAINER_DATABASE
type: string
x-obmcs-top-level-enum: '#/definitions/AutomaticDrConfigurationMemberType'
required:
- memberId
- memberType
type: object
x-example: "{\n \"memberId\": \"ocid1.autonomousdatabase.oc1..uniqueID\",\n \"memberType\": \"AUTONOMOUS_DATABASE\",\n}\n"
UpdateDrPlanGroupDetails:
description: The details for updating a group in a DR plan.
properties:
displayName:
description: 'The display name of the group.
Example: `My_GROUP_3 - EBS Start`
'
maxLength: 255
minLength: 1
type: string
id:
description: 'The unique id of the group. Must not be modified by user.
Example: `sgid1.group..uniqueID`
'
maxLength: 255
minLength: 1
type: string
isPauseEnabled:
description: 'A flag indicating whether this group should be enabled for execution.
This flag is only applicable to the `USER_DEFINED_PAUSE` group. The flag should be null for the remaining group types.
Example: `true`
'
type: boolean
steps:
description: 'The list of steps in this group.
'
items:
$ref: '#/components/schemas/UpdateDrPlanStepDetails'
type: array
type:
description: 'The group type.
Example: `BUILT_IN`
'
enum:
- USER_DEFINED
- BUILT_IN
- BUILT_IN_PRECHECK
- USER_DEFINED_PAUSE
type: string
x-obmcs-top-level-enum: '#/definitions/DrPlanGroupType'
type: object
x-example: "{\n \"id\": \"sgid1.group..uniqueID\",\n \"type\": \"BUILT_IN_PRECHECK\",\n \"displayName\": \"Built-In Prechecks\",\n \"steps\": [\n {\n \"id\": \"sgid1.step..uniqueID\",\n \"groupId\": \"sgid1.group..uniqueID\",\n \"memberId\": \"ocid1.volumegroup.oc1..uniqueID\",\n \"type\": \"VOLUME_GROUP_RESTORE_SWITCHOVER_PRECHECK\",\n \"displayName\": \"My Volume Group\",\n \"errorMode\": \"STOP_ON_ERROR\",\n \"timeout\": 3600,\n \"isEnabled\": true,\n \"userDefinedStep\": null\n }\n ]\n}\n"
WorkRequestSummary:
description: The summary of a work request.
properties:
compartmentId:
description: 'The OCID of the compartment that contains the work request. Work requests should be scoped to
the same compartment as the resource the work request affects. If the work request affects multiple resources,
and those resources are not in the same compartment, it is up to the service team to pick the primary
resource whose compartment should be used.
Example: `ocid1.compartment.oc1..uniqueID`
'
type: string
id:
description: 'The OCID of the work request.
Example: `ocid1.workrequest.oc1..uniqueID`
'
type: string
operationType:
description: 'The type of the work request.
'
enum:
- CREATE_DR_PROTECTION_GROUP
- UPDATE_DR_PROTECTION_GROUP
- DELETE_DR_PROTECTION_GROUP
- MOVE_DR_PROTECTION_GROUP
- ASSOCIATE_DR_PROTECTION_GROUP
- DISASSOCIATE_DR_PROTECTION_GROUP
- UPDATE_ROLE_DR_PROTECTION_GROUP
- CREATE_DR_PLAN
- UPDATE_DR_PLAN
- DELETE_DR_PLAN
- REFRESH_DR_PLAN
- VERIFY_DR_PLAN
- CREATE_DR_PLAN_EXECUTION
- UPDATE_DR_PLAN_EXECUTION
- DELETE_DR_PLAN_EXECUTION
- RETRY_DR_PLAN_EXECUTION
- IGNORE_DR_PLAN_EXECUTION
- CANCEL_DR_PLAN_EXECUTION
- PAUSE_DR_PLAN_EXECUTION
- RESUME_DR_PLAN_EXECUTION
- CREATE_AUTOMATIC_DR_CONFIGURATION
- DELETE_AUTOMATIC_DR_CONFIGURATION
- UPDATE_AUTOMATIC_DR_CONFIGURATION
type: string
x-obmcs-top-level-enum: '#/definitions/OperationType'
percentComplete:
description: 'The percentage of the request completed.
Example: `75`
'
format: float
type: number
resources:
description: 'The resources affected by this work request.
'
items:
$ref: '#/components/schemas/WorkRequestResource'
type: array
status:
description: 'The status of current work request.
'
enum:
- ACCEPTED
- IN_PROGRESS
- WAITING
- CANCELING
- CANCELED
- SUCCEEDED
- FAILED
- NEEDS_ATTENTION
type: string
x-obmcs-top-level-enum: '#/definitions/OperationStatus'
timeAccepted:
description: 'The date and time the request was created. An RFC3339 formatted datetime string.
Example: `2019-03-29T09:36:42Z`
'
format: date-time
type: string
timeFinished:
description: 'The date and time the request was finished. An RFC3339 formatted datetime string.
Example: `2019-03-29T09:36:42Z`
'
format: date-time
type: string
timeStarted:
description: 'The date and time the request was started. An RFC3339 formatted datetime string.
Example: `2019-03-29T09:36:42Z`
'
format: date-time
type: string
required:
- operationType
- status
- id
- compartmentId
- resources
- percentComplete
- timeAccepted
x-example: "{\n \"operationType\": \"CREATE_DR_PROTECTION_GROUP\",\n \"status\": \"ACCEPTED\",\n \"id\": \"ocid1.drworkrequest.oc1..uniqueID\",\n \"compartmentId\": \"ocid1.compartment.oc1..uniqueID\",\n \"resources\": [\n {\n \"entityType\": \"drprotectiongroup\",\n \"actionType\": \"CREATED\",\n \"identifier\": \"ocid1.drprotectiongroup.oc1..uniqueID\",\n \"entityUri\": \"/drProtectionGroups/ocid1.drprotectiongroup.oc1..uniqueID\"\n }\n ],\n \"percentComplete\": 100.0,\n \"timeAccepted\": \"2023-09-07T23:55:52.028Z\",\n \"timeStarted\": \"2023-09-07T23:56:05.094Z\",\n \"timeFinished\": \"2023-09-07T23:59:32.018Z\"\n}\n"
PauseDrPlanExecutionDetails:
allOf:
- $ref: '#/components/schemas/DrPlanExecutionControlDetails'
- discriminator: PAUSE
description: 'The details for pausing a DR plan execution.
'
x-example: "{\n \"actionType\": \"PAUSE\"\n}\n"
DrPlanExecutionOptionDetails:
description: The options for a plan execution.
discriminator:
propertyName: planExecutionType
properties:
planExecutionType:
description: 'The type of the plan execution.
'
enum:
- SWITCHOVER
- SWITCHOVER_PRECHECK
- FAILOVER
- FAILOVER_PRECHECK
- START_DRILL
- START_DRILL_PRECHECK
- STOP_DRILL
- STOP_DRILL_PRECHECK
type: string
required:
- planExecutionType
DrPlanUserDefinedStep:
description: The details for a user-defined step in a DR plan.
discriminator:
propertyName: stepType
properties:
stepType:
description: "The type of the user-defined step.\n\n **RUN_OBJECTSTORE_SCRIPT_PRECHECK** - A built-in step which performs a precheck on a script stored\n in OCI object storage. This step cannot be added, deleted, or customized by the user.\n\n **RUN_LOCAL_SCRIPT_PRECHECK** - A built-in step which performs a precheck on a script which resides\n locally on a compute instance. This step cannot be added, deleted, or customized by the user.\n\n **INVOKE_FUNCTION_PRECHECK** - A built-in step which performs a precheck on an OCI function. This \n step cannot be added, deleted, or customized by the user.\n See https://docs.oracle.com/en-us/iaas/Content/Functions/home.htm.\n\n **RUN_OBJECTSTORE_SCRIPT** - A step which runs a script stored in OCI object storage.\n\n **RUN_LOCAL_SCRIPT** - A step which runs a script that resides locally on a compute instance.\n\n **INVOKE_FUNCTION** - A step which invokes an OCI function.\n See https://docs.oracle.com/en-us/iaas/Content/Functions/home.htm.\n\n **RUN_OBJECTSTORE_SCRIPT_USER_DEFINED_CUSTOM_PRECHECK** - A user-defined step which performs a precheck by executing a user-provided script stored\n in OCI object storage.\n\n **RUN_LOCAL_SCRIPT_USER_DEFINED_CUSTOM_PRECHECK** - A user-defined step which performs a precheck by executing a user-provided script which resides\n locally on a compute instance.\n\n **INVOKE_FUNCTION_USER_DEFINED_CUSTOM_PRECHECK** - A user-defined step which performs a precheck by executing a user-provided OCI function.\n See https://docs.oracle.com/en-us/iaas/Content/Functions/home.htm.\n"
enum:
- RUN_OBJECTSTORE_SCRIPT_PRECHECK
- RUN_LOCAL_SCRIPT_PRECHECK
- INVOKE_FUNCTION_PRECHECK
- RUN_OBJECTSTORE_SCRIPT
- RUN_LOCAL_SCRIPT
- INVOKE_FUNCTION
- RUN_OBJECTSTORE_SCRIPT_USER_DEFINED_CUSTOM_PRECHECK
- RUN_LOCAL_SCRIPT_USER_DEFINED_CUSTOM_PRECHECK
- INVOKE_FUNCTION_USER_DEFINED_CUSTOM_PRECHECK
type: string
required:
- stepType
DrProtectionGroupSummary:
description: The summary of a DR protection group.
properties:
compartmentId:
description: 'The OCID of the compartment containing the DR protection group.
Example: `ocid1.compartment.oc1..uniqueID`
'
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: 'The display name of the DR protection group.
Example: `EBS PHX Group`
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"Department": "Finance"}`
'
type: object
id:
description: 'The OCID of the DR protection group.
Example: `ocid1.drprotectiongroup.oc1..uniqueID`
'
maxLength: 255
minLength: 1
type: string
lifeCycleDetails:
description: 'A message describing the DR protection group''s current state in more detail.
'
type: string
lifecycleState:
description: 'The current state of the DR protection group.
'
enum:
- CREATING
- ACTIVE
- UPDATING
- INACTIVE
- NEEDS_ATTENTION
- DELETING
- DELETED
- FAILED
type: string
x-obmcs-top-level-enum: '#/definitions/DrProtectionGroupLifecycleState'
lifecycleSubState:
description: 'The current sub-state of the DR protection group.
'
enum:
- DR_DRILL_IN_PROGRESS
- DR_PLAN_EXECUTION_IN_PROGRESS
- AUTOMATIC_DR_PLAN_EXECUTION_IN_PROGRESS
type: string
x-obmcs-top-level-enum: '#/definitions/DrProtectionGroupLifecycleSubState'
peerId:
description: 'The OCID of the peer DR protection group.
Example: `ocid1.drprotectiongroup.oc1..uniqueID`
'
maxLength: 255
minLength: 1
type: string
peerRegion:
description: 'The region of the peer DR protection group.
Example: `us-ashburn-1`
'
maxLength: 255
minLength: 1
type: string
role:
description: 'The role of the DR protection group.
'
enum:
- PRIMARY
- STANDBY
- UNCONFIGURED
type: string
x-obmcs-top-level-enum: '#/definitions/DrProtectionGroupRole'
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.
Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
'
type: object
timeCreated:
description: 'The date and time the DR protection group was created. An RFC3339 formatted datetime string.
Example: `2019-03-29T09:36:42Z`
'
format: date-time
type: string
timeUpdated:
description: 'The date and time the DR protection group was updated. An RFC3339 formatted datetime string.
Example: `2019-03-29T09:36:42Z`
'
format: date-time
type: string
required:
- id
- compartmentId
- displayName
- role
- timeCreated
- timeUpdated
- lifecycleState
type: object
x-example: "{\n \"id\": \"ocid1.drprotectiongroup.oc1..uniqueID\",\n \"compartmentId\": \"ocid1.compartment.oc1..uniqueID\",\n \"displayName\": \"My DR protection group\",\n \"role\": \"PRIMARY\",\n \"peerId\": \"ocid1.drprotectiongroup.oc1..uniqueID\",\n \"peerRegion\": \"us-ashburn-1\",\n \"timeCreated\": \"2023-09-05T23:09:45.614Z\",\n \"timeUpdated\": \"2023-09-05T23:09:45.615Z\",\n \"lifecycleState\": \"INACTIVE\",\n \"lifecycleSubState\": \"DR_DRILL_IN_PROGRESS\",\n \"freeformTags\": {\n \"Department\": \"Finance\"\n },\n \"definedTags\": {\n \"Operations\": {\n \"CostCenter\": \"42\"\n }\n }\n}\n"
CreateObjectStorageLogLocationDetails:
description: The details for creating an object storage log location for a DR protection group.
properties:
bucket:
description: 'The bucket name inside the object storage namespace.
Example: `operation_logs`
'
maxLength: 255
minLength: 1
type: string
namespace:
description: 'The namespace in object storage (Note - this is usually the tenancy name).
Example: `myocitenancy`
'
maxLength: 255
minLength: 1
type: string
required:
- namespace
- bucket
type: object
x-example: "{\n \"namespace\": \"namespace_string\",\n \"bucket\": \"bucket_name\"\n}\n"
DrPlanExecutionSuccessfulStepStatusCounts:
description: 'A summary of steps that completed successfully during a DR plan execution.
'
properties:
succeeded:
description: 'The total number of steps that succeeded during a DR plan execution.
'
format: int32
type: integer
totalSuccessful:
description: 'The total number of successful steps in a DR plan execution.
'
format: int32
type: integer
required:
- totalSuccessful
- succeeded
type: object
x-example: "{\n \"totalSuccessful\": 2,\n \"succeeded\": 2\n}\n"
UpdateAutomaticDrConfigurationDetails:
description: The details for updating an Automatic DR configuration.
properties:
defaultFailoverDrPlanId:
description: 'The unique id of a Failover DR Plan.
Example: `ocid1.drplan.oc1..uniqueID`
'
maxLength: 255
minLength: 0
type: string
defaultSwitchoverDrPlanId:
description: 'The unique id of a Switchover DR Plan.
Example: `ocid1.drplan.oc1..uniqueID`
'
maxLength: 255
minLength: 0
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: 'The display name of the Automatic DR configuration being updated.
Example: `Automatic DR Configuration`
'
maxLength: 1024
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"Department": "Finance"}`
'
type: object
members:
description: 'A list of members for Automatic DR configuration.
'
items:
$ref: '#/components/schemas/UpdateAutomaticDrConfigurationMemberDetails'
maxItems: 128
minItems: 1
type: array
type: object
x-example: "{\n \"displayName\": \"Switchover From IAD To PHX\",\n \"members\": [\n {\n \"memberId\": \"ocid1.autonomousdatabase.oc1..uniqueID\",\n \"memberType\": \"AUTONOMOUS_DATABASE\",\n \"isAutoSwitchoverEnabled\": true,\n \"isAutoFailoverEnabled\": true\n },\n {\n \"memberId\": \"ocid1.autonomousdatabase.oc1..uniqueID\",\n \"memberType\": \"AUTONOMOUS_DATABASE\",\n \"isAutoFailoverEnabled\": true\n }\n ],\n \"defaultSwitchoverDrPlanId\": \"ocid1.drplan.oc1..uniqueID\",\n \"defaultFailoverDrPlanId\": \"ocid1.drplan.oc1..uniqueID1\",\n \"freeformTags\": {\n \"Department\": \"Finance\"\n },\n \"definedTags\": {\n \"Operations\": {\n \"CostCenter\": \"42\"\n }\n }\n}\n"
DrProtectionGroupCollection:
description: A list of DR protection group summaries.
properties:
items:
description: 'A list of DR protection group summaries.
'
items:
$ref: '#/components/schemas/DrProtectionGroupSummary'
type: array
required:
- items
type: object
CreateAutomaticDrConfigurationMemberDetails:
description: Create properties for a member in an Automatic DR configuration.
discriminator:
propertyName: memberType
properties:
memberId:
description: 'The OCID of the member.
Example: `ocid1.database.oc1..uniqueID`
'
maxLength: 255
minLength: 1
type: string
memberType:
description: 'The type of the member.
'
enum:
- DATABASE
- AUTONOMOUS_DATABASE
- AUTONOMOUS_CONTAINER_DATABASE
type: string
x-obmcs-top-level-enum: '#/definitions/AutomaticDrConfigurationMemberType'
required:
- memberId
- memberType
type: object
x-example: "{\n \"memberId\": \"ocid1.autonomousdatabase.oc1..uniqueID\",\n \"memberType\": \"AUTONOMOUS_DATABASE\",\n}\n"
DrPlanExecution:
description: The details of a DR plan execution.
properties:
automaticExecutionDetails:
$ref: '#/components/schemas/AutomaticExecutionDetails'
compartmentId:
description: 'The OCID of the compartment containing this DR plan execution.
Example: `ocid1.compartment.oc1..uniqueID`
'
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: 'The display name of the DR plan execution.
Example: `Execution - EBS Switchover PHX to IAD`
'
maxLength: 1024
minLength: 1
type: string
drProtectionGroupId:
description: 'The OCID of the DR protection group to which this DR plan execution belongs.
Example: `ocid1.drprotectiongroup.oc1..uniqueID`
'
maxLength: 255
minLength: 1
type: string
executionDurationInSec:
description: 'The total duration in seconds taken to complete the DR plan execution.
Example: `750`
'
format: int32
type: integer
executionOptions:
$ref: '#/components/schemas/DrPlanExecutionOptions'
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"Department": "Finance"}`
'
type: object
groupExecutions:
description: 'A list of groups executed in this DR plan execution.
'
items:
$ref: '#/components/schemas/DrPlanGroupExecution'
type: array
id:
description: 'The OCID of the DR plan execution.
Example: `ocid1.drplanexecution.oc1..uniqueID`
'
maxLength: 255
minLength: 1
type: string
isAutomatic:
default: false
description: 'A flag indicating whether execution was submitted automatically by Automatic DR Configuration.
Example: `false`
'
type: boolean
lifeCycleDetails:
description: 'A message describing the DR plan execution''s current state in more detail.
'
type: string
lifecycleState:
description: 'The current state of the DR plan execution.
'
enum:
- ACCEPTED
- IN_PROGRESS
- WAITING
- CANCELING
- CANCELED
- SUCCEEDED
- FAILED
- DELETING
- DELETED
- PAUSING
- PAUSED
- RESUMING
type: string
x-obmcs-top-level-enum: '#/definitions/DrPlanExecutionLifecycleState'
logLocation:
$ref: '#/components/schemas/ObjectStorageLogLocation'
peerDrProtectionGroupId:
description: 'The OCID of peer DR protection group associated with this plan''s
DR protection group.
Example: `ocid1.drprotectiongroup.oc1..uniqueID`
'
maxLength: 255
minLength: 1
type: string
peerRegion:
description: 'The region of the peer DR protection group associated with this plan''s
DR protection group.
Example: `us-ashburn-1`
'
maxLength: 255
minLength: 1
type: string
planExecutionType:
description: 'The type of the DR plan executed.
'
enum:
- SWITCHOVER
- SWITCHOVER_PRECHECK
- FAILOVER
- FAILOVER_PRECHECK
- START_DRILL
- START_DRILL_PRECHECK
- STOP_DRILL
- STOP_DRILL_PRECHECK
type: string
x-obmcs-top-level-enum: '#/definitions/DrPlanExecutionType'
planId:
description: 'The OCID of the DR plan.
Example: `ocid1.drplan.oc1..uniqueID`
'
maxLength: 255
minLength: 1
type: string
stepStatusCounts:
$ref: '#/components/schemas/DrPlanExecutionStepStatusCounts'
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.
Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
'
type: object
timeCreated:
description: 'The date and time at which DR plan execution was created. An RFC3339 formatted datetime string.
Example: `2019-03-29T09:36:42Z`
'
format: date-time
type: string
timeEnded:
description: 'The date and time at which DR plan execution succeeded, failed, was paused, or was canceled.
An RFC3339 formatted datetime string.
Example: `2019-03-29T09:36:42Z`
'
format: date-time
type: string
timeStarted:
description: 'The date and time at which DR plan execution began. An RFC3339 formatted datetime string.
Example: `2019-03-29T09:36:42Z`
'
format: date-time
type: string
timeUpdated:
description: 'The time when DR plan execution was last updated. An RFC3339 formatted datetime string.
Example: `2019-03-29T09:36:42Z`
'
format: date-time
type: string
required:
- id
- compartmentId
- displayName
- planId
- planExecutionType
- executionOptions
- drProtectionGroupId
- peerDrProtectionGroupId
- peerRegion
- logLocation
- lifecycleState
- timeCreated
- timeUpdated
- groupExecutions
- isAutomatic
- stepStatusCounts
type: object
x-example: "{\n \"id\": \"ocid1.drplanexecution.oc1..uniqueID\",\n \"compartmentId\": \"ocid1.compartment.oc1..uniqueID\",\n \"displayName\": \"Execution - EBS Switchover PHX to IAD\",\n \"planId\": \"ocid1.drplan.oc1..uniqueID\",\n \"planExecutionType\": \"SWITCHOVER\",\n \"executionOptions\": {\n \"planExecutionType\": \"SWITCHOVER\"\n },\n \"drProtectionGroupId\": \"ocid1.drprotectiongroup.oc1..uniqueID1\",\n \"peerDrProtectionGroupId\": \"ocid1.drprotectiongroup.oc1..uniqueID2\",\n \"peerRegion\": \"us-ashburn-1\",\n \"logLocation\": {\n \"namespace\": \"namespace_string\",\n \"bucket\": \"bucket_name\",\n \"object\": \"object_name\"\n },\n \"timeCreated\": \"2023-09-07T22:37:18.153Z\",\n \"timeStarted\": \"2023-09-07T22:39:18.253Z\",\n \"timeUpdated\": \"2023-09-07T22:39:45.354Z\",\n \"timeEnded\": \"2023-09-07T22:57:42.389Z\",\n \"executionDurationInSec\": 1224,\n \"lifecycleState\": \"SUCCEEDED\",\n \"lifeCycleDetails\": \"\",\n \"freeformTags\": {\n \"Department\": \"Finance\"\n },\n \"definedTags\": {\n \"Operations\": {\n \"CostCenter\": \"42\"\n }\n },\n \"stepStatusCounts\": {\n \"totalSteps\": 52,\n \"remainingSteps\": {\n \"totalRemaining\": 45,\n \"queued\": 40,\n \"paused\": 0,\n \"inProgress\": 5\n },\n \"skippedSteps\": {\n \"totalSkipped\": 2,\n \"disabled\": 1,\n \"failedIgnored\": 0,\n \"timedOutIgnored\": 1,\n \"canceled\": 0\n },\n \"successfulSteps\": {\n \"totalSuccessful\": 2,\n \"succeeded\": 2\n },\n \"warningSteps\": {\n \"totalWarnings\": 2,\n \"warningsIgnored\": 2\n },\n \"failedSteps\": {\n \"totalFailed\": 1,\n \"failed\": 1,\n \"timedOut\": 0\n }\n },\n \"groupExecutions\": [\n {\n \"groupId\": \"sgid1.group..uniqueID\",\n \"type\": \"BUILT_IN\",\n \"displayName\": \"Launch Compute Instances (Standby)\",\n \"status\": \"SUCCEEDED\",\n \"statusDetails\": \"\",\n \"timeStarted\": \"2023-09-07T22:39:19.253Z\",\n \"timeEnded\": \"2023-09-07T22:39:21.253Z\",\n \"executionDurationInSec\": 120,\n \"stepExecutions\": [\n {\n \"stepId\": \"sgid1.step..uniqueID\",\n \"type\": \"COMPUTE_INSTANCE_LAUNCH\",\n \"groupId\": \"sgid1.group..uniqueID\",\n \"displayName\": \"myhost1\",\n \"logLocation\": {\n \"namespace\": \"namespace_string\",\n \"bucket\": \"bucket_name\",\n \"object\": \"object_name\"\n },\n \"status\": \"SUCCEEDED\",\n \"statusDetails\": \"\",\n \"timeStarted\": \"2023-09-07T22:39:19.253Z\",\n \"timeEnded\": \"2023-09-07T22:39:21.253Z\",\n \"executionDurationInSec\": 120\n }\n ]\n }\n ]\n}\n"
RefreshDrPlanDetails:
description: The details for refreshing a DR plan.
discriminator:
propertyName: type
properties:
type:
description: 'The default type.
'
enum:
- DEFAULT
type: string
required:
- type
type: object
x-example: "{\n \"type\": \"DEFAULT\"\n}\n"
CreateDrProtectionGroupDetails:
description: The details for creating a DR protection group.
properties:
association:
$ref: '#/components/schemas/AssociateDrProtectionGroupDetails'
compartmentId:
description: 'The OCID of the compartment in which to create the DR protection group.
Example: `ocid1.compartment.oc1..uniqueID`
'
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: 'The display name of the DR protection group.
Example: `EBS PHX Group`
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"Department": "Finance"}`
'
type: object
logLocation:
$ref: '#/components/schemas/CreateObjectStorageLogLocationDetails'
members:
description: 'A list of DR protection group members.
'
items:
$ref: '#/components/schemas/CreateDrProtectionGroupMemberDetails'
type: array
required:
- compartmentId
- displayName
- logLocation
type: object
x-example: "{\n \"compartmentId\": \"ocid1.compartment.oc1..uniqueID\",\n \"displayName\": \"My DR protection group\",\n \"logLocation\": {\n \"namespace\": \"namespace_string\",\n \"bucket\": \"bucket_name\"\n },\n \"association\": {\n \"peerRegion\": \"us-ashburn-1\",\n \"peerId\": \"ocid1.drprotectiongroup.oc1..uniqueID\",\n \"role\": \"STANDBY\"\n },\n \"members\": [\n {\n \"memberId\": \"ocid1.instance.oc1..uniqueID\",\n \"memberType\": \"COMPUTE_INSTANCE_MOVABLE\",\n \"isRetainFaultDomain\": false,\n \"destinationCapacityReservationId\": \"ocid1.capacityreservation.oc1..uniqueID\",\n \"destinationCompartmentId\": \"ocid1.compartment.oc1..uniqueID\",\n \"vnicMappings\": [\n {\n \"sourceVnicId\": \"ocid1.vnic.oc1..uniqueID\",\n \"destinationSubnetId\": \"ocid1.subnet.oc1..uniqueID\",\n \"destinationPrimaryPrivateIpAddress\": \"10.0.3.1\",\n \"destinationPrimaryPrivateIpHostnameLabel\": \"myhost1\",\n \"destinationReservedPublicIpId\": \"ocid1.publicip.oc1..uniqueID1\",\n \"destinationNsgIdList\": [\n \"ocid1.nsg.oc1..uniqueID1\",\n \"ocid1.nsg.oc1..uniqueID2\"\n ]\n },\n {\n \"sourceVnicId\": \"ocid1.vnic.oc1..uniqueID\",\n \"destinationSubnetId\": \"ocid1.subnet.oc1..uniqueID\",\n \"destinationPrimaryPrivateIpAddress\": \"10.0.3.2\",\n \"destinationPrimaryPrivateIpHostnameLabel\": \"myhost2\",\n \"destinationReservedPublicIpId\": \"ocid1.publicip.oc1..uniqueID1\",\n \"destinationNsgIdList\": [\n \"ocid1.nsg.oc1..uniqueID1\",\n \"ocid1.nsg.oc1..uniqueID2\"\n ]\n }\n ] ,\n \"fileSystemOperations\": [\n {\n \"exportPath\": \"/fs-export-path\",\n \"mountPoint\": \"/mnt/yourmountpoint\",\n \"mountDetails\": {\n \"mountTargetId\": \"ocid1.mounttarget.oc1..uniqueID1\"\n },\n \"unmountDetails\": {\n \"mountTargetId\": \"ocid1.mounttarget.oc1..uniqueID2\"\n }\n }\n ]\n },\n {\n \"memberId\": \"ocid1.instance.oc1..uniqueID\",\n \"memberType\": \"COMPUTE_INSTANCE_NON_MOVABLE\",\n \"isStartStopEnabled\": true,\n \"fileSystemOperations\": [\n {\n \"exportPath\": \"/fs-export-path\",\n \"mountPoint\": \"/mnt/yourmountpoint\",\n \"mountDetails\": {\n \"mountTargetId\": \"ocid1.mounttarget.oc1..uniqueID1\"\n },\n \"unmountDetails\": {\n \"mountTargetId\": \"ocid1.mounttarget.oc1..uniqueID2\"\n }\n }\n ],\n \"blockVolumeOperations\": [\n {\n \"blockVolumeId\": \"ocid1.volume.oc1..uniqueID\",\n \"attachmentDetails\": {\n \"volumeAttachmentReferenceInstanceId\": \"ocid1.instance.oc1..uniqueID\"\n },\n \"mountDetails\": {\n \"mountPoint\": \"/mnt/yourmountpoint\"\n }\n }\n ]\n },\n {\n \"memberId\": \"ocid1.volumegroup.oc1..uniqueID\",\n \"memberType\": \"VOLUME_GROUP\"\n },\n {\n \"memberId\": \"ocid1.database.oc1..uniqueID\",\n \"memberType\": \"DATABASE\",\n \"passwordVaultSecretId\": \"ocid1.vaultsecret.oc1..uniqueID\"\n },\n {\n \"memberId\": \"ocid1.autonomouscontainerdatabase.oc1..uniqueID\",\n \"memberType\": \"AUTONOMOUS_CONTAINER_DATABASE\"\n },\n {\n \"memberId\": \"ocid1.autonomousdatabase.oc1..uniqueID2\",\n \"memberType\": \"AUTONOMOUS_DATABASE\",\n \"autonomousDatabaseStandbyTypeForDrDrills\": \"FULL_CLONE\",\n \"passwordVaultSecretId\": \"ocid1.vaultsecret.oc1..uniqueID\"\n },\n {\n \"memberId\": \"ocid1.autonomousdatabase.oc1..uniqueID\",\n \"memberType\": \"AUTONOMOUS_DATABASE\"\n }\n ],\n \"freeformTags\": {\n \"Department\": \"Finance\"\n },\n \"definedTags\": {\n \"Operations\": {\n \"CostCenter\": \"42\"\n }\n }\n}\n\nExample using 'blockVolumeAttachAndMountOperations' for providing block volume operations instead of deprecated attribute 'blockVolumeOperations' :\n{\n \"compartmentId\": \"ocid1.compartment.oc1..uniqueID\",\n \"displayName\": \"My DR protection group\",\n \"logLocation\": {\n \"namespace\": \"namespace_string\",\n \"bucket\": \"bucket_name\"\n },\n \"association\": {\n \"peerRegion\": \"us-ashburn-1\",\n \"peerId\": \"ocid1.drprotectiongroup.oc1..uniqueID\",\n \"role\": \"STANDBY\"\n },\n \"members\": [\n {\n \"memberId\": \"ocid1.instance.oc1..uniqueID\",\n \"memberType\": \"COMPUTE_INSTANCE_MOVABLE\",\n \"isRetainFaultDomain\": false,\n \"destinationCapacityReservationId\": \"ocid1.capacityreservation.oc1..uniqueID\",\n \"destinationCompartmentId\": \"ocid1.compartment.oc1..uniqueID\",\n \"vnicMappings\": [\n {\n \"sourceVnicId\": \"ocid1.vnic.oc1..uniqueID\",\n \"destinationSubnetId\": \"ocid1.subnet.oc1..uniqueID\",\n \"destinationPrimaryPrivateIpAddress\": \"10.0.3.1\",\n \"destinationPrimaryPrivateIpHostnameLabel\": \"myhost1\",\n \"destinationReservedPublicIpId\": \"ocid1.publicip.oc1..uniqueID1\",\n \"destinationNsgIdList\": [\n \"ocid1.nsg.oc1..uniqueID1\",\n \"ocid1.nsg.oc1..uniqueID2\"\n ]\n },\n {\n \"sourceVnicId\": \"ocid1.vnic.oc1..uniqueID\",\n \"destinationSubnetId\": \"ocid1.subnet.oc1..uniqueID\",\n \"destinationPrimaryPrivateIpAddress\": \"10.0.3.2\",\n \"destinationPrimaryPrivateIpHostnameLabel\": \"myhost2\",\n \"destinationReservedPublicIpId\": \"ocid1.publicip.oc1..uniqueID1\",\n \"destinationNsgIdList\": [\n \"ocid1.nsg.oc1..uniqueID1\",\n \"ocid1.nsg.oc1..uniqueID2\"\n ]\n }\n ] ,\n \"fileSystemOperations\": [\n {\n \"exportPath\": \"/fs-export-path\",\n \"mountPoint\": \"/mnt/yourmountpoint\",\n \"mountDetails\": {\n \"mountTargetId\": \"ocid1.mounttarget.oc1..uniqueID1\"\n },\n \"unmountDetails\": {\n \"mountTargetId\": \"ocid1.mounttarget.oc1..uniqueID2\"\n }\n }\n ]\n },\n {\n \"memberId\": \"ocid1.instance.oc1..uniqueID\",\n \"memberType\": \"COMPUTE_INSTANCE_NON_MOVABLE\",\n \"isStartStopEnabled\": true,\n \"fileSystemOperations\": [\n {\n \"exportPath\": \"/fs-export-path\",\n \"mountPoint\": \"/mnt/yourmountpoint\",\n \"mountDetails\": {\n \"mountTargetId\": \"ocid1.mounttarget.oc1..uniqueID1\"\n },\n \"unmountDetails\": {\n \"mountTargetId\": \"ocid1.mounttarget.oc1..uniqueID2\"\n }\n }\n ],\n \"blockVolumeAttachAndMountOperations\": {\n \"attachments\": [\n {\n \"blockVolumeId\": \"ocid1.volume.oc1..uniqueID1\",\n \"volumeAttachmentReferenceInstanceId\": \"ocid1.instance.oc1..uniqueID\"\n },\n {\n \"blockVolumeId\": \"ocid1.volume.oc1..uniqueID2\"\n }\n ],\n \"mounts\": [\n {\n \"mountPoint\": \"/mnt/yourmountpoint1\"\n },\n {\n \"mountPoint\": \"/mnt/yourmountpoint2\"\n }\n ]\n }\n },\n {\n \"memberId\": \"ocid1.volumegroup.oc1..uniqueID\",\n \"memberType\": \"VOLUME_GROUP\"\n },\n {\n \"memberId\": \"ocid1.database.oc1..uniqueID\",\n \"memberType\": \"DATABASE\",\n \"passwordVaultSecretId\": \"ocid1.vaultsecret.oc1..uniqueID\"\n },\n {\n \"memberId\": \"ocid1.autonomouscontainerdatabase.oc1..uniqueID\",\n \"memberType\": \"AUTONOMOUS_CONTAINER_DATABASE\"\n },\n {\n \"memberId\": \"ocid1.autonomousdatabase.oc1..uniqueID2\",\n \"memberType\": \"AUTONOMOUS_DATABASE\",\n \"autonomousDatabaseStandbyTypeForDrDrills\": \"FULL_CLONE\",\n \"passwordVaultSecretId\": \"ocid1.vaultsecret.oc1..uniqueID\"\n },\n {\n \"memberId\": \"ocid1.autonomousdatabase.oc1..uniqueID\",\n \"memberType\": \"AUTONOMOUS_DATABASE\"\n }\n ],\n \"freeformTags\": {\n \"Department\": \"Finance\"\n },\n \"definedTags\": {\n \"Operations\": {\n \"CostCenter\": \"42\"\n }\n }\n}\n"
CreateAutomaticDrConfigurationDetails:
description: The details for creating an Automatic DR configuration.
properties:
defaultFailoverDrPlanId:
description: 'The unique id of a Failover DR Plan.
Example: `ocid1.drplan.oc1..uniqueID`
'
maxLength: 255
minLength: 1
type: string
defaultSwitchoverDrPlanId:
description: 'The unique id of a Switchover DR Plan.
Example: `ocid1.drplan.oc1..uniqueID`
'
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: 'The display name of the Automatic DR configuration being created.
Example: `Automatic DR Configuration`
'
maxLength: 1024
minLength: 1
type: string
drProtectionGroupId:
description: 'The OCID of the DR protection group to which this Automatic DR configuration belongs.
Example: `ocid1.drprotectiongroup.oc1..uniqueID`
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"Department": "Finance"}`
'
type: object
members:
description: 'A list of members for Automatic DR configuration.
'
items:
$ref: '#/components/schemas/CreateAutomaticDrConfigurationMemberDetails'
maxItems: 128
minItems: 1
type: array
required:
- displayName
- drProtectionGroupId
- members
type: object
x-example: "{\n \"drProtectionGroupId\": \"ocid1.drprotectiongroup.oc1..uniqueID\",\n \"displayName\": \"Switchover From IAD To PHX\",\n \"members\": [\n {\n \"memberId\": \"ocid1.autonomousdatabase.oc1..uniqueID\",\n \"memberType\": \"AUTONOMOUS_DATABASE\",\n \"isAutoSwitchoverEnabled\": true,\n \"isAutoFailoverEnabled\": true\n },\n {\n \"memberId\": \"ocid1.autonomousdatabase.oc1..uniqueID\",\n \"memberType\": \"AUTONOMOUS_DATABASE\",\n \"isAutoFailoverEnabled\": true\n }\n ],\n \"defaultSwitchoverDrPlanId\": \"ocid1.drplan.oc1..uniqueID\",\n \"defaultFailoverDrPlanId\": \"ocid1.drplan.oc1..uniqueID1\",\n \"freeformTags\": {\n \"Department\": \"Finance\"\n },\n \"definedTags\": {\n \"Operations\": {\n \"CostCenter\": \"42\"\n }\n }\n}\n"
CreateDrPlanExecutionDetails:
description: The details for creating a DR plan execution.
properties:
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: 'The display name of the DR plan execution.
Example: `Execution - EBS Switchover PHX to IAD`
'
maxLength: 255
minLength: 1
type: string
executionOptions:
$ref: '#/components/schemas/DrPlanExecutionOptionDetails'
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"Department": "Finance"}`
'
type: object
planId:
description: 'The OCID of the DR plan.
Example: `ocid1.drplan.oc1..uniqueID`
'
maxLength: 255
minLength: 1
type: string
required:
- planId
- executionOptions
type: object
x-example: "{\n \"displayName\": \"Switchover Precheck From IAD To PHX\",\n \"planId\": \"ocid1.drplan.oc1..uniqueID\",\n \"executionOptions\": {\n \"planExecutionType\": \"SWITCHOVER_PRECHECK\"\n },\n \"freeformTags\": {\n \"Department\": \"Finance\"\n },\n \"definedTags\": {\n \"Operations\": {\n \"CostCenter\": \"42\"\n }\n }\n}\n"
DrPlanExecutionOptions:
description: The options for a plan execution.
discriminator:
propertyName: planExecutionType
properties:
planExecutionType:
description: 'The type of the plan execution.
'
enum:
- SWITCHOVER
- SWITCHOVER_PRECHECK
- FAILOVER
- FAILOVER_PRECHECK
- START_DRILL_PRECHECK
- START_DRILL
- STOP_DRILL_PRECHECK
- STOP_DRILL
type: string
required:
- planExecutionType
DisassociateDrProtectionGroupDetails:
description: The details for disassociating this DR protection group from a peer DR protection group.
discriminator:
propertyName: type
properties:
type:
description: 'The default type.
'
enum:
- DEFAULT
type: string
required:
- type
type: object
x-example: "{\n \"type\": \"DEFAULT\"\n}\n"
IgnoreDrPlanExecutionDetails:
description: The details for ignoring a failed group or step.
properties:
groupId:
description: 'The unique id of the group to ignore as a whole, or the group containing the step to ignore.
Example: `sgid1.group..uniqueID`
'
maxLength: 255
minLength: 1
type: string
stepId:
description: 'The unique id of the step to ignore (optional). Only needed when ignoring a step.
Example: `sgid1.step..uniqueID`
'
maxLength: 255
minLength: 1
type: string
required:
- groupId
type: object
x-example: "{\n \"groupId\": \"sgid1.group..uniqueID\",\n \"stepId\": \"sgid1.step..uniqueID\"\n}\n"
RetryDrPlanExecutionDetails:
description: The details for retrying a failed group or step.
properties:
groupId:
description: 'The unique id of the group to retry as a whole, or the group containing the step being retried.
Example: `sgid1.group..uniqueID`
'
maxLength: 255
minLength: 1
type: string
stepId:
description: 'The unique id of the step to retry (optional). Only needed when retrying a step.
Example: `sgid1.step..uniqueID`
'
maxLength: 255
minLength: 1
type: string
required:
- groupId
type: object
x-example: "{\n \"groupId\": \"sgid1.group..uniqueID\",\n \"stepId\": \"sgid1.step..uniqueID\"\n}\n"
DrPlan:
description: The details of a DR plan.
properties:
compartmentId:
description: 'The OCID of the compartment containing the DR plan.
Example: `ocid1.compartment.oc1..uniqueID`
'
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: 'The display name of the DR plan.
Example: `EBS Switchover PHX to IAD`
'
maxLength: 255
minLength: 1
type: string
drProtectionGroupId:
description: 'The OCID of the DR protection group to which this DR plan belongs.
Example: `ocid1.drplan.oc1..uniqueID`
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"Department": "Finance"}`
'
type: object
id:
description: 'The OCID of the DR plan.
Example: `ocid1.drplan.oc1..uniqueID`
'
maxLength: 255
minLength: 1
type: string
lifeCycleDetails:
description: 'A message describing the DR plan''s current state in more detail.
'
type: string
lifecycleState:
description: 'The current state of the DR plan.
'
enum:
- CREATING
- UPDATING
- ACTIVE
- INACTIVE
- DELETING
- DELETED
- FAILED
- NEEDS_ATTENTION
type: string
x-obmcs-top-level-enum: '#/definitions/DrPlanLifecycleState'
lifecycleSubState:
description: 'The current state of the DR plan.
'
enum:
- NEEDS_REFRESH
- NEEDS_VERIFICATION
- REFRESHING
- VERIFYING
type: string
x-obmcs-top-level-enum: '#/definitions/DrPlanLifecycleSubState'
peerDrProtectionGroupId:
description: 'The OCID of the peer DR protection group associated with this plan''s
DR protection group.
Example: `ocid1.drprotectiongroup.oc1..uniqueID`
'
maxLength: 255
minLength: 1
type: string
peerRegion:
description: 'The region of the peer DR protection group associated with this plan''s
DR protection group.
Example: `us-ashburn-1`
'
maxLength: 255
minLength: 1
type: string
planGroups:
description: 'The list of groups in this DR plan.
'
items:
$ref: '#/components/schemas/DrPlanGroup'
type: array
sourcePlanId:
description: 'If this is a cloned DR plan, the OCID of the source DR plan that was used to clone this DR plan.
If this DR plan was not cloned, then the value for this will be `null`.
Example: `ocid1.drplan.oc1..uniqueID`
'
maxLength: 255
minLength: 1
type: string
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.
Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
'
type: object
timeCreated:
description: 'The date and time the DR plan was created. An RFC3339 formatted datetime string.
Example: `2019-03-29T09:36:42Z`
'
format: date-time
type: string
timeUpdated:
description: 'The date and time the DR plan was updated. An RFC3339 formatted datetime string.
Example: `2019-03-29T09:36:42Z`
'
format: date-time
type: string
type:
description: 'The type of the DR plan.
'
enum:
- SWITCHOVER
- FAILOVER
- START_DRILL
- STOP_DRILL
type: string
x-obmcs-top-level-enum: '#/definitions/DrPlanType'
required:
- id
- compartmentId
- displayName
- type
- timeCreated
- timeUpdated
- lifecycleState
- drProtectionGroupId
- peerDrProtectionGroupId
- peerRegion
- planGroups
type: object
x-example: "{\n \"id\": \"ocid1.drplan.oc1..uniqueID\",\n \"displayName\": \"EBS Switchover PHX to IAD\",\n \"compartmentId\": \"ocid1.compartment.oc1..uniqueID\",\n \"type\": \"SWITCHOVER\",\n \"timeCreated\": \"2023-09-07T21:09:16.420Z\",\n \"timeUpdated\": \"2023-09-07T22:09:16.420Z\",\n \"drProtectionGroupId\": \"ocid1.drprotectiongroup.oc1..uniqueID1\",\n \"peerDrProtectionGroupId\": \"ocid1.drprotectiongroup.oc1..uniqueID2\",\n \"peerRegion\": \"us-ashburn-1\",\n \"lifecycleState\": \"ACTIVE\",\n \"lifeCycleDetails\": \"\",\n \"lifecycleSubState\": null,\n \"freeformTags\": {\n \"Department\": \"Finance\"\n },\n \"definedTags\": {\n \"Operations\": {\n \"CostCenter\": \"42\"\n }\n },\n \"planGroups\": [\n {\n \"id\": \"sgid1.group..uniqueID\",\n \"type\": \"BUILT-IN\",\n \"displayName\": \"Launch Compute Instances (Standby)\",\n \"steps\": [\n {\n \"id\": \"sgid1.step..uniqueID\",\n \"groupId\": \"sgid1.group..uniqueID\",\n \"memberId\": \"ocid1.instance.oc1..uniqueID\",\n \"type\": \"COMPUTE_INSTANCE_LAUNCH\",\n \"displayName\": \"myhost1\",\n \"errorMode\": \"STOP_ON_ERROR\",\n \"timeout\": 86400,\n \"isEnabled\": true,\n \"userDefinedStep\": null\n }\n ]\n }\n ]\n}\n"
WorkRequestLogEntry:
description: A log message related to the execution of a work request.
properties:
message:
description: 'A human-readable log message.
Example: `DR plan execution is in progress`
'
type: string
timestamp:
description: 'The time the log message was written. An RFC3339 formatted datetime string.
Example: `2019-03-29T09:36:42Z`
'
format: date-time
type: string
required:
- message
- timestamp
x-example: "{\n \"message\": \"DR plan was created successfully\",\n \"timestamp\": \"2023-09-03T17:04:55.423Z\"\n}\n"
UpdateDrProtectionGroupMemberDetails:
description: Update properties for a member in a DR protection group.
discriminator:
propertyName: memberType
properties:
memberId:
description: 'The OCID of the member.
Example: `ocid1.database.oc1..uniqueID`
'
maxLength: 255
minLength: 1
type: string
memberType:
description: 'The type of the member.
'
enum:
- COMPUTE_INSTANCE
- COMPUTE_INSTANCE_MOVABLE
- COMPUTE_INSTANCE_NON_MOVABLE
- VOLUME_GROUP
- DATABASE
- AUTONOMOUS_DATABASE
- AUTONOMOUS_CONTAINER_DATABASE
- LOAD_BALANCER
- NETWORK_LOAD_BALANCER
- FILE_SYSTEM
- OKE_CLUSTER
- OBJECT_STORAGE_BUCKET
- MYSQL_DB_SYSTEM
- INTEGRATION_INSTANCE
type: string
x-obmcs-top-level-enum: '#/definitions/DrProtectionGroupMemberType'
required:
- memberId
- memberType
type: object
x-example: "{\n \"memberId\": \"ocid1.instance.oc1..uniqueID\",\n \"memberType\": \"COMPUTE_INSTANCE\"\n}\n"
WorkRequest:
description: Information on a work request.
properties:
compartmentId:
description: 'The OCID of the compartment that contains the work request. Work requests should be scoped to
the same compartment as the resource the work request affects. If the work request affects multiple resources,
and those resources are not in the same compartment, it is up to the service team to pick the primary
resource whose compartment should be used
Example: `ocid1.compartment.oc1..uniqueID`
'
type: string
id:
description: 'The OCID of the work request.
Example: `ocid1.drworkrequest.oc1..uniqueID`
'
type: string
operationType:
description: 'The type of the work request.
'
enum:
- CREATE_DR_PROTECTION_GROUP
- UPDATE_DR_PROTECTION_GROUP
- DELETE_DR_PROTECTION_GROUP
- MOVE_DR_PROTECTION_GROUP
- ASSOCIATE_DR_PROTECTION_GROUP
- DISASSOCIATE_DR_PROTECTION_GROUP
- UPDATE_ROLE_DR_PROTECTION_GROUP
- CREATE_DR_PLAN
- UPDATE_DR_PLAN
- DELETE_DR_PLAN
- REFRESH_DR_PLAN
- VERIFY_DR_PLAN
- CREATE_DR_PLAN_EXECUTION
- UPDATE_DR_PLAN_EXECUTION
- DELETE_DR_PLAN_EXECUTION
- RETRY_DR_PLAN_EXECUTION
- IGNORE_DR_PLAN_EXECUTION
- CANCEL_DR_PLAN_EXECUTION
- PAUSE_DR_PLAN_EXECUTION
- RESUME_DR_PLAN_EXECUTION
- CREATE_AUTOMATIC_DR_CONFIGURATION
- DELETE_AUTOMATIC_DR_CONFIGURATION
- UPDATE_AUTOMATIC_DR_CONFIGURATION
type: string
x-obmcs-top-level-enum: '#/definitions/OperationType'
percentComplete:
description: 'The percentage of the request completed.
Example: `75`
'
format: float
type: number
resources:
description: 'The resources affected by this work request.
'
items:
$ref: '#/components/schemas/WorkRequestResource'
type: array
status:
description: 'The status of work request.
'
enum:
- ACCEPTED
- IN_PROGRESS
- WAITING
- CANCELING
- CANCELED
- SUCCEEDED
- FAILED
- NEEDS_ATTENTION
type: string
x-obmcs-top-level-enum: '#/definitions/OperationStatus'
timeAccepted:
description: 'The date and time the request was created. An RFC3339 formatted datetime string.
Example: `2019-03-29T09:36:42Z`
'
format: date-time
type: string
timeFinished:
description: 'The date and time the request was finished. An RFC3339 formatted datetime string.
Example: `2019-03-29T09:36:42Z`
'
format: date-time
type: string
timeStarted:
description: 'The date and time the request was started. An RFC3339 formatted datetime string.
Example: `2019-03-29T09:36:42Z`
'
format: date-time
type: string
required:
- operationType
- status
- id
- compartmentId
- resources
- percentComplete
- timeAccepted
x-example: "{\n \"operationType\": \"CREATE_DR_PROTECTION_GROUP\",\n \"status\": \"ACCEPTED\",\n \"id\": \"ocid1.drworkrequest.oc1..uniqueID\",\n \"compartmentId\": \"ocid1.compartment.oc1..uniqueID\",\n \"resources\": [\n {\n \"entityType\": \"drprotectiongroup\",\n \"actionType\": \"CREATED\",\n \"identifier\": \"ocid1.drprotectiongroup.oc1..uniqueID\",\n \"entityUri\": \"/drProtectionGroups/ocid1.drprotectiongroup.oc1..uniqueID\"\n }\n ],\n \"percentComplete\": 100.0,\n \"timeAccepted\": \"2023-09-07T23:55:52.028Z\",\n \"timeStarted\": \"2023-09-07T23:56:05.094Z\",\n \"timeFinished\": \"2023-09-07T23:59:32.018Z\"\n}\n"
UpdateDrProtectionGroupDetails:
description: The details for updating a DR protection group.
properties:
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: 'The display name of the DR protection group.
Example: `EBS PHX Group`
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"Department": "Finance"}`
'
type: object
logLocation:
$ref: '#/components/schemas/UpdateObjectStorageLogLocationDetails'
members:
description: 'A list of DR protection group members. When updating members, this list must contain all members being retained,
including added and updated members. The list must not contain deleted members.
'
items:
$ref: '#/components/schemas/UpdateDrProtectionGroupMemberDetails'
type: array
type: object
x-example: "Example showing display name update:\n{\n \"displayName\": \"My DR protection group\"\n}\n\nExample showing member update. The DR protection group initially contained two members --\na Base Database and an Autonomous Database Serverless. This example update is removing the \nAutonomous Database Serverless member, retaining the Database member, and adding a volume group member:\n{\n \"displayName\": \"My DR protection group\",\n \"members\": [\n {\n \"memberId\": \"ocid1.database.oc1..uniqueID\",\n \"memberType\": \"DATABASE\",\n \"passwordVaultSecretId\": \"ocid1.vaultsecret.oc1..uniqueID\"\n },\n {\n \"memberId\": \"ocid1.volumegroup.oc1..uniqueID\",\n \"memberType\": \"VOLUME_GROUP\"\n }\n ]\n}\n\nExample showing log location update:\n{\n \"logLocation\": {\n \"namespace\": \"namespace_string\",\n \"bucket\": \"bucket_name\"\n }\n}\n"
DrProtectionGroupMember:
description: The properties of a member in a DR protection group.
discriminator:
propertyName: memberType
properties:
memberId:
description: 'The OCID of the member.
Example: `ocid1.instance.oc1..uniqueID`
'
maxLength: 255
minLength: 1
type: string
memberType:
description: 'The type of the member.
'
enum:
- COMPUTE_INSTANCE
- COMPUTE_INSTANCE_MOVABLE
- COMPUTE_INSTANCE_NON_MOVABLE
- VOLUME_GROUP
- DATABASE
- AUTONOMOUS_DATABASE
- AUTONOMOUS_CONTAINER_DATABASE
- LOAD_BALANCER
- NETWORK_LOAD_BALANCER
- FILE_SYSTEM
- OKE_CLUSTER
- OBJECT_STORAGE_BUCKET
- MYSQL_DB_SYSTEM
- INTEGRATION_INSTANCE
type: string
x-obmcs-top-level-enum: '#/definitions/DrProtectionGroupMemberType'
required:
- memberId
- memberType
type: object
ResumeDrPlanExecutionDetails:
allOf:
- $ref: '#/components/schemas/DrPlanExecutionControlDetails'
- discriminator: RESUME
description: 'The details for resuming a DR plan execution.
'
x-example: "{\n \"actionType\": \"RESUME\"\n}\n"
CreateDrProtectionGroupMemberDetails:
description: Create properties for a member in a DR protection group.
discriminator:
propertyName: memberType
properties:
memberId:
description: 'The OCID of the member.
Example: `ocid1.instance.oc1..uniqueID`
'
maxLength: 255
minLength: 1
type: string
memberType:
description: 'The type of the member.
'
enum:
- COMPUTE_INSTANCE
- COMPUTE_INSTANCE_MOVABLE
- COMPUTE_INSTANCE_NON_MOVABLE
- VOLUME_GROUP
- DATABASE
- AUTONOMOUS_DATABASE
- AUTONOMOUS_CONTAINER_DATABASE
- LOAD_BALANCER
- NETWORK_LOAD_BALANCER
- FILE_SYSTEM
- OKE_CLUSTER
- OBJECT_STORAGE_BUCKET
- MYSQL_DB_SYSTEM
- INTEGRATION_INSTANCE
type: string
x-obmcs-top-level-enum: '#/definitions/DrProtectionGroupMemberType'
required:
- memberId
- memberType
type: object
x-example: "{\n \"memberId\": \"ocid1.volumegroup.oc1..uniqueID\",\n \"memberType\": \"VOLUME_GROUP\"\n}\n"
ChangeDrProtectionGroupCompartmentDetails:
description: The details for moving a DR protection group to another compartment.
properties:
compartmentId:
description: 'The OCID of the compartment to which the DR protection group should be moved.
Example: `ocid1.compartment.oc1..uniqueID`
'
maxLength: 255
minLength: 1
type: string
required:
- compartmentId
type: object
x-example: "{\n \"compartmentId\": \"ocid1.compartment.oc1..uniqueID\"\n}\n"
AutomaticDrConfiguration:
description: The details of Automatic DR configuration.
properties:
compartmentId:
description: 'The OCID of the compartment containing the Automatic DR configuration.
Example: `ocid1.compartment.oc1..uniqueID`
'
maxLength: 255
minLength: 1
type: string
defaultFailoverDrPlanId:
description: 'The unique id of a Failover DR Plan.
Example: `ocid1.drplan.oc1..uniqueID`
'
maxLength: 255
minLength: 0
type: string
defaultSwitchoverDrPlanId:
description: 'The unique id of a Switchover DR Plan.
Example: `ocid1.drplan.oc1..uniqueID`
'
maxLength: 255
minLength: 0
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: 'The display name of the Automatic DR configuration.
'
maxLength: 255
minLength: 1
type: string
drProtectionGroupId:
description: 'The OCID of the DR protection group to which this Automatic DR configuration belongs.
Example: `ocid1.drprotectiongroup.oc1..uniqueID`
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"Department": "Finance"}`
'
type: object
id:
description: 'The OCID of the Automatic DR configuration.
Example: `ocid1.automaticdrconfiguration.oc1..uniqueID`
'
maxLength: 255
minLength: 1
type: string
lastAutomaticDrExecutionSubmitDetails:
description: 'A message describing the result of the most recent attempt made to submit an Automatic DR plan execution.
'
maxLength: 255
minLength: 0
type: string
lastAutomaticDrExecutionSubmitStatus:
description: 'The status of most recent attempt to submit Automatic DR plan execution.
'
enum:
- AUTOMATIC_DR_EXECUTION_STARTED_SUCCESSFULLY
- AUTOMATIC_DR_EXECUTION_BLOCKED_VALIDATION_FAILED
type: string
x-obmcs-top-level-enum: '#/definitions/AutomaticDrPlanExecutionSubmissionStatus'
lifecycleDetails:
description: 'A message describing the Automatic DR configuration''s current state in more detail.
'
maxLength: 255
minLength: 0
type: string
lifecycleState:
description: 'The current state of the Automatic DR configuration.
'
enum:
- CREATING
- UPDATING
- ACTIVE
- INACTIVE
- NEEDS_ATTENTION
- DELETING
- DELETED
- FAILED
type: string
x-obmcs-top-level-enum: '#/definitions/AutomaticDrConfigurationLifecycleState'
lifecycleSubState:
description: 'The current sub-state of the Automatic DR configuration.
'
enum:
- RESOURCE_PRINCIPAL_VALIDATION_FAILED
- DR_PLAN_NEEDS_ATTENTION
- DR_PLAN_INACTIVE
type: string
x-obmcs-top-level-enum: '#/definitions/AutomaticDrConfigurationLifecycleSubState'
members:
description: 'The list of members in this Automatic DR configuration.
'
items:
$ref: '#/components/schemas/AutomaticDrConfigurationMember'
maxItems: 128
minItems: 1
type: array
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.
Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
'
type: object
timeCreated:
description: 'The date and time the Automatic DR configuration was created. An RFC3339 formatted datetime string.
Example: `2024-03-29T09:36:42Z`
'
format: date-time
type: string
timeLastAutomaticDrExecutionSubmitAttempt:
description: 'The date and time of the most recent attempt made to submit an Automatic DR plan execution. An RFC3339 formatted datetime string.
Example: `2025-06-30T09:36:42Z`
'
format: date-time
type: string
timeUpdated:
description: 'The date and time the Automatic DR configuration was updated. An RFC3339 formatted datetime string.
Example: `2024-03-29T09:36:42Z`
'
format: date-time
type: string
required:
- id
- compartmentId
- displayName
- timeCreated
- timeUpdated
- lifecycleState
- drProtectionGroupId
- members
type: object
x-example: "{\n \"id\": \"ocid1.automaticdrconfiguration.oc1..uniqueID\",\n \"displayName\": \"Automatic DR Configuration\",\n \"compartmentId\": \"ocid1.compartment.oc1..uniqueID\",\n \"timeCreated\": \"2023-09-07T21:09:16.420Z\",\n \"timeUpdated\": \"2023-09-07T22:09:16.420Z\",\n \"drProtectionGroupId\": \"ocid1.drprotectiongroup.oc1..uniqueID1\",\n \"lifecycleState\": \"ACTIVE\",\n \"lifecycleDetails\": \"\",\n \"freeformTags\": {\n \"Department\": \"Finance\"\n },\n \"definedTags\": {\n \"Operations\": {\n \"CostCenter\": \"42\"\n }\n },\n \"members\": [\n {\n \"memberId\": \"ocid1.autonomousdatabase.oc1..uniqueID\",\n \"memberType\": \"AUTONOMOUS_DATABASE\",\n \"isAutoSwitchoverEnabled\": true,\n \"isAutoFailoverEnabled\": true\n },\n {\n \"memberId\": \"ocid1.autonomousdatabase.oc1..uniqueID\",\n \"memberType\": \"AUTONOMOUS_DATABASE\",\n \"isAutoFailoverEnabled\": true\n }\n ],\n \"defaultSwitchoverDrPlanId\": \"ocid1.drplan.oc1..uniqueID\",\n \"defaultFailoverDrPlanId\": \"ocid1.drplan.oc1..uniqueID1\"\n}\n"
WorkRequestResource:
description: A resource created or operated on by a work request.
properties:
actionType:
description: 'The way in which this resource is affected by the work tracked in the work request.
A resource being created, updated, or deleted will remain in the IN_PROGRESS state until
work is complete for that resource at which point it will transition to CREATED, UPDATED,
or DELETED, respectively.
'
enum:
- CREATED
- UPDATED
- DELETED
- IN_PROGRESS
- RELATED
- FAILED
type: string
x-obmcs-top-level-enum: '#/definitions/ActionType'
entityType:
description: 'The resource type the work request affects.
Example: `DrPlanExecution`
'
type: string
entityUri:
description: 'The URI path that the user can use to perform a GET on the resource metadata.
'
type: string
identifier:
description: 'The identifier (OCID) of the resource the work request affects.
Example: `ocid1.drplanexecution.oc1..uniqueID`
'
type: string
required:
- actionType
- entityType
- identifier
x-example: "{\n \"entityType\": \"drprotectiongroup\",\n \"actionType\": \"CREATED\",\n \"identifier\": \"ocid1.drprotectiongroup.oc1..uniqueID\",\n \"entityUri\": \"/drProtectionGroups/ocid1.drprotectiongroup.oc1..uniqueID\"\n}\n"
DrProtectionGroup:
description: The details of a DR protection group.
properties:
compartmentId:
description: 'The OCID of the compartment containing the DR protection group.
Example: `ocid1.compartment.oc1..uniqueID`
'
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: 'The display name of the DR protection group.
Example: `EBS PHX Group`
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"Department": "Finance"}`
'
type: object
id:
description: 'The OCID of the DR protection group.
Example: `ocid1.drprotectiongroup.oc1..uniqueID`
'
maxLength: 255
minLength: 1
type: string
lifeCycleDetails:
description: 'A message describing the DR protection group''s current state in more detail.
'
type: string
lifecycleState:
description: 'The current state of the DR protection group.
'
enum:
- CREATING
- ACTIVE
- UPDATING
- INACTIVE
- NEEDS_ATTENTION
- DELETING
- DELETED
- FAILED
type: string
x-obmcs-top-level-enum: '#/definitions/DrProtectionGroupLifecycleState'
lifecycleSubState:
description: 'The current sub-state of the DR protection group.
'
enum:
- DR_DRILL_IN_PROGRESS
- DR_PLAN_EXECUTION_IN_PROGRESS
- AUTOMATIC_DR_PLAN_EXECUTION_IN_PROGRESS
type: string
x-obmcs-top-level-enum: '#/definitions/DrProtectionGroupLifecycleSubState'
logLocation:
$ref: '#/components/schemas/ObjectStorageLogLocation'
members:
description: 'A list of DR protection group members.
'
items:
$ref: '#/components/schemas/DrProtectionGroupMember'
type: array
peerId:
description: 'The OCID of the peer DR protection group.
Example: `ocid1.drprotectiongroup.oc1..uniqueID`
'
maxLength: 255
minLength: 1
type: string
peerRegion:
description: 'The region of the peer DR protection group.
Example: `us-ashburn-1`
'
maxLength: 255
minLength: 1
type: string
role:
description: 'The role of the DR protection group.
'
enum:
- PRIMARY
- STANDBY
- UNCONFIGURED
type: string
x-obmcs-top-level-enum: '#/definitions/DrProtectionGroupRole'
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.
Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
'
type: object
timeCreated:
description: 'The date and time the DR protection group was created. An RFC3339 formatted datetime string.
Example: `2019-03-29T09:36:42Z`
'
format: date-time
type: string
timeUpdated:
description: 'The date and time the DR protection group was updated. An RFC3339 formatted datetime string.
Example: `2019-03-29T09:36:42Z`
'
format: date-time
type: string
required:
- id
- compartmentId
- displayName
- role
- timeCreated
- timeUpdated
- lifecycleState
type: object
DrPlanGroupExecution:
description: The details of a group execution in a DR plan execution.
properties:
displayName:
description: 'The display name of the group execution.
Example: `DATABASE_SWITCHOVER`
'
maxLength: 255
minLength: 1
type: string
executionDurationInSec:
description: 'The total duration in seconds taken to complete group execution.
Example: `120`
'
format: int32
type: integer
groupId:
description: 'The unique id of the group. Must not be modified by user.
Example: `sgid1.group..uniqueID`
'
maxLength: 255
minLength: 1
type: string
status:
description: 'The status of the group execution.
'
enum:
- QUEUED
- DISABLED
- IN_PROGRESS
- SUCCEEDED
- SUCCEEDED_WITH_WARNING
- FAILED
- FAILED_IGNORED
- TIMED_OUT
- TIMED_OUT_IGNORED
- PAUSED
- CANCELED
type: string
x-obmcs-top-level-enum: '#/definitions/DrPlanGroupExecutionStatus'
statusDetails:
description: 'Additional details on the group execution status.
Example: `A total of [3] steps failed in the group`
'
type: string
stepExecutions:
description: 'A list of step executions in the group.
'
items:
$ref: '#/components/schemas/DrPlanStepExecution'
type: array
timeEnded:
description: 'The time when group execution ended. An RFC3339 formatted datetime string.
Example: `2019-03-29T09:36:42Z`
'
format: date-time
type: string
timeStarted:
description: 'The time when group execution began. An RFC3339 formatted datetime string.
Example: `2019-03-29T09:36:42Z`
'
format: date-time
type: string
type:
description: 'The group type.
Example: `BUILT_IN`
'
enum:
- USER_DEFINED
- BUILT_IN
- BUILT_IN_PRECHECK
- USER_DEFINED_PAUSE
type: string
x-obmcs-top-level-enum: '#/definitions/DrPlanGroupType'
required:
- groupId
- type
- displayName
- status
- stepExecutions
type: object
x-example: "{\n \"groupId\": \"sgid1.group..uniqueID\",\n \"type\": \"BUILT_IN\",\n \"displayName\": \"Launch Compute Instances (Standby)\",\n \"status\": \"SUCCEEDED\",\n \"statusDetails\": \"\",\n \"timeStarted\": \"2023-09-07T22:39:19.253Z\",\n \"timeEnded\": \"2023-09-07T22:39:21.253Z\",\n \"executionDurationInSec\": 120,\n \"stepExecutions\": [\n {\n \"stepId\": \"sgid1.step..uniqueID\",\n \"type\": \"COMPUTE_INSTANCE_LAUNCH\",\n \"groupId\": \"sgid1.group..uniqueID\",\n \"displayName\": \"myhost1\",\n \"logLocation\": {\n \"namespace\": \"namespace_string\",\n \"bucket\": \"bucket_name\",\n \"object\": \"object_name\"\n },\n \"status\": \"SUCCEEDED\",\n \"statusDetails\": \"\",\n \"timeStarted\": \"2023-09-07T22:39:19.253Z\",\n \"timeEnded\": \"2023-09-07T22:39:21.253Z\",\n \"executionDurationInSec\": 120\n }\n ]\n}\n"
ObjectStorageLogLocation:
description: The details of an object storage log location for a DR protection group.
properties:
bucket:
description: 'The bucket name inside the object storage namespace.
Example: `operation_logs`
'
maxLength: 255
minLength: 1
type: string
namespace:
description: 'The namespace in object storage (Note - this is usually the tenancy name).
Example: `myocitenancy`
'
maxLength: 255
minLength: 1
type: string
object:
description: 'The object name inside the object storage bucket.
Example: `switchover_plan_executions`
'
maxLength: 255
minLength: 1
type: string
required:
- namespace
- bucket
type: object
x-example: "{\n \"namespace\": \"namespace_string\",\n \"bucket\": \"bucket_name\",\n \"object\": \"object_name\"\n}\n"
AssociateDrProtectionGroupDetails:
description: The details for associating a DR protection group with a peer DR protection group.
properties:
peerId:
description: 'The OCID of the peer DR protection group.
Example: `ocid1.drprotectiongroup.oc1..uniqueID`
'
maxLength: 255
minLength: 1
type: string
peerRegion:
description: 'The region of the peer DR protection group.
Example: `us-ashburn-1`
'
maxLength: 255
minLength: 1
type: string
role:
description: 'The role of the DR protection group.
Example: `STANDBY`
'
enum:
- PRIMARY
- STANDBY
- UNCONFIGURED
type: string
x-obmcs-top-level-enum: '#/definitions/DrProtectionGroupRole'
required:
- role
type: object
x-example: "{\n \"peerId\": \"ocid1.drprotectiongroup.oc1..uniqueID\",\n \"peerRegion\": \"us-ashburn-1\",\n \"role\": \"STANDBY\"\n}\n"
AutomaticDrConfigurationCollection:
description: A list of Automatic DR configuration summaries.
properties:
items:
description: 'A list of Automatic DR configuration summaries.
'
items:
$ref: '#/components/schemas/AutomaticDrConfigurationSummary'
minItems: 0
type: array
required:
- items
type: object
x-example: "{\n \"items\": [\n {\n \"id\": \"ocid1.automaticdrconfiguration.oc1..uniqueID\",\n \"displayName\": \"Automatic DR configuration\",\n \"compartmentId\": \"ocid1.compartment.oc1..uniqueID\",\n \"timeCreated\": \"2024-07-05T23:09:45.614Z\",\n \"timeUpdated\": \"2024-07-05T23:09:45.615Z\",\n \"drProtectionGroupId\": \"ocid1.drprotectiongroup.oc1..uniqueID\",\n \"lifecycleState\": \"ACTIVE\",\n \"freeformTags\": {\n \"Department\": \"Finance\"\n },\n \"definedTags\": {\n \"Operations\": {\n \"CostCenter\": \"42\"\n }\n }\n }\n ]\n}\n"
DrPlanExecutionSkippedStepStatusCounts:
description: 'A summary of steps that were skipped during a DR plan execution, including disabled, failed but ignored, timed out but ignored, and canceled steps.
'
properties:
canceled:
description: 'The total number of canceled steps in a DR plan execution.
'
format: int32
type: integer
disabled:
description: 'The total number of disabled steps in a DR plan execution.
'
format: int32
type: integer
failedIgnored:
description: 'The total number of steps that failed but were ignored during a DR plan execution.
'
format: int32
type: integer
timedOutIgnored:
description: 'The total number of steps that timed out but were ignored during a DR plan execution.
'
format: int32
type: integer
totalSkipped:
description: 'The total number of steps that were skipped during a DR plan execution.
'
format: int32
type: integer
required:
- totalSkipped
- disabled
- failedIgnored
- timedOutIgnored
- canceled
type: object
x-example: "{\n \"totalSkipped\": 2,\n \"disabled\": 1,\n \"failedIgnored\": 0,\n \"timedOutIgnored\": 1,\n \"canceled\": 0\n}\n"
DrPlanExecutionRemainingStepStatusCounts:
description: 'A summary of remaining steps in a DR plan execution, including queued, paused, and in-progress steps.
'
properties:
inProgress:
description: 'The total number of steps in progress during a DR plan execution.
'
format: int32
type: integer
paused:
description: 'The total number of paused steps in a DR plan execution.
'
format: int32
type: integer
queued:
description: 'The total number of queued steps in a DR plan execution.
'
format: int32
type: integer
totalRemaining:
description: 'The total number of remaining steps in a DR plan execution.
'
format: int32
type: integer
required:
- totalRemaining
- queued
- paused
- inProgress
type: object
x-example: "{\n \"totalRemaining\": 45,\n \"queued\": 40,\n \"paused\": 0,\n \"inProgress\": 5\n}\n"
WorkRequestError:
description: An error associcated with a work request.
properties:
code:
description: 'A machine-usable code for the error that occured. Error codes are listed here --
(https://docs.cloud.oracle.com/Content/API/References/apierrors.htm).
Example: `429`
'
type: string
message:
description: 'A human-readable description of the issue encountered.
Example: `TooManyRequests`
'
type: string
timestamp:
description: 'The time the error occured. An RFC3339 formatted datetime string.
Example: `2019-03-29T09:36:42Z`
'
format: date-time
type: string
required:
- code
- message
- timestamp
x-example: "{\n \"code\": \"500\",\n \"message\": \"WorkRequest Failed\",\n \"timestamp\": \"2023-09-03T09:39:13.238Z\"\n}\n"
UpdateDrProtectionGroupRoleDetails:
description: The details for updating the role of a DR protection group.
properties:
role:
description: 'The new role of the DR protection group.
'
enum:
- PRIMARY
- STANDBY
- UNCONFIGURED
type: string
x-obmcs-top-level-enum: '#/definitions/DrProtectionGroupRole'
required:
- role
type: object
x-example: "{\n \"role\": \"STANDBY\"\n}\n"
DrPlanExecutionCollection:
description: 'A list of DR plan execution summaries.
'
properties:
items:
description: 'A list of DR plan execution summaries.
'
items:
$ref: '#/components/schemas/DrPlanExecutionSummary'
type: array
required:
- items
type: object
x-example: "{\n \"items\": [\n {\n \"id\": \"ocid1.drplanexecution.oc1..uniqueID\",\n \"compartmentId\": \"ocid1.compartment.oc1..uniqueID\",\n \"displayName\": \"Execution - EBS Switchover PHX to IAD\",\n \"planId\": \"ocid1.drplan.oc1..uniqueID\",\n \"planExecutionType\": \"SWITCHOVER\",\n \"drProtectionGroupId\": \"ocid1.drprotectiongroup.oc1..uniqueID1\",\n \"peerDrProtectionGroupId\": \"ocid1.drprotectiongroup.oc1..uniqueID2\",\n \"peerRegion\": \"us-ashburn-1\",\n \"logLocation\": {\n \"namespace\": \"namespace_string\",\n \"bucket\": \"bucket_name\",\n \"object\": \"object_name\"\n },\n \"timeCreated\": \"2023-09-07T22:37:18.153Z\",\n \"timeStarted\": \"2023-09-07T22:39:18.253Z\",\n \"timeUpdated\": \"2023-09-07T22:39:45.354Z\",\n \"timeEnded\": \"2023-09-07T22:57:42.389Z\",\n \"executionDurationInSec\": 1224,\n \"lifecycleState\": \"SUCCEEDED\",\n \"lifeCycleDetails\": \"\",\n \"freeformTags\": {\n \"Department\": \"Finance\"\n },\n \"definedTags\": {\n \"Operations\": {\n \"CostCenter\": \"42\"\n }\n }\n }\n ]\n}\n"
DrPlanExecutionFailedStepStatusCounts:
description: 'A summary of steps that failed during a DR plan execution, including failed and timed out steps.
'
properties:
failed:
description: 'The total number of failed steps in a DR plan execution.
'
format: int32
type: integer
timedOut:
description: 'The total number of steps that timed out during a DR plan execution.
'
format: int32
type: integer
totalFailed:
description: 'The total number of steps that failed during a DR plan execution.
'
format: int32
type: integer
required:
- totalFailed
- failed
- timedOut
type: object
x-example: "{\n \"totalFailed\": 1,\n \"failed\": 1,\n \"timedOut\": 0\n}\n"
DrPlanSummary:
description: The summary of a DR plan.
properties:
compartmentId:
description: 'The OCID of the compartment containing the DR plan.
Example: `ocid1.compartment.oc1..uniqueID`
'
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: 'The display name of the DR plan.
Example: `EBS Switchover PHX to IAD`
'
maxLength: 255
minLength: 1
type: string
drProtectionGroupId:
description: 'The OCID of the DR protection group to which this DR plan belongs.
Example: `ocid1.drprotectiongroup.oc1..uniqueID`
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"Department": "Finance"}`
'
type: object
id:
description: 'The OCID of the DR plan.
Example: `ocid1.drplan.oc1..uniqueID`
'
maxLength: 255
minLength: 1
type: string
lifeCycleDetails:
description: 'A message describing the DR plan''s current state in more detail.
'
type: string
lifecycleState:
description: 'The current state of the DR plan.
Example: `ACTIVE`
'
enum:
- CREATING
- UPDATING
- ACTIVE
- INACTIVE
- DELETING
- DELETED
- FAILED
- NEEDS_ATTENTION
type: string
x-obmcs-top-level-enum: '#/definitions/DrPlanLifecycleState'
lifecycleSubState:
description: 'The current sub state of the DR plan.
Example: `NEEDS_REFRESH`
'
enum:
- NEEDS_REFRESH
- NEEDS_VERIFICATION
- REFRESHING
- VERIFYING
type: string
x-obmcs-top-level-enum: '#/definitions/DrPlanLifecycleSubState'
peerDrProtectionGroupId:
description: 'The OCID of the peer DR protection group associated with this plan''s
DR protection group.
Example: `ocid1.drprotectiongroup.oc1..uniqueID`
'
maxLength: 255
minLength: 1
type: string
peerRegion:
description: 'The region of the peer DR protection group associated with this plan''s
DR protection group.
Example: `us-ashburn-1`
'
maxLength: 255
minLength: 1
type: string
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.
Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
'
type: object
timeCreated:
description: 'The date and time the DR plan was created. An RFC3339 formatted datetime string.
Example: `2019-03-29T09:36:42Z`
'
format: date-time
type: string
timeUpdated:
description: 'The date and time the DR plan was updated. An RFC3339 formatted datetime string.
Example: `2019-03-29T09:36:42Z`
'
format: date-time
type: string
type:
description: 'The type of the DR plan.
Example: `SWITCHOVER`
'
enum:
- SWITCHOVER
- FAILOVER
- START_DRILL
- STOP_DRILL
type: string
x-obmcs-top-level-enum: '#/definitions/DrPlanType'
required:
- id
- compartmentId
- displayName
- type
- drProtectionGroupId
- peerDrProtectionGroupId
- peerRegion
- timeCreated
- timeUpdated
- lifecycleState
type: object
x-example: "{\n \"id\": \"ocid1.drplan.oc1..uniqueID\",\n \"compartmentId\": \"ocid1.compartment.oc1..uniqueID\",\n \"displayName\": \"EBS Switchover PHX to IAD\",\n \"type\": \"SWITCHOVER\",\n \"drProtectionGroupId\": \"ocid1.drprotectiongroup.oc1..uniqueID1\",\n \"peerDrProtectionGroupId\": \"ocid1.drprotectiongroup.oc1..uniqueID2\",\n \"peerRegion\": \"us-ashburn-1\",\n \"timeCreated\": \"2023-09-07T21:09:16.420Z\",\n \"timeUpdated\": \"2023-09-07T22:09:16.420Z\",\n \"lifecycleState\": \"ACTIVE\",\n \"lifeCycleDetails\": \"\",\n \"lifecycleSubState\": null,\n \"freeformTags\": {\n \"Department\": \"Finance\"\n },\n \"definedTags\": {\n \"Operations\": {\n \"CostCenter\": \"42\"\n }\n }\n}\n"
DrPlanCollection:
description: A list of DR plan summaries.
properties:
items:
description: 'A list of DR plan summaries.
'
items:
$ref: '#/components/schemas/DrPlanSummary'
type: array
required:
- items
type: object
x-example: "{\n \"items\": [\n {\n \"id\": \"ocid1.drplan.oc1..uniqueID\",\n \"compartmentId\": \"ocid1.compartment.oc1..uniqueID\",\n \"displayName\": \"EBS Switchover PHX to IAD\",\n \"type\": \"SWITCHOVER\",\n \"drProtectionGroupId\": \"ocid1.drprotectiongroup.oc1..uniqueID1\",\n \"peerDrProtectionGroupId\": \"ocid1.drprotectiongroup.oc1..uniqueID2\",\n \"peerRegion\": \"us-ashburn-1\",\n \"timeCreated\": \"2023-09-07T21:09:16.420Z\",\n \"timeUpdated\": \"2023-09-07T22:09:16.420Z\",\n \"lifecycleState\": \"ACTIVE\",\n \"lifeCycleDetails\": \"\",\n \"freeformTags\": {\n \"Department\": \"Finance\"\n },\n \"definedTags\": {\n \"Operations\": {\n \"CostCenter\": \"42\"\n }\n }\n }\n ]\n}\n"
WorkRequestErrorCollection:
description: 'The results of a workRequestError search. Contains both WorkRequestError items
and other information, such as metadata.
'
properties:
items:
description: 'A list of work request errors.
'
items:
$ref: '#/components/schemas/WorkRequestError'
type: array
required:
- items
type: object
x-example: "{\n \"items\": [ \n {\n \"code\": \"500\",\n \"message\": \"WorkRequest Failed\",\n \"timestamp\": \"2023-09-03T09:39:13.238Z\"\n }\n ]\n}\n"
CancelDrPlanExecutionDetails:
allOf:
- $ref: '#/components/schemas/DrPlanExecutionControlDetails'
- discriminator: CANCEL
description: 'The details for cancelling a DR plan execution.
'
x-example: "{\n \"actionType\": \"CANCEL\"\n}\n"
DrPlanExecutionControlDetails:
description: The details for controlling plan execution.
discriminator:
propertyName: actionType
properties:
actionType:
description: 'The type of control action.
'
enum:
- CANCEL
- PAUSE
- RESUME
type: string
required:
- actionType
type: object
DrPlanExecutionStepStatusCounts:
description: 'A categorized summary of step execution statuses and their corresponding counts.
'
properties:
failedSteps:
$ref: '#/components/schemas/DrPlanExecutionFailedStepStatusCounts'
remainingSteps:
$ref: '#/components/schemas/DrPlanExecutionRemainingStepStatusCounts'
skippedSteps:
$ref: '#/components/schemas/DrPlanExecutionSkippedStepStatusCounts'
successfulSteps:
$ref: '#/components/schemas/DrPlanExecutionSuccessfulStepStatusCounts'
totalSteps:
description: 'The total number of steps in a DR plan execution.
'
format: int32
type: integer
warningSteps:
$ref: '#/components/schemas/DrPlanExecutionWarningStepStatusCounts'
required:
- totalSteps
- remainingSteps
- skippedSteps
- successfulSteps
- warningSteps
- failedSteps
type: object
x-example: "{\n \"totalSteps\": 52,\n \"remainingSteps\": {\n \"totalRemaining\": 45,\n \"queued\": 40,\n \"paused\": 0,\n \"inProgress\": 5\n },\n \"skippedSteps\": {\n \"totalSkipped\": 2,\n \"disabled\": 1,\n \"failedIgnored\": 0,\n \"timedOutIgnored\": 1,\n \"canceled\": 0\n },\n \"successfulSteps\": {\n \"totalSuccessful\": 2,\n \"succeeded\": 2\n },\n \"warningSteps\": {\n \"totalWarnings\": 2,\n \"warningsIgnored\": 2\n },\n \"failedSteps\": {\n \"totalFailed\": 1,\n \"failed\": 1,\n \"timedOut\": 0\n }\n}\n"
AutomaticExecutionDetails:
description: The details of the event that started the automatic DR plan execution.
properties:
eventName:
description: 'The name of the OCI event that started the automatic DR plan execution.
Example: `SwitchoverAutonomousDatabase`
'
maxLength: 255
minLength: 1
type: string
memberId:
description: 'The OCID of the member that emitted the event that started the automatic DR plan execution.
Example: "ocid1.autonomousdatabase.oc1..uniqueID"
'
maxLength: 255
minLength: 1
type: string
required:
- eventName
- memberId
type: object
x-example: "{\n \"eventName\": \"SwitchoverAutonomousDatabase\",\n \"memberId\": \"ocid1.autonomousdatabase.oc1..uniqueID\"\n}\n"
WorkRequestLogEntryCollection:
description: 'The results of a workRequestLog search. Contains both WorkRequestLog items
and other information, such as metadata.
'
properties:
items:
description: 'A list of workRequestLogEntries.
'
items:
$ref: '#/components/schemas/WorkRequestLogEntry'
type: array
required:
- items
type: object
x-example: "{\n \"items\": [ \n {\n \"message\": \"DR plan was created successfully\",\n \"timestamp\": \"2023-09-03T17:04:55.423Z\"\n }\n ]\n}\n"
responses:
default:
description: Unknown Error
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
x-anchors:
x-headers:
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
etag:
description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
'
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"Department": "Finance"}`
'
type: object
location:
description: A URI for the new resource which was created by the request.
type: string
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then a partial list might have been returned. Include this value as the `page` parameter for the
subsequent GET request to get the next batch of items.
'
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier (OCID) for the asynchronous request. You can use this to query status of the asynchronous operation. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request.
'
type: string
retry-after:
description: A decimal number representing the number of seconds the client should wait before polling this endpoint again.
format: float
type: number
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.
Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
'
type: object
x-properties: null
x-obmcs-client-retries-enabled: true
x-oracle-package: com.oracle.pic.disasterrecovery