查询备份计划列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
rocketmq:ListDisasterRecoveryPlans |
get |
*全部资源
|
无 | 无 |
请求语法
GET /disaster_recovery HTTP/1.1请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| instanceId |
string |
否 |
实例 ID。 |
rmq-cn-c97xxx |
| filter |
string |
否 |
过滤条件，根据备份名称，备份描述进行过滤 |
xxx |
| pageNumber |
integer |
否 |
分页页码，查询第几页的返回结果。 |
1 |
| pageSize |
integer |
否 |
分页大小，每页最多显示的返回结果数量。 |
10 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Result<MyPage |
||
| requestId |
string |
请求 ID |
855EF8E6-9C1D-5DE2-9E84-924E13Exxxx |
| success |
boolean |
是否成功 |
True |
| data |
object |
返回结果 |
|
| scrollId |
string |
请求滚动 ID。 系统自动生成，后续分页请求需要带上该返回结果，才能持续分页。 |
B13D0B07-F24B-4790-88D8-D47A38063D00 |
| pageNumber |
integer |
当前页码 |
1 |
| pageSize |
integer |
分页大小 |
10 |
| totalCount |
integer |
总记录数 |
28 |
| list |
array<object> |
分页数据 |
|
|
array<object> |
分页数据 |
||
| planId |
integer |
计划 ID |
1300000016 |
| planName |
string |
计划名称 |
xxx |
| planDesc |
string |
计划描述 |
xxx |
| planType |
string |
计划类型：
|
ACTIVE_PASSIVE |
| planStatus |
string |
计划状态：
|
RUNNING |
| extInfo |
object |
扩展信息 |
|
|
string |
扩展信息 |
xxx |
|
| instances |
array<object> |
备份计划参与实例 |
|
|
array<object> |
备份计划参与实例 |
||
| instanceType |
string |
实例类型 |
ALIYUN_ROCKETMQ |
| regionId |
string |
实例所在区域 |
cn-hangzhou |
| instanceId |
string |
实例 ID |
rmq-cn-ot93rbxxx |
| instanceRole |
string |
实例角色 |
ACTIVE |
| authType |
string |
认证方式 |
NO_AUTH |
| username |
string |
认证用户名 |
xxx |
| password |
string |
认证密码 |
xxx |
| endpointUrl |
string |
接入点地址 |
xxx |
| networkType |
string |
网络类型 |
TCP_INTERNET |
| vpcId |
string |
VPC ID |
vpc-bp13docqysrgxtbxxxx |
| vSwitchId |
string |
交换机 ID |
vsw-uf6gwtbn6etadpv****** |
| messageProperty |
object |
消息属性 |
|
| propertyKey |
string |
属性 key |
aaa |
| propertyValue |
string |
属性 value |
bbb |
| securityGroupId |
string |
安全组 id |
sg-bp17hpmgz9****** |
| consumerGroupId |
string |
消费者组 ID，用于从源实例拉取消息。 |
GID_xxx |
| syncCheckpointEnabled |
boolean |
同步消费进度开关 |
true |
| autoSyncCheckpoint |
boolean |
是否自动同步消费进度 |
true |
| createTime |
string |
创建时间 |
2022-08-01 20:05:50 |
| updateTime |
string |
修改时间 |
2022-08-01 20:05:50 |
| code |
string |
错误码 |
200 |
| message |
string |
错误信息 |
xxx |
| httpStatusCode |
integer |
HTTP 状态码 |
200 |
| dynamicCode |
string |
动态错误码 |
InstanceId |
| dynamicMessage |
string |
动态错误信息 |
InstanceId |
| accessDeniedDetail |
string |
访问拒绝详细信息，有且仅有在因 RAM 无权限拒绝用户访问的场景 |
xxx |
示例
正常返回示例
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"
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。