GetDisasterRecoveryPlan - ApsaraMQ for RocketMQ - Alibaba Cloud Documentation Center

Queries the details of a Global Replicator task.

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

Request syntax

GET /disaster_recovery/{planId} HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
planId	long	Yes	The ID of the Global Replicator task.	1234

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
requestId	string	The request ID.	7358418D-83BD-507A-8079-611C63E0xxx
success	boolean	Indicates whether the request was successful.	true
data	object	The returned data.
planId	long	The ID of the Global Replicator task.	1300000016
planName	string	The name of the Global Replicator task.	xxx
planDesc	string	The description of the Global Replicator task.	xxxx
planType	string	The type of the Global Replicator task. Valid values: ACTIVE_PASSIVE: one-way backup ACTIVE_ACTIVE: two-way backup	ACTIVE_PASSIVE
planStatus	string	The status of the Global Replicator task. Valid values: CREATED RUNNING DELETED	RUNNING
extInfo	object	The extended information.
	string	The extended information.	xxxx
instances	array<object>	The instances involved in the Global Replicator task.
instance	object	The instance involved in the Global Replicator task.
instanceType	string	The instance type.	ALIYUN_ROCKETMQ
regionId	string	The ID of the region where the instance resides.	cn-shanghai
instanceId	string	The instance ID.	rmq-cn-gpz3qtcdxxx
instanceRole	string	The instance role.	ACTIVE
authType	string	The authentication type.	ACL_AUTH
username	string	The username used for authentication.	xxx
password	string	The password used for authentication.	xxx
endpointUrl	string	The endpoint.	xxx
networkType	string	The network type.	TCP_INTERNET
vpcId	string	The virtual private cloud (VPC) ID.	vpc-wz9qt50xhtj9krb******
vSwitchId	string	The vSwitch ID.	vsw-uf6gwtbn6etadpv******
messageProperty	object	The message attribute.
propertyKey	string	The attribute key.	xxx
propertyValue	string	The attribute value.	xxx
securityGroupId	string	The security group ID.	sg-bp17hpmgz9******
consumerGroupId	string	The consumer Group ID.	GID_DS_XXX_YYY
createTime	string	The time when the query task was created.	2022-08-01 20:05:50
updateTime	string	The time when the query task was last modified.	2022-08-01 20:05:50
autoSyncCheckpoint	boolean	Indicates whether automatic consumer progress synchronization is enabled. Note This parameter takes effect only when `syncCheckpointEnabled` is set to true. Valid values: true false	true
syncCheckpointEnabled	boolean	Indicates whether consumer progress synchronization is enabled. Valid values: true false	true
code	string	The error code.	200
message	string	The error message.	xxx
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": "7358418D-83BD-507A-8079-611C63E0xxx",
  "success": true,
  "data": {
    "planId": 1300000016,
    "planName": "xxx",
    "planDesc": "xxxx",
    "planType": "ACTIVE_PASSIVE",
    "planStatus": "RUNNING",
    "extInfo": {
      "key": "xxxx"
    },
    "instances": [
      {
        "instanceType": "ALIYUN_ROCKETMQ",
        "regionId": "cn-shanghai",
        "instanceId": "rmq-cn-gpz3qtcdxxx",
        "instanceRole": "ACTIVE",
        "authType": "ACL_AUTH",
        "username": "xxx",
        "password": "xxx",
        "endpointUrl": "xxx",
        "networkType": "TCP_INTERNET",
        "vpcId": "vpc-wz9qt50xhtj9krb******\n",
        "vSwitchId": "vsw-uf6gwtbn6etadpv******\n",
        "messageProperty": {
          "propertyKey": "xxx",
          "propertyValue": "xxx"
        },
        "securityGroupId": "sg-bp17hpmgz9******\n",
        "consumerGroupId": "GID_DS_XXX_YYY"
      }
    ],
    "createTime": "2022-08-01 20:05:50",
    "updateTime": "2022-08-01 20:05:50",
    "autoSyncCheckpoint": true,
    "syncCheckpointEnabled": true
  },
  "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

No change history