All Products
Search
Document Center

ApsaraMQ for RocketMQ:ListDisasterRecoveryPlans

Last Updated:Jul 31, 2025
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.

Queries Global Replicator tasks.

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
rocketmq:ListDisasterRecoveryPlansget
*All Resources
*
    none
none

Request syntax

GET /disaster_recovery HTTP/1.1

Request parameters

ParameterTypeRequiredDescriptionExample
instanceIdstringNo

The instance ID.

rmq-cn-778xxx
filterstringNo

The filter condition. Global Replicator tasks are filtered by task name or description.

xxx
pageNumberintegerNo

The page number.

1
pageSizeintegerNo

The number of entries per page.

10

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

requestIdstring

The request ID.

855EF8E6-9C1D-5DE2-9E84-924E13Exxxx
successboolean

Indicates whether the information about the service was queried.

True
dataobject

The returned data.

scrollIdstring

The scroll ID of the request. The ID is automatically generated by the system. The result can be paginated only if this parameter is included in the pagination request.

B13D0B07-F24B-4790-88D8-D47A38063D00
pageNumberlong

The page number.

1
pageSizelong

The number of entries per page.

10
totalCountlong

The total number of entries returned.

28
listarray<object>

The Global Replicator tasks.

listobject

The Global Replicator task.

planIdlong

The ID of the Global Replicator task.

1300000016
planNamestring

The name of the Global Replicator task.

xxx
planDescstring

The description of the Global Replicator task.

xxx
planTypestring

The type of the Global Replicator task. Valid values:

  • ACTIVE_PASSIVE: one-way backup
  • ACTIVE_ACTIVE: two-way backup
ACTIVE_PASSIVE
planStatusstring

The status of the Global Replicator task. Valid values:

  • CREATED
  • RUNNING
  • DELETED
RUNNING
extInfoobject

The extended information.

string

The extended information.

xxx
instancesarray<object>

The instances involved in the Global Replicator task.

instanceobject

The instance involved the Global Replicator task.

instanceTypestring

The instance type.

ALIYUN_ROCKETMQ
regionIdstring

The ID of the region where the instance resides.

cn-hangzhou
instanceIdstring

The instance ID.

rmq-cn-ot93rbxxx
instanceRolestring

The instance role.

ACTIVE
authTypestring

The authentication type.

NO_AUTH
usernamestring

The username used for authentication.

xxx
passwordstring

The password used for authentication.

xxx
endpointUrlstring

The endpoint.

xxx
networkTypestring

The network type.

TCP_INTERNET
vpcIdstring

The virtual private cloud (VPC) ID.

vpc-bp13docqysrgxtbxxxx
vSwitchIdstring

The vSwitch ID.

vsw-uf6gwtbn6etadpv******
messagePropertyobject

The message attribute.

propertyKeystring

The attribute key.

aaa
propertyValuestring

The attribute value.

bbb
securityGroupIdstring

The security group ID.

sg-bp17hpmgz9******
consumerGroupIdstring

The ID of the consumer group.

GID_ui_xxx
syncCheckpointEnabledboolean

Indicates whether consumer progress synchronization is enabled.

true
autoSyncCheckpointboolean

Indicates whether automatic consumer progress synchronization is enabled.

true
createTimestring

The time when the query task was created.

2022-08-01 20:05:50
updateTimestring

The time when the query task was last modified.

2022-08-01 20:05:50
codestring

The error code.

200
messagestring

The error message.

xxx
httpStatusCodeinteger

The response code.

200
dynamicCodestring

The dynamic error code.

InstanceId
dynamicMessagestring

The returned dynamic error message.

InstanceId
accessDeniedDetailstring

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": "855EF8E6-9C1D-5DE2-9E84-924E13Exxxx",
  "success": true,
  "data": {
    "scrollId": "B13D0B07-F24B-4790-88D8-D47A38063D00\n",
    "pageNumber": 1,
    "pageSize": 10,
    "totalCount": 28,
    "list": [
      {
        "planId": 1300000016,
        "planName": "xxx",
        "planDesc": "xxx",
        "planType": "ACTIVE_PASSIVE",
        "planStatus": "RUNNING",
        "extInfo": {
          "key": "xxx"
        },
        "instances": [
          {
            "instanceType": "ALIYUN_ROCKETMQ",
            "regionId": "cn-hangzhou",
            "instanceId": "rmq-cn-ot93rbxxx",
            "instanceRole": "ACTIVE",
            "authType": "NO_AUTH",
            "username": "xxx",
            "password": "xxx",
            "endpointUrl": "xxx",
            "networkType": "TCP_INTERNET",
            "vpcId": "vpc-bp13docqysrgxtbxxxx",
            "vSwitchId": "vsw-uf6gwtbn6etadpv******\n",
            "messageProperty": {
              "propertyKey": "aaa",
              "propertyValue": "bbb"
            },
            "securityGroupId": "sg-bp17hpmgz9******\n",
            "consumerGroupId": "GID_ui_xxx"
          }
        ],
        "syncCheckpointEnabled": true,
        "autoSyncCheckpoint": true,
        "createTime": "2022-08-01 20:05:50",
        "updateTime": "2022-08-01 20:05:50"
      }
    ]
  },
  "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.