すべてのプロダクト
Search

このプロダクト

    ApsaraDB for MongoDB:DescribeBackups

    ドキュメントセンター

    ApsaraDB for MongoDB:DescribeBackups

    最終更新日:Sep 23, 2026

    ApsaraDB for MongoDB インスタンスのバックアップリストを照会します。

    今すぐお試しください

    この 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:DescribeBackups

    get

    *インスタンス。

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

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    DBInstanceId

    string

    必須

    インスタンスの ID。

    説明

    このパラメーターをシャードクラスターインスタンスの ID に設定する場合は、NodeId パラメーターも指定する必要があります。

    dds-bp1a7009eb24****
    NodeId

    string

    任意

    シャードクラスターインスタンス内のシャードノードのインスタンス ID。

    説明

    DBInstanceId パラメーターをシャードクラスターインスタンスの ID に設定する場合、このパラメーターは必須です。

    d-bp128a003436****
    BackupId

    string

    任意

    インスタンスの ID。

    DBInstanceId パラメーターをシャードクラスターインスタンスの ID に設定する場合、インスタンス ID の数はシャードノードの数と同じになります。複数のインスタンス ID はコンマ (,) で区切ります。

    2072****,2072****,2072****
    PageNumber

    integer

    任意

    ページ番号。値は、Integer データの型の最大値を超えない正の整数である必要があります。デフォルト値: 1。

    1
    PageSize

    integer

    任意

    ページサイズ。有効な値:

    • 30 (デフォルト)

    • 50

    • 100

    列挙値:

    • 30 :

      1 ページあたり 30 エントリ。

    • 50 :

      1 ページあたり 50 エントリ。

    • 100 :

      1 ページあたり 100 エントリ。

    30
    StartTime

    string

    任意

    クエリを実行する時間範囲の開始時刻。時間を yyyy-MM-ddTHH:mmZ フォーマット (協定世界時 (UTC)) で指定します。

    説明

    BackupId が指定されている場合、このパラメーターは無効です。

    2022-01-13T13:00Z
    EndTime

    string

    任意

    クエリを実行する時間範囲の終了時刻。終了時刻は開始時刻より後である必要があります。時間を yyyy-MM-ddTHH:mmZ フォーマット (協定世界時 (UTC)) で指定します。

    説明

    BackupId が指定されている場合、このパラメーターは無効です。

    2022-01-14T13:00Z
    SrcRegion

    string

    任意

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

    説明

    • 削除されたインスタンスを解凍するには、このパラメーターが必須です。

    • 地理的冗長バックアップの場合、このパラメーターは必須です。

    cn-beijing
    DestRegion

    string

    任意

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

    説明

    地理的冗長バックアップの場合、このパラメーターは必須です。

    cn-hangzhou
    ResourceGroupId

    string

    任意

    リソースグループの ID。

    rg-xxxx
    BackupJobId

    string

    任意

    バックアップタスクの ID。

    775051

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    インスタンスのバックアップ情報のフォーマット。

    TotalCount

    integer

    バックアップの総数。

    1
    RequestId

    string

    リクエストの ID。

    275D43C3-F12F-5224-B375-************
    PageSize

    integer

    ページサイズ。有効な値:

    • 30 (デフォルト)

    • 50

    • 100

    30
    PageNumber

    integer

    ページ番号。

    1
    Backups

    object

    Backup

    array<object>

    バックアップファイルの詳細リスト。

    object

    バックアップファイルの詳細リスト。

    BackupStatus

    string

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

    • Success: 成功。

    • Failed: 失敗。

    Success
    BackupType

    string

    バックアップタイプ。有効な値:

    • FullBackup: 完全バックアップ。

    • IncrementalBackup: 増分バックアップ。

    FullBackup
    BackupStartTime

    string

    バックアップの開始時刻。時間は yyyy-MM-ddTHH:mm:ssZ フォーマット (協定世界時 (UTC)) です。

    2022-01-14T03:56:17Z
    BackupIntranetDownloadURL

    string

    バックアップファイルの内部ダウンロード URL。

    説明

    この URL を使用して、ApsaraDB for MongoDB インスタンスと同じネットワーク内にある ECS インスタンスからバックアップファイルをダウンロードできます。

    http://rdsbak-hz-v3.oss-cn-hangzhou-internal.aliyuncs.com/custins5559*****/hins1936****_data_2022052504****_qp.xb?Expires=165361****&OSSAccessKeyId=***********************&Signature=******************************&Region=cn-hangzhou
    BackupSize

    integer

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

    6168576
    BackupDownloadURL

    string

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

    http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/custins5559****/hins1936****_data_2022052504****_qp.xb?Expires=165361****&OSSAccessKeyId=************************&Signature=******************************&Region=cn-hangzhou
    BackupMode

    string

    バックアップモード。有効な値:

    • Automated: 自動バックアップ。

    • Manual: 手動バックアップ。

    Automated
    BackupEndTime

    string

    バックアップの終了時刻。時間は yyyy-MM-ddTHH:mm:ssZ フォーマット (協定世界時 (UTC)) です。

    2022-01-14T03:57:34Z
    BackupId

    string

    バックアップの ID。

    32102****
    BackupDBNames

    string

    バックアップされたデータベースの名前。

    データベース
    BackupMethod

    string

    バックアップメソッド。有効な値:

    • Snapshot: スナップショットバックアップ。

    • Physical: 物理バックアップ。

    • Logical: 論理バックアップ。

    Physical
    BackupJobId

    string

    バックアップタスクの ID。

    1123xxxx
    BackupName

    string

    バックアップセット名。このパラメーターは現在無効です。

    12345678.tar.gz
    BackupScale

    string

    バックアップ粒度。このパラメーターは現在無効です。

    DBInstance
    IsAvail

    boolean

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

    • 0: 利用不可。

    • 1: 利用可能。

    1
    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" は long-term 保持 (LTR) を示します。

    2025-08-30T09:49:11Z

    例

    成功レスポンス

    JSONJSON

    {
  "TotalCount": 1,
  "RequestId": "275D43C3-F12F-5224-B375-************",
  "PageSize": 30,
  "PageNumber": 1,
  "Backups": {
    "Backup": [
      {
        "BackupStatus": "Success",
        "BackupType": "FullBackup",
        "BackupStartTime": "2022-01-14T03:56:17Z",
        "BackupIntranetDownloadURL": "http://rdsbak-hz-v3.oss-cn-hangzhou-internal.aliyuncs.com/custins5559*****/hins1936****_data_2022052504****_qp.xb?Expires=165361****&OSSAccessKeyId=***********************&Signature=******************************&Region=cn-hangzhou",
        "BackupSize": 6168576,
        "BackupDownloadURL": "http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/custins5559****/hins1936****_data_2022052504****_qp.xb?Expires=165361****&OSSAccessKeyId=************************&Signature=******************************&Region=cn-hangzhou",
        "BackupMode": "Automated",
        "BackupEndTime": "2022-01-14T03:57:34Z",
        "BackupId": "32102****",
        "BackupDBNames": "database",
        "BackupMethod": "Physical",
        "BackupJobId": "1123xxxx",
        "BackupName": "12345678.tar.gz",
        "BackupScale": "DBInstance",
        "IsAvail": true,
        "EngineVersion": "4.2",
        "BackupExpireTime": "2025-08-30T09:49:11Z"
      }
    ]
  }
}

    エラーコード

    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.

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

    変更履歴

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