Query the status of a disaster recovery switchover task using GetFoTaskStatus - Cloud Architect Design Tools - Alibaba Cloud - Cloud Architect Design Tools

Operation description

Queries the status of a disaster recovery switchover task by task ID.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

bpstudio:GetFoTaskStatus

get

*BPStudioVirtual

acs:bpstudio::{#accountId}:bpstudiovirtual/{#BPStudioVirtualId}

None

Request parameters

Parameter	Type	Required	Description	Example
TaskId	integer	No	The disaster recovery switchover task ID.	2615

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	923692F0-A15B-58B4-BAF4-2AFA4AF46240
Message	string	The returned message. If the request was successful, a success message is returned. If the request failed, an error message is returned.	OKITHEVRQCN6ULQG
Code	string	The response code.	200
Data	string	The status of the switchover task.	Running

Task states:

Creating: The task is being created.
Modified: The task is modified.
Verifying: The task is being verified.
Verified_Failure: The task failed to pass the verification.
Verified_Success: The task passed the verification.
Valuating: Fees are being calculated for the task.
Valuating_Failure: Fees failed to be calculated for the task.
Valuating_Success: Fees are calculated for the task.
Deploying: The task is being deployed.
Deployed_Failure: The task failed to be deployed.
Partially_Deployed_Success: Some resources of the task are deployed.
Deployed_Success: The task is deployed.
Destroying: The task is being released.
Delayed_Destroy: The task release is delayed.
Destroyed_Failure: The task failed to be released.
Partially_Destroyed_Success: Some resources of the task are released.
Destroyed_Success: The task is released.
Revised: The task architecture is adjusted.
Verifying_In_Revision: The task resources are being verified during architecture adjustment.
Verified_Failure_In_Revision: The task resources failed to pass the verification during architecture adjustment.
Verified_Success_In_Revision: The task resources are verified during architecture adjustment.
Valuating_In_Revision: Fees are being calculated for the task during architecture adjustment.
Valuating_Failure_In_Revision: Fees failed to be calculated for the task during architecture adjustment.
Valuating_Success_In_Revision: Fees are calculated for the task during architecture adjustment.

Examples

Success response

JSON format

{
  "RequestId": "923692F0-A15B-58B4-BAF4-2AFA4AF46240",
  "Message": "OKITHEVRQCN6ULQG",
  "Code": "200",
  "Data": "Running"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.