ListDisasterRecoveryPlans - 查詢備份計劃列表
查詢備份計劃列表。
調試
您可以在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"
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。