DescribeDiskReplicaGroups - - Alibaba Cloud ドキュメントセンター

指定されたリージョン内の 1 つ以上のレプリケーション整合性グループに関する情報をクエリします。

操作説明

説明

ページングクエリを実行するには、MaxResults パラメーターと NextToken パラメーターを使用します。

最初のページをクエリする場合、MaxResults を設定して返すエントリ数を指定します。応答内の NextToken 値は、後続のページをクエリするために使用されるトークンです。後続のページをクエリするには、NextToken を前の応答の値に設定し、MaxResults を設定して現在のページのエントリ数を指定します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ebs:DescribeDiskReplicaGroups

list

*DiskReplicaGroup

acs:ebs:{#regionId}:{#accountId}:diskreplicagroup/*

*DiskReplicaGroup

acs:ebs:{#regionId}:{#accountId}:diskreplicagroup/{#ReplicaGroupId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	レプリケーション整合性グループのリージョン ID。	cn-beijing
MaxResults	integer	任意	1 ページに返すエントリの最大数。このパラメーターは NextToken と共に使用できます。有効値：1～500。デフォルト値：10。	10
NextToken	string	任意	クエリトークン。このパラメーターを、この操作の前の呼び出しから返された NextToken 値に設定します。最初の呼び出しでは、このパラメーターを設定する必要はありません。NextToken を設定すると、PageSize パラメーターと PageNumber パラメーターは無視され、応答内の TotalCount は無効になります。	AAAAAdDWBF2****
GroupIds	string	任意	レプリケーション整合性グループの ID。1 つ以上のグループ ID を指定できます。複数の ID はコンマ (,) で区切ります。このパラメーターを指定しない場合、現在のリージョン内のすべてのレプリケーション整合性グループがクエリされます。最大 100 個のグループ ID を指定できます。	AAAAAdDWBF2****
Site	string	任意	クエリするサイト。このパラメーターは、レプリケーションペアが複数のゾーンにデプロイされている場合に使用されます。このパラメーターを指定しない場合、本番サイトのレプリケーションペアのレコードとステータス情報が返されます。このパラメーターを指定した場合、指定されたサイトのレプリケーションペアのレコードとステータス情報のみが返されます。有効値： production：本番サイト。 backup：ディザスタリカバリサイト。	production
PageNumber	integer	任意	ページ番号。	5
PageSize	integer	任意	1 ページあたりのエントリ数。有効値：1～100。	10
ResourceGroupId	string	任意	レプリケーション整合性グループが属するリソースグループの ID。	rg-aekz*****
Name	string	任意	レプリケーショングループの名前。あいまい検索がサポートされています。	pg-name***
Tag	array<object>	任意	タグ。リストには最大 20 個のタグを含めることができます。
	object	任意	タグに関する情報。
Value	string	任意	レプリケーション整合性グループのタグの値。	tag-value
Key	string	任意	レプリケーション整合性グループのタグのキー。	tag-key

レスポンスフィールド

フィールド	型	説明	例
	object	応答スキーマ。
RequestId	string	リクエスト ID。	AAA478A0-BEE6-1D42-BEB6-A9CFEAD6****
NextToken	string	この呼び出しで返されたクエリトークン。	AAAAAdDWBF2****
ReplicaGroups	array<object>	レプリケーション整合性グループに関する情報。
	array<object>
GroupName	string	レプリケーション整合性グループの名前。	myreplicagrouptest
Site	string	レプリケーションペアとレプリケーション整合性グループのサイト。有効値： production：本番サイト。 backup：ディザスタリカバリサイト。	production
Description	string	レプリケーション整合性グループの説明。	This is description.
StandbyZone	string	レプリケーショングループの初期ターゲットゾーン。	cn-shanghai-e
ResourceGroupId	string	レプリケーショングループが属するリソースグループの ID。	rg-aek2a*******
LastRecoverPoint	integer	レプリケーション整合性グループの最後の非同期レプリケーションが完了した時刻。このパラメーターは UNIX タイムスタンプです。単位：秒。	1637835114
ReplicaGroupId	string	レプリケーション整合性グループの ID。	pg-myreplica****
RPO	integer	レプリケーション整合性グループの目標復旧時点 (RPO)。単位：秒。	180
SourceRegionId	string	本番サイトのリージョン ID。	cn-beijing
DestinationRegionId	string	ディザスタリカバリサイトのリージョン ID。	cn-shanghai
Bandwidth	integer	帯域幅。単位：Kbit/s。このパラメーターはまだ利用できません。戻り値はシステムによってプリセットされています。	0
PrimaryZone	string	レプリケーショングループの初期ソースゾーン。	cn-beijing-h
SourceZoneId	string	本番サイトのゾーン ID。	cn-beijing-f
Tags	array<object>	レプリケーショングループのタグ。
	object
TagKey	string	レプリケーショングループのタグのキー。	testKey
TagValue	string	レプリケーショングループのタグの値。	testValue
Status	string	レプリケーション整合性グループのステータス。有効値： invalid：無効。グループ内のレプリケーションペアが異常であることを示します。 creating：作成中。 created：作成済み。 create_failed：作成失敗。 manual_syncing：一括同期中。グループは最初の一括同期中もこの状態になります。 syncing：同期中。データがプライマリディスクからセカンダリディスクに非同期でレプリケーションされている場合、グループはこの状態になります。 normal：正常。現在の非同期レプリケーションサイクルでデータレプリケーションが完了すると、グループはこの状態になります。 stopping：停止中。 stopped：停止済み。 stop_failed：停止失敗。 failovering：フェールオーバー実行中。 failovered：フェールオーバー完了。 failover_failed：フェールオーバー失敗。 reprotecting：逆方向レプリケーション実行中。 reprotect_failed：逆方向レプリケーション失敗。 deleting：削除中。 delete_failed：削除失敗。 deleted：削除済み。	created
PairNumber	integer	レプリケーション整合性グループ内のレプリケーションペアの数。	2
PrimaryRegion	string	レプリケーショングループの初期ソースリージョン。	cn-beijing
PairIds	array	レプリケーション整合性グループ内のレプリケーションペア ID のリスト。
	string	レプリケーション整合性グループ内のレプリケーションペアの ID。	pair-cn-dsa**,pair-cn-asd**
EnableRtc	boolean	レプリケーション時間制御 (RTC) を有効にするかどうかを指定します。有効値： false：RTC を無効にします。 true：RTC を有効にします。説明このパラメーターを true に設定すると、レプリケーション整合性グループと、グループに追加されたすべての非同期レプリケーションペアに対して RTC が有効になります。	true
DestinationZoneId	string	ディザスタリカバリサイトのゾーン ID。	cn-shanghai-e
StandbyRegion	string	レプリケーショングループの初期ターゲットリージョン。	cn-shanghai
PageNumber	integer	ページ番号。	1
PageSize	integer	1 ページあたりのエントリ数。	10
TotalCount	integer	返されたエントリの総数。	60

例

成功レスポンス

JSONJSON

{
  "RequestId": "AAA478A0-BEE6-1D42-BEB6-A9CFEAD6****",
  "NextToken": "AAAAAdDWBF2****",
  "ReplicaGroups": [
    {
      "GroupName": "myreplicagrouptest",
      "Site": "production",
      "Description": "This is description.",
      "StandbyZone": "cn-shanghai-e",
      "ResourceGroupId": "rg-aek2a*******",
      "LastRecoverPoint": 1637835114,
      "ReplicaGroupId": "pg-myreplica****",
      "RPO": 180,
      "SourceRegionId": "cn-beijing",
      "DestinationRegionId": "cn-shanghai",
      "Bandwidth": 0,
      "PrimaryZone": "cn-beijing-h",
      "SourceZoneId": "cn-beijing-f",
      "Tags": [
        {
          "TagKey": "testKey",
          "TagValue": "testValue"
        }
      ],
      "Status": "created",
      "PairNumber": 2,
      "PrimaryRegion": "cn-beijing",
      "PairIds": [
        "pair-cn-dsa****,pair-cn-asd****"
      ],
      "EnableRtc": true,
      "DestinationZoneId": "cn-shanghai-e",
      "StandbyRegion": "cn-shanghai\n"
    }
  ],
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 60
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
500	InternalError	The request processing has failed due to some unknown error, exception or failure.
403	OperationDenied	The operation is not allowed.
403	OperationDenied.InvalidStatus	The operation is not allowed in current status.
403	Forbidden	User is not authorized to operate.
403	Forbidden.Action	User is not authorized to operate this action.
404	NoSuchResource	The specified resource does not exist.
504	RequestTimeout	The request is timeout, please try again later.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。