Jump to

• Request
• Response

Change Roles in a Data Guard Configuration

post

/paas/service/dbcs/api/v1.1/instances/{identityDomainId}/{serviceId}/standby

Change the roles of the primary and standby databases on the two nodes of a Database Classic Cloud Service instance hosting an Oracle Data Guard configuration. You can make three role changes:

• Switchover: Switches the roles of the primary database and the standby database. There is no data loss during a switchover. After a switchover, each database continues to participate in the Oracle Data Guard configuration in its new role.

• Failover: Causes the standby database to take over as the primary database. The primary database is no longer considered a part of the Data Guard configuration.

• Reinstate: Used after a failover to reinstate the previous primary database as part of the Data Guard configuration, giving it the standby role.

Request

Supported Media Types

• application/vnd.com.oracle.oracloud.provisioning.Service+json

Path Parameters

• identityDomainId: string
  Identity domain ID for the Database Classic Cloud Service account:
   

  • For a Cloud account with Identity Cloud Service: the identity service ID, which has the form idcs-letters-and-numbers. You can find this ID in the Identity Service Id field on the Overview tab of the Service Details page for Database Classic Cloud Service in My Services.

  • For a traditional cloud account: the name of the identity domain.

• serviceId: string
  Name of the Database Classic Cloud Service instance.

Header Parameters

• Authorization: string
  Base64 encoding of the user name and password of the user making the request. For more information, see Security, Authentication and Authorization.
• X-ID-TENANT-NAME: string
  Identity domain ID for the Database Classic Cloud Service account:
   

  • For a Cloud account with Identity Cloud Service: the identity service ID, which has the form idcs-letters-and-numbers. You can find this ID in the Identity Service Id field on the Overview tab of the Service Details page for Database Classic Cloud Service in My Services.

  • For a traditional cloud account: the name of the identity domain.

Body ()

Root Schema : Request Body

Type: object

Title: Request Body

Show Source

• action(optional): string
  The role-change action to be performed on the Database Classic Cloud Service instance hosting an Oracle Data Guard configuration. Valid values: switchover, failover, reinstate.
• force(optional): string
  Optional parameter only when the failover action is specified. Valid values: yes and no. Default value is no.

  In general, You should use the deafult value of no. However, if a failover operation fails and you review the messages describing the cause of the failure, you might choose to try the failover operation again with the force parameter set to yes. Note that forcing a failover operation can result in potential data loss.

{
    "title":"Request Body",
    "type":"object",
    "description":"",
    "properties":{
        "action":{
            "type":"string",
            "description":"The role-change action to be performed on the Database Classic Cloud Service instance hosting an Oracle Data Guard configuration. Valid values: <code>switchover</code>, <code>failover</code>, <code>reinstate</code>."
        },
        "force":{
            "type":"string",
            "description":"Optional parameter only when the <code>failover</code> action is specified. Valid values: <code>yes</code> and <code>no</code>. Default value is <code>no</code>. <p>In general, You should use the deafult value of <code>no</code>. However, if a failover operation fails and you review the messages describing the cause of the failure, you might choose to try the failover operation again with the <code>force</code> parameter set to <code>yes</code>. Note that forcing a failover operation can result in potential data loss.</p>"
        }
    }
}

Back to Top

Response

202 Response

Accepted. See Status Codes for information about other possible HTTP status codes.

Headers

• Location: string
  A REST URI you can use to check the progress and completion of the change role operation.

Back to Top