すべてのプロダクト
Search

このプロダクト

    :DescribeClusterBackups

    ドキュメントセンター

    :DescribeClusterBackups

    最終更新日:Oct 27, 2025

    クラウドディスクを使用する ApsaraDB for MongoDB シャードクラスターインスタンスのクラスターバックアップセットをクエリします。

    操作説明

    2023 年 10 月 19 日より前に作成されたクラウドディスクを使用するシャードクラスターインスタンスの場合、まず TransferClusterBackup 操作を呼び出して、シャードバックアップをクラスターバックアップに変換する必要があります。

    2023 年 10 月 19 日以降に作成されたクラウドディスクを使用するシャードクラスターインスタンスは、デフォルトでクラスターバックアップを使用します。

    今すぐお試しください

    この 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    dds:DescribeClusterBackups

    get

    *Instance

    acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbInstanceId}

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    DBInstanceId

    string

    必須

    インスタンスの ID です。

    dds-bp16cb162771****
    BackupId

    string

    任意

    クラスターバックアップの ID です。

    5664****
    PageNo

    integer

    任意

    返すページ番号。値は正の整数である必要があります。デフォルト値: 1。

    1
    PageSize

    integer

    任意

    各ページで返すエントリ数。有効な値:

    • 30 (デフォルト)

    • 50

    • 100

    30
    StartTime

    string

    任意

    クエリする時間範囲の開始時刻。時間は yyyy-MM-ddTHH:mmZ 形式で指定します。時間は協定世界時 (UTC) である必要があります。

    説明

    BackupId パラメーターを指定した場合、このパラメーターは無効です。

    2019-03-13T12:11Z
    EndTime

    string

    任意

    クエリする時間範囲の終了時刻。終了時刻は開始時刻より後である必要があります。時間は yyyy-MM-ddTHH:mmZ 形式で指定します。時間は UTC である必要があります。

    説明

    BackupId パラメーターを指定した場合、このパラメーターは無効です。

    2019-03-14T13:10Z
    IsOnlyGetClusterBackUp

    boolean

    任意

    クラスターバックアップの子ノードに関する情報をクエリするかどうかを指定します。有効な値:

    • true: クラスターバックアップの基本情報のみを返し、すべての子ノードのバックアップ情報は返しません。

    • false (デフォルト): すべての子ノードのバックアップ情報を返します。

    true
    SrcRegion

    string

    任意

    インスタンスが存在するリージョン。

    説明

    • リリースされたインスタンスのバックアップセットをクエリする場合、このパラメーターは必須です。

    • geo 冗長バックアップをクエリする場合、このパラメーターは必須です。

    cn-hangzhou
    DestRegion

    string

    任意

    geo 冗長バックアップが存在するリージョン。

    説明

    geo 冗長バックアップをクエリする場合、このパラメーターは必須です。

    cn-shanghai
    ResourceGroupId

    string

    任意

    リソースグループの ID です。

    rg-xxxx
    BackupJobId

    string

    任意

    バックアップジョブの ID です。

    775051

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答スキーマ。

    RequestId

    string

    リクエスト ID です。

    2F42BB4E-461F-5B55-A37C-53B1141C****
    MaxResults

    integer

    このリクエストで返されるエントリの最大数。

    10
    PageNumber

    integer

    返されたページのページ番号。

    1
    PageSize

    integer

    ページごとに返されるエントリ数。

    30
    ClusterBackups

    array<object>

    クラスターバックアップセットの詳細。クラスターバックアップには、すべてのノードのバックアップセットが含まれます。

    array<object>

    クラスターバックアップセットの詳細。クラスターバックアップには、すべてのノードのバックアップセットが含まれます。

    IsAvail

    integer

    クラスターバックアップセットが有効かどうかを示します。有効な値:

    • 1: クラスターバックアップセットは有効です。

    • 0: 子ノードのバックアップセットが不完全であるか、失敗しています。

    1
    ClusterBackupId

    string

    クラスターバックアップの ID です。

    cb-o8c2ugnxo26kx***
    ClusterBackupStatus

    string

    クラスターバックアップのステータス。

    OK
    ClusterBackupStartTime

    string

    クラスターバックアップが開始された時刻。

    2023-10-16T19:33:20Z
    ClusterBackupSize

    string

    クラスターバックアップセットのサイズ (バイト単位)。

    107374182400
    ClusterBackupEndTime

    string

    クラスターバックアップが終了した時刻。

    2023-10-16T19:33:20Z
    ClusterBackupMode

    string

    クラスターバックアップのモード。

    Automated
    ExtraInfo

    object

    補足情報。値は JSON 形式の文字列です。

    RegistryFromHistory

    string

    バックアップセットが履歴バックアップから移行されたかどうかを示します。値 1 は、バックアップが移行されたことを示します。

    1
    Backups

    array<object>

    クラスターバックアップ内の各子ノードのバックアップセット。

    array<object>

    クラスターバックアップ内の各子ノードのバックアップセット。

    BackupId

    string

    バックアップの ID です。

    738025367
    InstanceName

    string

    MongoDB クラスター内のシャードの名前。

    d-bp16cb162771****

    BackupDownloadURL

    string

    バックアップファイルをダウンロードできるパブリック URL。バックアップファイルがダウンロードできない場合、空の文字列が返されます。

    http://oss.com/xxx
    BackupIntranetDownloadURL

    string

    バックアップファイルをダウンロードできる内部 URL。バックアップファイルがダウンロードできない場合、空の文字列が返されます。

    http://oss.com/xxx
    BackupStartTime

    string

    バックアップが開始された時刻。時間は yyyy-MM-ddTHH:mm:ssZ 形式で、UTC で表示されます。

    2023-10-16T19:33:20Z
    BackupEndTime

    string

    バックアップが終了した時刻。時間は yyyy-MM-ddTHH:mm:ssZ 形式で、UTC で表示されます。

    2023-10-16T19:33:20Z
    BackupSize

    string

    バックアップファイルのサイズ (バイト単位)。

    77544597650
    IsAvail

    string

    バックアップセットが利用可能かどうかを示します。有効な値:

    • 0: 利用不可。

    • 1: 利用可能。

    1
    BackupStatus

    string

    バックアップステータス。有効な値:

    • Success: バックアップは成功です。

    • Failed: バックアップは失敗しました。

    Success
    BackupName

    string

    バックアップの名前。

    12345678.tar.gz
    ExtraInfo

    object

    バックアップに関連付けられているインスタンスノードに関する情報。

    NodeId

    string

    ノードの ID です。

    d-2ze75ab1fa5d****
    StorageSize

    string

    ノードのストレージ容量 (MB)。

    20480
    InstanceClass

    string

    ノードの仕様。

    mdb.shard.4x.large.d
    NodeType

    string

    ノードのタイプ。

    db
    Progress

    string

    バックアップの進行状況 (パーセンテージ)。 このパラメーターは、進行中のバックアップに対してのみ返されます。

    50
    AttachLogStatus

    string

    アタッチされたログバックアップのステータス。有効な値:

    • Init: 初期化。

    • No_Need: アタッチされたログバックアップはありません。

    • Running: アタッチされたログバックアップは進行中です。

    • Ready: アタッチされたログバックアップは完了です。

    • Failed: アタッチされたログバックアップは失敗しました。

    説明

    ClusterBackupStatus パラメーターの値が OK の場合、完全バックアップが成功したことのみを示します。ログバックアップが有効になっているクラスターインスタンスの場合、ポイントインタイムリストアを実行したり、データ整合性を確保したりする前に、アタッチされたログバックアップが完了している必要があります。

    Ready
    EngineVersion

    string

    バックアップ作成時のインスタンスのデータベースエンジンバージョン。有効な値:

    • 7.0

    • 6.0

    • 5.0

    • 4.4

    • 4.2

    • 4.0

    • 3.4

    4.2
    BackupExpireTime

    string

    バックアップの有効期限が切れる時刻。時間は yyyy-MM-ddTHH:mm:ssZ 形式で、UTC で表示されます。

    重要 値「9999-01-01T00:00:00Z」は、バックアップが永続的に保持されることを示します。

    2025-03-29T03:47:12Z

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "2F42BB4E-461F-5B55-A37C-53B1141C****",
  "MaxResults": 10,
  "PageNumber": 1,
  "PageSize": 30,
  "ClusterBackups": [
    {
      "IsAvail": 1,
      "ClusterBackupId": "cb-o8c2ugnxo26kx***",
      "ClusterBackupStatus": "OK",
      "ClusterBackupStartTime": "2023-10-16T19:33:20Z",
      "ClusterBackupSize": "107374182400",
      "ClusterBackupEndTime": "2023-10-16T19:33:20Z",
      "ClusterBackupMode": "Automated",
      "ExtraInfo": {
        "RegistryFromHistory": "1"
      },
      "Backups": [
        {
          "BackupId": "738025367",
          "InstanceName": "d-bp16cb162771****\n",
          "BackupDownloadURL": "http://oss.com/xxx",
          "BackupIntranetDownloadURL": "http://oss.com/xxx",
          "BackupStartTime": "2023-10-16T19:33:20Z",
          "BackupEndTime": "2023-10-16T19:33:20Z",
          "BackupSize": "77544597650",
          "IsAvail": "1",
          "BackupStatus": "Success",
          "BackupName": "12345678.tar.gz",
          "ExtraInfo": {
            "NodeId": "d-2ze75ab1fa5d****",
            "StorageSize": "20480",
            "InstanceClass": "mdb.shard.4x.large.d",
            "NodeType": "db"
          }
        }
      ],
      "Progress": "50",
      "AttachLogStatus": "Ready",
      "EngineVersion": "4.2",
      "BackupExpireTime": "2025-03-29T03:47:12Z"
    }
  ]
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 InvalidStartTime.Malformed The Specified parameter StartTime is not valid.
    400 InvalidEndTime.Malformed The Specified parameter EndTime is not valid.
    400 InvalidStartTimeAndEndTime.Malformed The Specified parameter StartTime or EndTime is not valid.
    400 InvalidPageSize.Malformed The specified parameter PageSize is not valid.

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

    変更履歴

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