查询备份计划列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用前面加 * 表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
rocketmq:ListDisasterRecoveryPlans | get | *全部资源 * |
| 无 |
请求语法
GET /disaster_recovery HTTP/1.1
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
instanceId | string | 否 | 实例 ID。 | rmq-cn-c97xxx |
filter | string | 否 | 过滤条件,根据备份名称,备份描述进行过滤 | xxx |
pageNumber | integer | 否 | 分页页码,查询第几页的返回结果。 | 1 |
pageSize | integer | 否 | 分页大小,每页最多显示的返回结果数量。 | 10 |
返回参数
示例
正常返回示例
JSON
格式
{
"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_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"
}
错误码
访问错误中心查看更多错误码。