DisasterRecovery - ApsaraMQ for MQTT - Alibaba Cloud Documentation Center

Restores Internet access for an instance using its virtual IP address (VIP) for graceful recovery in a multi-instance disaster recovery architecture. This operation is available only for Platinum Edition instances. To use this operation, submit a ticket.

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

mq:DisasterRecovery

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the ApsaraMQ for MQTT instance.	mqtt-cn-xxx
RecoveryInstanceId	string	Yes	The ID of the instance to recover.	mqtt-cn-xxx

Response elements

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The ID of the request.	135F8639-F262-4417-98D1-4DE4595C****
Code	integer	The return code. A value of 200 indicates that the call is successful. Other values indicate error codes. For more information about error codes, see Error codes.	200
Success	boolean	Indicates whether the call was successful. A value of true indicates that the call was successful. A value of false indicates that the call failed.	True
Message	string	The returned message.	operation success.
AccessDeniedDetail	string	The details that are returned when the access is denied. This field is returned only when the RAM authentication fails.	{}

Examples

Success response

JSON format

{
  "RequestId": "135F8639-F262-4417-98D1-4DE4595C****",
  "Code": 200,
  "Success": true,
  "Message": "operation success.",
  "AccessDeniedDetail": "{}"
}

Error codes

HTTP status code	Error code	Error message
400	InstancePermissionCheckFailed	An error occurred while validating the permissions of the instance. Please verify the account that created the instance and its permissions settings.
400	InvalidParameter.%s	An error occurred while validating the parameter. The parameter may be missing or invalid.
500	InternalError	An error occurred while processing your request. Try again later.
404	ApiNotSupport	The specified API is not supported.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.