AddDisasterRecoveryItem - ApsaraMQ for RocketMQ - Alibaba Cloud Documentation Center

This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Add Disaster Recovery Plan Entry

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
rocketmq:AddDisasterRecoveryItem	update	*Topic `acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}`	none	none

Request syntax

POST /disaster_recovery/{planId}/items HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
planId	long	Yes	Backup plan ID	1300000016
body	object	No	Request body structure. Required.
topics	array<object>	No	Topics included in the backup mapping. Required.
topic	object	No	Topics included in the backup mapping
regionId	string	No	Region ID	cn-hangzhou
instanceType	string	No	Instance type ALIYUN_ROCKETMQ: Alibaba Cloud instance EXTERNAL_ROCKETMQ: External instance, open-source instance, open-source cluster	ALIYUN_ROCKETMQ
instanceId	string	No	Instance ID, an instance ID will be automatically generated when `instanceType` is `EXTERNAL_ROCKETMQ`, and it can be obtained by querying the backup plan.	rmq-cn-em93y94xxx
topicName	string	No	Disaster recovery topic name, required	Topic_xxx
consumerGroupId	string	No	Consumer group ID, required for ACTIVE_ACTIVE bidirectional backup	GID_xxx
deliveryOrderType	string	No	The order in which messages are delivered to the target instance. The parameter values are as follows: Concurrently: concurrent delivery Orderly: sequential delivery	Concurrently

Response parameters

Parameter	Type	Description	Example
	object	Result
requestId	string	Request ID	AF9A8B10-C426-530F-A0DD-96320B39****
success	boolean	Whether the operation was successful	true
data	long	Return result, mapping task ID	1300000016
code	string	Error code	200
message	string	Error message	xxx
httpStatusCode	integer	HTTP status code	200
dynamicCode	string	Dynamic error code	InstanceId
dynamicMessage	string	Dynamic error message	instanceId
accessDeniedDetail	string	Access denied details, only in the scenario where the user is denied access due to RAM not having permission	xxx

Examples

Sample success responses

JSONformat

{
  "requestId": "AF9A8B10-C426-530F-A0DD-96320B39****",
  "success": true,
  "data": 1300000016,
  "code": "200",
  "message": "xxx",
  "httpStatusCode": 200,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "instanceId",
  "accessDeniedDetail": "xxx"
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2025-02-18	The internal configuration of the API is changed, but the call is not affected	View Change Details