すべてのプロダクト
Search
ドキュメントセンター

:DescribeDiskReplicaGroups

最終更新日:Aug 08, 2025

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

操作説明

説明

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

最初のページのページングクエリを実行するときは、MaxResults を設定して、返されるアイテムの数を制限します。 応答の NextToken は、後続のページをクエリするためのトークンです。 後続のページをクエリするときは、NextToken パラメーターを前の応答から取得した NextToken 値に設定します。

今すぐお試しください

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

テスト

RAM 認証

この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

リクエストパラメーター

パラメーター

タイプ

必須 / 任意

説明

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 ~ 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>

レプリケーション整合性グループ情報のコレクション。

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

レプリケーション時間制御が有効かどうかを示します。

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.

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

変更履歴

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