CreateDisasterRecoveryPlan - 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.

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

Request syntax

POST /disaster_recovery HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request body.
planName	string	No	The name of the Global Replicator task. You must specify this parameter.	xxx
planDesc	string	No	The description of the Global Replicator task.	xxx
planType	string	No	The type of the Global Replicator task. You must specify this parameter. For more information, see Global Replicator. Valid values: ACTIVE_PASSIVE: one-way backup ACTIVE_ACTIVE: two-way backup	ACTIVE_ACTIVE
instances	array<object>	No	The instances involved in the Global Replicator task. You must specify this parameter.
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: external RocketMQ instance Valid values: ALIYUN_ROCKETMQ: ApsaraMQ for RocketMQ instance EXTERNAL_ROCKETMQ: external RocketMQ instance	ALIYUN_ROCKETMQ
regionId	string	No	The region where the instance resides.	cn-hangzhou
instanceId	string	No	The instance ID. This parameter is required only if you set instanceType to ALIYUN_ROCKETMQ.	rmq-cn-******
instanceRole	string	No	The instance role. Valid values: ACTIVE: primary instance Passive: secondary instance Enumeration Value: PASSIVE: Secondary. ACTIVE: Primary.	PASSIVE
authType	string	No	The authentication method. If you set instanceType to ALIYUN_ROCKETMQ and the instance is an ApsaraMQ for RocketMQ 4.0 instance, you do not need to specify this parameter. NO_AUTH: no authentication ACL_AUTH: access control list (ACL)-based authentication Valid values: NO_AUTH: no authentication ACL_AUTH: access control list (ACL)-based authentication Enumeration Value: NO_AUTH: No authentication required. ACL_AUTH: ACL authentication.	ACL_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. If you set instanceType to ALIYUN_ROCKETMQ, you do not need to specify this parameter.	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. Enumeration Value: TCP_VPC: Virtual Private Cloud. TCP_INTERNET: TCP public network.	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 ID of the consumer group.	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 Enumeration Value: true: open. false: close.	true
syncCheckpointEnabled	boolean	No	Specifies whether to enable consumer progress synchronization. Valid values: true false Enumeration Value: true: open. false: close.	true

Response parameters

Parameter	Type	Description	Example
	object	Result
requestId	string	Request ID	C7E8AE3A-219B-52EE-BE32-4036F5xxxx
success	boolean	Indicates whether the operation was successful	true
data	long	The result, which is the backup plan ID	1234
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, provided only in scenarios where access is denied due to lack of RAM permissions	xxx

Examples

Sample success responses

JSONformat

{
  "requestId": "C7E8AE3A-219B-52EE-BE32-4036F5xxxx",
  "success": true,
  "data": 1234,
  "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.