ListDisasterRecoveryCheckpoints - 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 consumer progress synchronization 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.

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:ListDisasterRecoveryCheckpoints	list	All Resources ``	none	none

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
planId	string	Yes	Backup Plan ID	1300000016
itemId	string	Yes	Backup Mapping ID	100070284
instanceId	string	Yes	Source Instance ID	rmq-cn-7e22ody****
filter	string	No	Filter Condition	topic_test
pageNumber	integer	No	Current page number, starting from 1.	1
pageSize	integer	No	Page size, the maximum number of results returned per page.	10

Response parameters

Parameter	Type	Description	Example
	object	Response Result
requestId	string	Request ID	AF9A8B10-C426-530F-A0DD-96320B39****
success	boolean	Whether the operation was successful	true
data	object	Response Data
pageNumber	long	Current page number	1
pageSize	long	Page size	10
totalCount	long	Total number of records	1
list	array<object>	Paged data
checkpoints	object	Paged data
planId	long	Backup Plan ID	13000000xx
itemId	long	Backup Mapping ID	10000000xx
checkpointId	long	Consumption Progress ID	10000000xx
lastSyncTime	long	Last synchronization time	1740724080343
sourceProgress	object	Source consumption progress
regionId	string	Region ID	cn-hangzhou
instanceId	string	Instance ID	rmq-cn-3mp3vblzxxx
instanceType	string	Instance type ALIYUN_ROCKETMQ: Alibaba Cloud instance EXTERNAL_ROCKETMQ: External instance, open-source instance, open-source cluster	ALIYUN_ROCKETMQ
consumerGroupId	string	Consumer Group ID	GID_TEST
topicName	string	The topic name.	TOPIC_TEST
lastFetchTime	long	Last fetch time	1740724080343
progressData	object	Consumption progress data
consumeTimestamp	long	Latest consumption time	1740724080343
targetProgress	object	Target consumption progress
regionId	string	Region ID	cn-hangzhou
instanceId	string	Instance ID	rmq-cn-nwy3i065xxx
instanceType	string	Instance type ALIYUN_ROCKETMQ: Alibaba Cloud instance EXTERNAL_ROCKETMQ: External instance, open-source instance, open-source cluster	ALIYUN_ROCKETMQ
consumerGroupId	string	Consumer group ID	GID_TEST
topicName	string	Topic name	TOPIC_TEST
lastFetchTime	long	Latest fetch time	1740724080343
progressData	object	Consumption progress data
consumeTimestamp	long	Latest consumption time	1740724080343
code	string	Error code	200
message	string	Error message	The instance cannot be found.
httpStatusCode	integer	HTTP status code	200
dynamicCode	string	Dynamic error code	InstanceId
dynamicMessage	string	The dynamic error message.	instanceId

Examples

Sample success responses

JSONformat

{
  "requestId": "AF9A8B10-C426-530F-A0DD-96320B39****",
  "success": true,
  "data": {
    "pageNumber": 1,
    "pageSize": 10,
    "totalCount": 1,
    "list": [
      {
        "planId": 0,
        "itemId": 0,
        "checkpointId": 0,
        "lastSyncTime": 1740724080343,
        "sourceProgress": {
          "regionId": "cn-hangzhou",
          "instanceId": "rmq-cn-3mp3vblzxxx",
          "instanceType": "ALIYUN_ROCKETMQ",
          "consumerGroupId": "GID_TEST",
          "topicName": "TOPIC_TEST",
          "lastFetchTime": 1740724080343,
          "progressData": {
            "consumeTimestamp": 1740724080343
          }
        },
        "targetProgress": {
          "regionId": "cn-hangzhou",
          "instanceId": "rmq-cn-nwy3i065xxx",
          "instanceType": "ALIYUN_ROCKETMQ",
          "consumerGroupId": "GID_TEST",
          "topicName": "TOPIC_TEST",
          "lastFetchTime": 1740724080343,
          "progressData": {
            "consumeTimestamp": 1740724080343
          }
        }
      }
    ]
  },
  "code": 200,
  "message": "The instance cannot be found.",
  "httpStatusCode": 200,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "instanceId"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history