UpdateDisasterRecoveryItem - ApsaraMQ for RocketMQ - Alibaba Cloud Documentation Center

Updates a topic mapping in a global message backup plan.

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:UpdateDisasterRecoveryItem	update	*DisasterRecoveryItem `acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}`	none	none

Request syntax

PATCH /disaster_recovery/{planId}/items/{itemId} HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
planId	long	Yes	The ID of the global message backup plan.	1300000016
itemId	long	Yes	The ID of the topic mapping.	100070284
body	object	No	The request body.
topics	array<object>	No	The topics involved in the topic mapping.
	object	No	The topic involved in the topic mapping.
regionId	string	No	The region ID.	cn-hangzhou
instanceType	string	No	The instance type. Valid values: ALIYUN_ROCKETMQ: ApsaraMQ for RocketMQ instance EXTERNAL_ROCKETMQ: open source RocketMQ cluster	ALIYUN_ROCKETMQ
instanceId	string	No	The instance ID. If you set instanceType to EXTERNAL_ROCKETMQ, the system automatically generates an ID for the instance. You can obtain the ID by querying the global message backup plan.	rmq-cn-em93y94xxx
topicName	string	No	The topic name. You must specify this parameter.	Topic_xxx
consumerGroupId	string	No	The ID of the consumer group. If you use the two-way backup mode, you must specify this parameter.	GID_xxx
deliveryOrderType	string	No	The method used to deliver messages to the destination instance. Valid values: Concurrently: concurrent delivery Orderly: ordered delivery	Concurrently

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
requestId	string	The request ID.	0C32BED2-FA9F-50AD-9DA7-8B70E26C9D0D
success	boolean	Indicates whether the request was successful.	true
data	boolean	The returned data.	true
code	string	The error code.	Topic.NotFound
message	string	The error message.	The instance cannot be found.
httpStatusCode	integer	The response code.	200
dynamicCode	string	The dynamic error code.	InstanceId
dynamicMessage	string	The dynamic error message.	instanceId

Examples

Sample success responses

JSONformat

{
  "requestId": "0C32BED2-FA9F-50AD-9DA7-8B70E26C9D0D",
  "success": true,
  "data": true,
  "code": "Topic.NotFound",
  "message": "The instance cannot be found.",
  "httpStatusCode": 200,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "instanceId"
}

Error codes

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