UpdateDisasterRecoveryPlan - ApsaraMQ for RocketMQ - Alibaba Cloud Documentation Center

Modifies 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:UpdateDisasterRecoveryPlan	update	*Instance `acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}`	none	none

Request syntax

PATCH /disaster_recovery/{planId} HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
planId	long	Yes	The ID of the global message backup plan.	1300000016
body	object	No	The request body.
planName	string	No	The name of the Global Replicator task.	xxx
planDesc	string	No	The description of the Global Replicator task.	xxx
planType	string	No	The type of the Global Replicator task. After you create a Global Replicator task, you cannot change the type of the task. Valid values: ACTIVE_PASSIVE: one-way backup ACTIVE_ACTIVE: two-way backup	ACTIVE_PASSIVE
instances	array<object>	No	The instances involved in the Global Replicator task. After you create a Global Replicator task, you cannot change the instances involved in the task. You can change only the message attribute and authentication type of the task.
instance	object	No	The instance involved in the Global Replicator task.
instanceType	string	No	The instance type. Valid values: ALIYUN_ROCKETMQ: ApsaraMQ for RocketMQ instance EXTERNAL_ROCKETMQ: open source RocketMQ cluster	ALIYUN_ROCKETMQ
regionId	string	No	The ID of the region where the instance resides.	cn-hangzhou
instanceId	string	No	The instance ID.	rmq-cn-83l3r0xxxx
instanceRole	string	No	The instance role. Valid values: ACTIVE: primary instance Passive: secondary instance	ACTIVE
authType	string	No	The authentication type. Valid values: NO_AUTH: no authentication ACL_AUTH: access control list (ACL)-based authentication	NO_AUTH
username	string	No	The username used for authentication. This parameter is required only if you set authType to ACL_AUTH.	xxx
password	string	No	The password used for authentication. This parameter is required only if you set authType to ACL_AUTH.	xxx
endpointUrl	string	No	The instance endpoint. This parameter is required only if you set instanceType to EXTERNAL_ROCKETMQ.	xxx
networkType	string	No	The network type. This parameter is required only if you set instanceType to EXTERNAL_ROCKETMQ. Valid values: TCP_INTERNET: Internet over TCP TCP_VPC: virtual private cloud (VPC) over TCP.	TCP_INTERNET
vpcId	string	No	The ID of the VPC with which the instance is associated. This parameter is required only if you set instanceType to EXTERNAL_ROCKETMQ and networkType to TCP_VPC.	vpc-wz9qt50xhtj9krb******
vSwitchId	string	No	The ID of the vSwitch with which the instance is associated. This parameter is required only if you set instanceType to EXTERNAL_ROCKETMQ and networkType to TCP_VPC.	vsw-uf6gwtbn6etadpv******
messageProperty	object	No	The message attribute. When you synchronize a message to the destination cluster, the system automatically adds the attribute to the message for SQL-based filtering.
propertyKey	string	No	The attribute key.	aaa
propertyValue	string	No	The attribute value.	bbb
securityGroupId	string	No	The ID of the security group to which the instance belongs. This parameter is required only if you set instanceType to EXTERNAL_ROCKETMQ and networkType to TCP_VPC.	sg-bp17hpmgz9******
consumerGroupId	string	No	The consumer group ID.	GID_DS_XXX_YYY
autoSyncCheckpoint	boolean	No	Specifies whether to enable automatic consumer progress synchronization. Note This parameter takes effect only when you set `syncCheckpointEnabled` to true. Valid values: true false	true
syncCheckpointEnabled	boolean	No	Specifies whether to enable consumer progress synchronization. Valid values: true false	true

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
requestId	string	The request ID.	A07B41BD-6DD3-5349-9E76-00303Dxxxx
success	boolean	Indicates whether the request was successful.	true
data	boolean	The data returned.	true
code	string	The error code.	DisasterRecoveryPlanStatus.Error
message	string	The error message.	The current status of the disaster recovery plan does not support this operation.
httpStatusCode	integer	The response code.	200
dynamicCode	string	The dynamic error code.	InstanceId
dynamicMessage	string	The dynamic error message.	instanceId
accessDeniedDetail	string	The details about the access denial. This parameter is returned only if the access is denied because the Resource Access Management (RAM) user does not have the required permissions.	xxx

Examples

Sample success responses

JSONformat

{
  "requestId": "A07B41BD-6DD3-5349-9E76-00303Dxxxx",
  "success": true,
  "data": true,
  "code": "DisasterRecoveryPlanStatus.Error",
  "message": "The current status of the disaster recovery plan does not support this operation.",
  "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

No change history