All Products
Search

This Product

    ApsaraDB for MongoDB:DescribeClusterBackups

    Document Center

    ApsaraDB for MongoDB:DescribeClusterBackups

    Last Updated:Jun 10, 2026

    Mengkueri set cadangan kluster untuk instans kluster sharded Database Apsara for MongoDB yang menggunakan cloud disk.

    Deskripsi operasi

    For sharded cluster instances that use cloud disks and were created before October 19, 2023, you must first call the TransferClusterBackup operation to convert shard backups to cluster backups.

    Sharded cluster instances that use cloud disks and were created after October 19, 2023 use cluster backups by default.

    Coba sekarang

    Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

    Test

    RAM authorization

    Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

    • Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.

    • API: API yang dapat Anda panggil untuk melakukan aksi tersebut.

    • Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.

    • Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.

      • Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.

      • Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.

    • Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.

    • Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    dds:DescribeClusterBackups

    get

    *Instance

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

    		 None None

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    DBInstanceId

    string

    Yes

    ID instans.

    dds-bp16cb162771****
    BackupId

    string

    No

    ID cadangan kluster.

    5664****
    PageNo

    integer

    No

    Nomor halaman yang akan dikembalikan. Nilainya harus berupa bilangan bulat positif. Nilai default: 1.

    1
    PageSize

    integer

    No

    Jumlah entri yang akan dikembalikan pada setiap halaman. Nilai valid:

    • 30 (Default)

    • 50

    • 100.

    30
    StartTime

    string

    No

    Awal rentang pengatur waktu yang akan dikueri. Tentukan pengatur waktu dalam format yyyy-MM-ddTHH:mmZ. Pengatur waktu harus dalam Coordinated Universal Time (UTC).

    Catatan

    Parameter ini tidak valid jika Anda menentukan parameter BackupId.

    2019-03-13T12:11Z
    EndTime

    string

    No

    Akhir rentang pengatur waktu yang akan dikueri. Pengatur waktu akhir harus lebih lambat dari pengatur waktu mulai. Tentukan pengatur waktu dalam format yyyy-MM-ddTHH:mmZ. Pengatur waktu harus dalam UTC.

    Catatan

    Parameter ini tidak valid jika Anda menentukan parameter BackupId.

    2019-03-14T13:10Z
    IsOnlyGetClusterBackUp

    boolean

    No

    Apakah akan mengkueri informasi tentang node anak dalam cadangan kluster. Nilai valid:

    • true: Hanya mengembalikan informasi dasar tentang cadangan kluster, bukan informasi cadangan tentang semua node anak.

    • false (Default format): Mengembalikan informasi cadangan tentang semua node anak.

    true
    SrcRegion

    string

    No

    Wilayah tempat instans berada.

    Catatan

    • Parameter ini diperlukan saat Anda mengkueri set cadangan instans yang telah dilepas.

    • Parameter ini diperlukan saat Anda mengkueri cadangan geo-redundant.

    cn-hangzhou
    DestRegion

    string

    No

    Wilayah tempat cadangan geo-redundant berada.

    Catatan

    Parameter ini diperlukan saat Anda mengkueri cadangan geo-redundant.

    cn-shanghai
    ResourceGroupId

    string

    No

    ID kelompok sumber daya.

    rg-xxxx
    BackupJobId

    string

    No

    ID Pekerjaan cadangan.

    775051

    Elemen respons

    Element

    Type

    Description

    Example

    object

    The response schema.

    RequestId

    string

    The request ID.

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

    integer

    The maximum number of entries returned in this request.

    10
    PageNumber

    integer

    The page number of the returned page.

    1
    PageSize

    integer

    The number of entries returned per page.

    30
    ClusterBackups

    array<object>

    The details of the cluster backup sets. A cluster backup contains the backup sets of all nodes.

    array<object>

    The details of the cluster backup sets. A cluster backup contains the backup sets of all nodes.

    IsAvail

    integer

    Indicates whether the cluster backup set is valid. Valid values:

    • 1: The cluster backup set is valid.

    • 0: The backup sets of child nodes are not complete or have failed.

    1
    ClusterBackupId

    string

    The ID of the cluster backup.

    cb-o8c2ugnxo26kx***
    ClusterBackupStatus

    string

    The status of the cluster backup.

    OK
    ClusterBackupStartTime

    string

    The time when the cluster backup started.

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

    string

    The size of the cluster backup set, in bytes.

    107374182400
    ClusterBackupEndTime

    string

    The time when the cluster backup finished.

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

    string

    The mode of the cluster backup.

    Automated
    ExtraInfo

    object

    The supplementary information. The value is a JSON-formatted string.

    RegistryFromHistory

    string

    Indicates whether the backup set was migrated from a historical backup. A value of 1 indicates that the backup was migrated.

    1
    Backups

    array<object>

    The backup sets of each child node in the cluster backup.

    array<object>

    The backup sets of each child node in the cluster backup.

    BackupId

    string

    The ID of the backup.

    738025367
    InstanceName

    string

    The name of the shard in the MongoDB cluster.

    d-bp16cb162771****

    BackupDownloadURL

    string

    The public URL from which you can download the backup file. If the backup file is unavailable for download, an empty string is returned.

    http://oss.com/xxx
    BackupIntranetDownloadURL

    string

    The internal URL from which you can download the backup file. If the backup file is unavailable for download, an empty string is returned.

    http://oss.com/xxx
    BackupStartTime

    string

    The time when the backup started. The time is in the yyyy-MM-ddTHH:mm:ssZ format and is displayed in UTC.

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

    string

    The time when the backup finished. The time is in the yyyy-MM-ddTHH:mm:ssZ format and is displayed in UTC.

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

    string

    The size of the backup file, in bytes.

    77544597650
    IsAvail

    string

    Indicates whether the backup set is available. Valid values:

    • 0: unavailable.

    • 1: available.

    1
    BackupStatus

    string

    The backup status. Valid values:

    • Success: The backup is successful.

    • Failed: The backup failed.

    Success
    BackupName

    string

    The name of the backup.

    12345678.tar.gz
    ExtraInfo

    object

    The information about the instance node that is associated with the backup.

    NodeId

    string

    The ID of the node.

    d-2ze75ab1fa5d****
    StorageSize

    string

    The storage space of the node, in MB.

    20480
    InstanceClass

    string

    The specifications of the node.

    mdb.shard.4x.large.d
    NodeType

    string

    The type of the node.

    db
    Progress

    string

    The backup progress in percentage. This parameter is returned only for backups that are in progress.

    50
    AttachLogStatus

    string

    The status of the attached log backup. Valid values:

    • Init: initialization.

    • No_Need: No attached log backup is available.

    • Running: The attached log backup is in progress.

    • Ready: The attached log backup is complete.

    • Failed: The attached log backup failed.

    Catatan

    If the value of the ClusterBackupStatus parameter is OK, it only indicates that the full backup was successful. For a cluster instance for which log backup is enabled, the attached log backup must be complete before you can perform a point-in-time restore or ensure data consistency.

    Ready
    EngineVersion

    string

    The database engine version of the instance when the backup was created. Valid values:

    • 7.0

    • 6.0

    • 5.0

    • 4.4

    • 4.2

    • 4.0

    • 3.4

    4.2
    BackupExpireTime

    string

    The time when the backup expires. The time is in the yyyy-MM-ddTHH:mm:ssZ format and is displayed in UTC.

    Penting

    A value of "9999-01-01T00:00:00Z" indicates that the backup is permanently retained.

    2025-03-29T03:47:12Z

    Contoh

    Respons sukses

    JSONformat

    {
  "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"
    }
  ]
}

    Kode kesalahan

    HTTP status code

    Error code

    Error message

    Description
    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.

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.