バックアッププランのリストを照会します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
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 |
vSwitch ID。 |
vsw-uf6gwtbn6etadpv****** |
| messageProperty |
object |
メッセージプロパティ。 |
|
| propertyKey |
string |
プロパティキー。 |
aaa |
| propertyValue |
string |
プロパティ値。 |
bbb |
| securityGroupId |
string |
セキュリティグループ ID。 |
sg-bp17hpmgz9****** |
| consumerGroupId |
string |
コンシューマーグループ ID。ソースインスタンスからメッセージをプルするために使用されます。 |
GID_xxx |
| syncCheckpointEnabled |
boolean |
コンシューマーオフセット同期が有効かどうかを示します。 |
true |
| autoSyncCheckpoint |
boolean |
コンシューマーオフセットの自動同期が有効かどうかを示します。 |
true |
| createTime |
string |
作成時間。YYYY-MM-DD HH:mm:ss フォーマット。 |
2022-08-01 20:05:50 |
| updateTime |
string |
更新時間。YYYY-MM-DD HH:mm:ss フォーマット。 |
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 |
例
成功レスポンス
JSONJSON
{
"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"
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。