DescribeDiskReplicaPairs - - 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:DescribeDiskReplicaPairs

get

*DiskReplicaPair

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

*DiskReplicaPair

acs:ebs:{#regionId}:{#accountId}:diskreplicapair/{#ReplicaPairId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	レプリケーションペアのプライマリディスクまたはセカンダリディスクが存在するリージョンの ID。DescribeRegions 操作を呼び出して、非同期レプリケーションをサポートするリージョンをクエリします。	cn-beijing
MaxResults	integer	任意	各ページで返すエントリの最大数。NextToken と一緒に使用します。有効値：1～500。デフォルト値：10。	1
NextToken	string	任意	クエリトークン。このパラメーターを、この操作の前の呼び出しから返された NextToken 値に設定します。最初の呼び出しでは、このパラメーターを設定する必要はありません。NextToken を設定すると、PageSize パラメーターと PageNumber パラメーターは無視され、応答の TotalCount 値は無効になります。	AAAAAdDWBF2****
PairIds	string	任意	レプリケーションペアの ID。1 つ以上のレプリケーションペア ID を指定します。ID は `pair-cn-dsa**,pair-cn-asd**` 形式である必要があります。このパラメーターを空のままにすると、現在のリージョン内のすべてのレプリケーションペアがクエリされます。最大 100 個のレプリケーションペア ID を指定できます。	pair-cn-dsa****
Site	string	任意	データをクエリするサイト。本番サイトまたはディザスタリカバリサイトからデータをクエリします。有効値： production：本番サイト。 backup：ディザスタリカバリサイト。デフォルト値：production。	production
ReplicaGroupId	string	任意	レプリケーション整合性グループの ID。レプリケーション整合性グループの ID を指定して、グループ内のレプリケーションペアをクエリします。ID は `pg-****` 形式である必要があります。このパラメーターを空のままにすると、現在のリージョン内のすべてのレプリケーションペアがクエリされます。説明このパラメーターを `-` に設定すると、どのレプリケーション整合性グループにも属していないレプリケーションペアが返されます。	pg-****
PageNumber	integer	任意	ページ番号。	5
PageSize	integer	任意	ページあたりのエントリ数。有効値：1～100。	10
ResourceGroupId	string	任意	レプリケーションペアが属するリソースグループの ID。	rg-acfmvs******
Name	string	任意	レプリケーションペアの名前。あいまい一致がサポートされています。	name***
Tag	array<object>	任意	タグ。最大 20 個のタグを指定できます。
	object	任意	タグ。
Value	string	任意	タグの値。	TestValue
Key	string	任意	タグのキー。	TestKey

レスポンスフィールド

フィールド	型	説明	例
	object	応答スキーマ。
RequestId	string	リクエスト ID。	AAA478A0-BEE6-1D42-BEB6-A9CFEAD6****
NextToken	string	この呼び出しから返されたクエリトークン。	AAAAAdDWBF2****
ReplicaPairs	array<object>	レプリケーションペア。
	array<object>
Site	string	レプリケーションペアまたはレプリケーション整合性グループのサイトタイプ。有効値： production：本番サイト。 backup：ディザスタリカバリサイト。	production
DestinationDiskId	string	セカンダリディスクの ID。	d-asdfjl2342kj2l3k4****
Description	string	レプリケーションペアの説明。	This is description.
StandbyZone	string	レプリケーションペアの初期ターゲットゾーン。	cn-shanghai-b
ResourceGroupId	string	レプリケーションペアが属するリソースグループの ID。	rg-acfmvs*****
DestinationRegion	string	セカンダリディスクのリージョン。	cn-shanghai
ReplicaPairId	string	レプリケーションペアの ID。	pair-cn-dsa****
LastRecoverPoint	integer	最後の非同期レプリケーションが完了した時刻。この値は UNIX タイムスタンプです。単位：秒。	1649751977
ReplicaGroupId	string	レプリケーションペアが属するレプリケーション整合性グループの ID。	pg-xxxx****
SourceDiskId	string	プライマリディスクの ID。	d-bp131n0q38u3a4zi****
RPO	integer	レプリケーションペアの目標復旧時点 (RPO)。単位：秒。	900
PairName	string	レプリケーションペアの名前。	TestReplicaPair
Bandwidth	integer	非同期レプリケーションに使用される帯域幅。単位：Kbit/s。	10240
ExpiredTime	integer	レプリケーションペアの有効期限。この値は UNIX タイムスタンプです。単位：秒。	1649750977
PrimaryZone	string	レプリケーションペアの初期ソースゾーン。	cn-beijing-a
SourceZoneId	string	プライマリディスクのゾーン。	cn-beijing-a
Tags	array<object>	レプリケーションペアのタグ。
	object	タグ。
TagKey	string	タグのキー。	testKey
TagValue	string	タグの値。	testValue
Status	string	レプリケーションペアのステータス。有効値： invalid：レプリケーションペアが無効です。このステータスは、レプリケーションペアが正常に機能していないことを示します。 creating：レプリケーションペアは作成中です。 created：レプリケーションペアは作成済みです。 create_failed：レプリケーションペアの作成に失敗しました。 initial_syncing：レプリケーションペアは同期の初期化状態です。レプリケーションペアが作成されて開始された後、プライマリディスクからセカンダリディスクへのデータの最初の非同期レプリケーション中にこの状態になります。 manual_syncing：レプリケーションペアは手動で同期中です。手動同期が完了すると、レプリケーションペアは停止状態に戻ります。最初の 1 回限りの同期の場合、ステータスも manual_syncing になります。 syncing：レプリケーションペアはデータを同期中です。プライマリディスクからセカンダリディスクへ 2 回目以降の非同期データレプリケーションが行われる際、レプリケーションペアはこの状態になります。 normal：レプリケーションペアは正常な状態です。現在のレプリケーションサイクルでデータレプリケーションが完了すると、レプリケーションペアはこの状態になります。 stopping：レプリケーションペアは停止中です。 stopped：レプリケーションペアは停止済みです。 stop_failed：レプリケーションペアの停止に失敗しました。 failovering：フェールオーバーが進行中です。 failovered：フェールオーバーは完了しました。 failover_failed：フェールオーバーに失敗しました。 reprotecting：逆レプリケーションが進行中です。 reprotect_failed：逆レプリケーションに失敗しました。 deleting：レプリケーションペアは削除中です。 delete_failed：レプリケーションペアの削除に失敗しました。 deleted：レプリケーションペアは削除済みです。	created
PrimaryRegion	string	レプリケーションペアの初期ソースリージョン。	cn-beijing
CreateTime	integer	作成時刻。この値は UNIX タイムスタンプです。単位：秒。	1649750977
SourceRegion	string	プライマリディスクのリージョン。	cn-beijing
StatusMessage	string	レプリケーションペアのステータスメッセージ。このパラメーターは、ステータスが `invalid` または `create_failed` の場合に返されます。有効値： PrePayOrderExpired：サブスクリプションのレプリケーションペアの有効期限が切れています。 PostPayOrderCeaseService：従量課金のレプリケーションペアのサービスが、通常は支払い遅延のために一時停止されています。 DeviceRemoved：プライマリディスクまたはセカンダリディスクが削除されました。 DeviceKeyChanged：プライマリディスクまたはセカンダリディスクの `DeviceKey` マッピングが変更されました。 DeviceSizeChanged：プライマリディスクまたはセカンダリディスクの `DeviceSize` が変更されました。 OperationDenied.QuotaExceed：作成されたレプリケーションペアの数がクォータを超えています。	PrePayOrderExpired
EnableRtc	boolean	リアルタイムコントロール (RTC) が有効になっているかどうかを指定します。有効値： false：無効。 true：有効。説明レプリケーションペアがレプリケーション整合性グループ内にある場合、このパラメーターの値はグループの値と同じです。
ChargeType	string	レプリケーションペアの課金方法。有効値： PREPAY：サブスクリプション。 POSTPAY：従量課金。	PREPAY
DestinationZoneId	string	セカンダリディスクのゾーン。	cn-shanghai-b
ReplicaGroupName	string	レプリケーションペアが属するレプリケーション整合性グループの名前。	pg-name****
StandbyRegion	string	レプリケーションペアの初期ターゲットリージョン。	cn-shanghai
PageNumber	integer	ページ番号。	1
PageSize	integer	ページあたりのエントリ数。	10
TotalCount	integer	エントリの総数。	60

例

成功レスポンス

JSONJSON

{
  "RequestId": "AAA478A0-BEE6-1D42-BEB6-A9CFEAD6****",
  "NextToken": "AAAAAdDWBF2****",
  "ReplicaPairs": [
    {
      "Site": "production",
      "DestinationDiskId": "d-asdfjl2342kj2l3k4****",
      "Description": "This is description.",
      "StandbyZone": "cn-shanghai-b",
      "ResourceGroupId": "rg-acfmvs*****",
      "DestinationRegion": "cn-shanghai",
      "ReplicaPairId": "pair-cn-dsa****",
      "LastRecoverPoint": 1649751977,
      "ReplicaGroupId": "pg-xxxx****",
      "SourceDiskId": "d-bp131n0q38u3a4zi****",
      "RPO": 900,
      "PairName": "TestReplicaPair",
      "Bandwidth": 10240,
      "ExpiredTime": 1649750977,
      "PrimaryZone": "cn-beijing-a",
      "SourceZoneId": "cn-beijing-a",
      "Tags": [
        {
          "TagKey": "testKey",
          "TagValue": "testValue"
        }
      ],
      "Status": "created",
      "PrimaryRegion": "cn-beijing",
      "CreateTime": 1649750977,
      "SourceRegion": "cn-beijing",
      "StatusMessage": "PrePayOrderExpired",
      "EnableRtc": false,
      "ChargeType": "PREPAY",
      "DestinationZoneId": "cn-shanghai-b",
      "ReplicaGroupName": "pg-name****",
      "StandbyRegion": "cn-shanghai"
    }
  ],
  "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.

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

変更履歴

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