All Products
Search
Document Center

Cloud Architect Design Tools:AppFailOver

Last Updated:Feb 08, 2025

Switches a disaster recovery application to another supported zone.

Operation description

You can call this operation to switch a disaster recovery application to another supported zone.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
bpstudio:AppFailOverupdate
*Application
acs:bpstudio::{#accountId}:application/{#ApplicationId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ApplicationIdstringNo

The application ID.

BE68D71ZY5YYIU9R
FailZonestringNo

The destination zone to which you want to switch the disaster recovery application.

cn-hangzhou-g

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

9656C816-1E9A-58D2-86D5-710678D61AF1
Messagestring

The returned message. If the request was successful, a success message is returned. If the request failed, an error message is returned.

Success
Codestring

The response code.

200
Datainteger

The disaster recovery switchover task ID.

7441

Examples

Sample success responses

JSONformat

{
  "RequestId": "9656C816-1E9A-58D2-86D5-710678D61AF1",
  "Message": "Success",
  "Code": "200",
  "Data": 7441
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history