バックアッププランの詳細を照会します。
操作説明
クエリする前に、Global Replicator バックアッププランが作成されていることを確認してください。Global Replicator を使用する前に、アカウントに AliyunServiceRoleForRMQDisasterRecovery サービスリンクロールが必要です。このロールは、ApsaraMQ for RocketMQ が EventBridge イベントバスにアクセスするための権限付与を行うために使用されます。通常、関連する特徴を初めて使用する時間に、システムによってこのロールが自動的に作成されます。自動作成に失敗した場合は、手動でロールを作成してください。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
rocketmq:GetDisasterRecoveryPlan |
get |
*インスタンス。
|
なし | なし |
リクエスト構文
GET /disaster_recovery/{planId} HTTP/1.1パスパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| planId |
integer |
必須 |
バックアッププランの ID。 |
1234 |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
リクエストパラメーターは必要ありません。
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
Result |
||
| requestId |
string |
リクエスト ID。 |
7358418D-83BD-507A-8079-611C63E0xxx |
| success |
boolean |
リクエストが成功したかどうかを示します。 |
true |
| data |
object |
応答データ。 |
|
| planId |
integer |
プランの ID。 |
1300000016 |
| planName |
string |
プラン名。 |
xxx |
| planDesc |
string |
プランの説明。 |
xxxx |
| planType |
string |
プランのタイプ。有効な値:
|
ACTIVE_PASSIVE |
| planStatus |
string |
プランのステータス。有効な値:
|
RUNNING |
| extInfo |
object |
拡張情報。 |
|
|
string |
拡張情報。 |
xxxx |
|
| instances |
array<object> |
バックアッププランに参加しているインスタンス。 |
|
|
array<object> |
バックアッププランに参加しているインスタンス。 |
||
| instanceType |
string |
インスタンスタイプ。 |
ALIYUN_ROCKETMQ |
| regionId |
string |
インスタンスが存在するリージョンの ID。 |
cn-shanghai |
| instanceId |
string |
インスタンスの ID。 |
rmq-cn-gpz3qtcdxxx |
| instanceRole |
string |
インスタンスロール。 |
ACTIVE |
| authType |
string |
認証方式。 |
ACL_AUTH |
| username |
string |
認証ユーザー名。 |
xxx |
| password |
string |
認証パスワード。 |
xxx |
| endpointUrl |
string |
エンドポイントアドレス。 |
xxx |
| networkType |
string |
ネットワークタイプ。 |
TCP_INTERNET |
| vpcId |
string |
VPC の ID。 |
vpc-wz9qt50xhtj9krb****** |
| vSwitchId |
string |
vSwitch の ID。 |
vsw-uf6gwtbn6etadpv****** |
| messageProperty |
object |
メッセージフィルタリングプロパティ。 |
|
| propertyKey |
string |
プロパティキー。 |
xxx |
| propertyValue |
string |
プロパティの値。 |
xxx |
| securityGroupId |
string |
セキュリティグループの ID。 |
sg-bp17hpmgz9****** |
| consumerGroupId |
string |
ソースインスタンスからメッセージをプルするために使用されるコンシューマーグループの ID。 |
GID_DS_XXX_YYY |
| 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 |
| autoSyncCheckpoint |
boolean |
コンシューマーの自動同期が有効かどうかを示します。 説明
このフィールドは、コンシューマーの自動同期が有効な場合、つまり 列挙値:
|
true |
| syncCheckpointEnabled |
boolean |
コンシューマーオフセットの同期が有効かどうかを示します。 列挙値:
|
true |
| code |
string |
エラーコード。 |
200 |
| message |
string |
エラーメッセージ。 |
xxx |
| httpStatusCode |
integer |
HTTP 状態コード。 |
200 |
| dynamicCode |
string |
動的エラーコード。 |
InstanceId |
| dynamicMessage |
string |
動的エラーメッセージ。 |
インスタンス ID |
| accessDeniedDetail |
string |
アクセス拒否の詳細。このフィールドは、RAM ユーザーに必須の権限がないためにリクエストが拒否された場合にのみ返されます。 |
xxx |
例
成功レスポンス
JSONJSON
{
"requestId": "7358418D-83BD-507A-8079-611C63E0xxx",
"success": true,
"data": {
"planId": 1300000016,
"planName": "xxx",
"planDesc": "xxxx",
"planType": "ACTIVE_PASSIVE",
"planStatus": "RUNNING",
"extInfo": {
"key": "xxxx"
},
"instances": [
{
"instanceType": "ALIYUN_ROCKETMQ",
"regionId": "cn-shanghai",
"instanceId": "rmq-cn-gpz3qtcdxxx",
"instanceRole": "ACTIVE",
"authType": "ACL_AUTH",
"username": "xxx",
"password": "xxx",
"endpointUrl": "xxx",
"networkType": "TCP_INTERNET",
"vpcId": "vpc-wz9qt50xhtj9krb******\n",
"vSwitchId": "vsw-uf6gwtbn6etadpv******\n",
"messageProperty": {
"propertyKey": "xxx",
"propertyValue": "xxx"
},
"securityGroupId": "sg-bp17hpmgz9******\n",
"consumerGroupId": "GID_DS_XXX_YYY"
}
],
"createTime": "2022-08-01 20:05:50",
"updateTime": "2022-08-01 20:05:50",
"autoSyncCheckpoint": true,
"syncCheckpointEnabled": true
},
"code": "200",
"message": "xxx",
"httpStatusCode": 200,
"dynamicCode": "InstanceId",
"dynamicMessage": "instanceId",
"accessDeniedDetail": "xxx"
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。