ListDisasterRecoveryCheckpoints - 查询消费进度同步列表

查询消费进度同步列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
rocketmq:ListDisasterRecoveryCheckpointslist
*全部资源
*

请求语法

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

请求参数

名称类型必填描述示例值
planIdstring

备份计划 ID

1300000016
itemIdstring

备份映射 ID

100070284
instanceIdstring

源实例 ID

rmq-cn-7e22ody****
filterstring

过滤条件

topic_test
pageNumberinteger

当前页码,从 1 开始。

1
pageSizeinteger

分页大小,每页最多显示的返回结果数量。

10

返回参数

名称类型描述示例值
object

返回结果

requestIdstring

请求 ID

AF9A8B10-C426-530F-A0DD-96320B39****
successboolean

是否成功

true
dataobject

返回结果

pageNumberlong

当前页码

1
pageSizelong

分页大小

10
totalCountlong

总记录数

1
listarray<object>

分页数据

checkpointsobject

分页数据

planIdlong

备份计划 ID

13000000xx
itemIdlong

备份映射 ID

10000000xx
checkpointIdlong

消费进度 ID

10000000xx
lastSyncTimelong

最近同步时间

1740724080343
sourceProgressobject

源消费进度

regionIdstring

区域 ID

cn-hangzhou
instanceIdstring

实例 ID

rmq-cn-3mp3vblzxxx
instanceTypestring

实例类型

  • ALIYUN_ROCKETMQ :阿里云实例
  • EXTERNAL_ROCKETMQ :外部实例,开源实例,开源集群
ALIYUN_ROCKETMQ
consumerGroupIdstring

消费者组 ID

GID_TEST
topicNamestring

主题名称

TOPIC_TEST
lastFetchTimelong

最近获取时间

1740724080343
progressDataobject

消费进度数据

consumeTimestamplong

最新消费时间

1740724080343
targetProgressobject

目标消费进度

regionIdstring

区域 ID

cn-hangzhou
instanceIdstring

实例 ID

rmq-cn-nwy3i065xxx
instanceTypestring

实例类型

  • ALIYUN_ROCKETMQ :阿里云实例
  • EXTERNAL_ROCKETMQ :外部实例,开源实例,开源集群
ALIYUN_ROCKETMQ
consumerGroupIdstring

消费者组 ID

GID_TEST
topicNamestring

主题名称

TOPIC_TEST
lastFetchTimelong

最新获取时间

1740724080343
progressDataobject

消费进度数据

consumeTimestamplong

最新消费时间

1740724080343
codestring

错误码

200
messagestring

错误信息

The instance cannot be found.
httpStatusCodeinteger

HTTP 状态码

200
dynamicCodestring

动态错误码

InstanceId
dynamicMessagestring

动态错误信息

instanceId

示例

正常返回示例

JSON格式

{
  "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"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史