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

Queries the Global Replicator tasks of an instance.

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

Request syntax

GET /disaster_recovery/{planId}/items HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
planId	long	Yes	The ID of the Global Replicator task.	1234
topicName	string	No	The topic name.	topic-test920
filter	string	No	The filter condition. Topics are filtered by topic name.	topic_test
pageNumber	integer	No	The page number.	1
pageSize	integer	No	The number of entries per page.	10

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
requestId	string	The request ID.	C115601B-8736-5BBF-AC99-7FEAE12xxxx
success	boolean	Indicates whether the request was successful.	true
data	object	The returned data.
scrollId	string	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
pageNumber	long	The page number.	1
pageSize	long	The number of entries per page.	10
totalCount	long	The total number of entries returned.	49
list	array<object>	The Global Replicator tasks.
list	object	The Global Replicator task.
itemId	long	The ID of the Global Replicator task.	100070284
planId	long	The ID of the topic mapping.	1300000016
itemStatus	string	The status of the topic mapping. Valid values: CREATING CHANGING RUNNING MANUAL_STOPPED OVERDUE_STOPPED	RUNNING
topics	array<object>	The topics involved in the topic mapping.
topic	object	The topic involved in the topic mapping.
regionId	string	regionId	cn-hangzhou
instanceType	string	The instance type.	ALIYUN_ROCKETMQ
instanceId	string	The instance ID.	rmq-cn-kh43w0olz0c
topicName	string	The topic name.	topic-test
consumerGroupId`deprecated`	string	The ID of the consumer group.	group-test
deliveryOrderType	string	The method used to deliver messages to the destination instance. Valid values: Concurrently: concurrent delivery Orderly: ordered delivery	Concurrently
extInfo	object	The extended information.
	string	The extended information.	{}
createTime	string	The time when the query task was created.	2024-09-20 03:38:28
updateTime	string	The time when the query task was last modified.	2024-10-04 02:19:44
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": "C115601B-8736-5BBF-AC99-7FEAE12xxxx",
  "success": true,
  "data": {
    "scrollId": "B13D0B07-F24B-4790-88D8-D47A38063D00\n",
    "pageNumber": 1,
    "pageSize": 10,
    "totalCount": 49,
    "list": [
      {
        "itemId": 100070284,
        "planId": 1300000016,
        "itemStatus": "RUNNING",
        "topics": [
          {
            "regionId": "cn-hangzhou",
            "instanceType": "ALIYUN_ROCKETMQ",
            "instanceId": "rmq-cn-kh43w0olz0c",
            "topicName": "topic-test",
            "consumerGroupId": "group-test",
            "deliveryOrderType": "Concurrently"
          }
        ],
        "extInfo": {
          "key": {}
        },
        "createTime": "2024-09-20 03:38:28",
        "updateTime": "2024-10-04 02:19:44"
      }
    ]
  },
  "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