ListDisasterRecoveryItems - 查询备份映射列表

查询备份映射任务列表。

调试

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

授权信息

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

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

请求语法

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

请求参数

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

备份计划 id

1234
topicNamestring

主题名称。

topic-test284
filterstring

过滤条件,根据 topicName 过滤

topic_test
pageNumberinteger

分页页码,查询第几页的返回结果。

1
pageSizeinteger

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

10

返回参数

名称类型描述示例值
object

Result<MyPage>

requestIdstring

请求 ID

C115601B-8736-5BBF-AC99-7FEAE12xxxx
successboolean

是否成功

true
dataobject

返回结果

scrollIdstring

请求滚动 ID。 系统自动生成,后续分页请求需要带上该返回结果,才能持续分页。

B13D0B07-F24B-4790-88D8-D47A38063D00
pageNumberlong

当前页码

1
pageSizelong

分页大小

10
totalCountlong

总记录数

49
listarray<object>

分页数据

listobject

分页数据

itemIdlong

备份计划 id

100070284
planIdlong

映射 id

1300000016
itemStatusstring

备份映射状态:

  • CREATING(创建中)
  • CHANGING(变更中)
  • RUNNING(运行中)
  • MANUAL_STOPPED(人工停用)
  • OVERDUE_STOPPED(欠费停用)
RUNNING
topicsarray<object>

备份映射所包含的主题

topicobject

备份映射所包含的主题

regionIdstring

regionId

cn-hangzhou
instanceTypestring

实例类型

ALIYUN_ROCKETMQ
instanceIdstring

实例 ID

rmq-cn-kh43w0olz0c
topicNamestring

主题名称

topic-test
consumerGroupIddeprecatedstring

消费者组 ID

group-test
deliveryOrderTypestring

消息投递到目标实例的顺序性。

参数取值如下:

  • Concurrently:并发投递
  • Orderly:顺序投递
Concurrently
extInfoobject

扩展信息

string

扩展信息

{}
createTimestring

创建时间

2024-09-20 03:38:28
updateTimestring

修改时间

2024-10-04 02:19:44
codestring

错误码

200
messagestring

错误信息

xxx
httpStatusCodeinteger

HTTP 状态码

200
dynamicCodestring

动态错误码

InstanceId
dynamicMessagestring

动态错误信息

instanceId
accessDeniedDetailstring

访问拒绝详细信息,有且仅有在因 RAM 无权限拒绝用户访问的场景

xxx

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

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