全部产品
Search

搜索本产品

    ApsaraDB for MongoDB：DescribeClusterBackups

    文档中心

    ApsaraDB for MongoDB：DescribeClusterBackups

    更新时间：Dec 18, 2025

    Menanyakan set cadangan kluster untuk instans kluster sharded ApsaraDB for MongoDB yang menggunakan cloud disk.

    Deskripsi operasi

    Untuk instans kluster sharded yang menggunakan cloud disk dan dibuat sebelum 19 Oktober 2023, Anda harus terlebih dahulu memanggil operasi [TransferClusterBackup](~~2587931~~) untuk mengonversi cadangan shard menjadi cadangan kluster. Instans kluster sharded yang menggunakan cloud disk dan dibuat setelah 19 Oktober 2023 secara default menggunakan cadangan kluster.

    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 dikembalikan. Nilainya harus berupa bilangan bulat positif. Nilai default: 1.

    1
    PageSize

    integer

    No

    Jumlah entri yang dikembalikan per halaman. Nilai yang valid:

    • 30 (Default)

    • 50

    • 100

    30
    StartTime

    string

    No

    Awal rentang waktu untuk kueri. Tentukan waktu dalam format yyyy-MM-ddTHH:mmZ. Waktu harus dalam Coordinated Universal Time (UTC).

    Catatan

    Parameter ini tidak berlaku jika Anda menentukan parameter BackupId.

    2019-03-13T12:11Z
    EndTime

    string

    No

    Akhir rentang waktu untuk kueri. Waktu akhir harus lebih lambat daripada waktu mulai. Tentukan waktu dalam format yyyy-MM-ddTHH:mmZ. Waktu harus dalam UTC.

    Catatan

    Parameter ini tidak berlaku jika Anda menentukan parameter BackupId.

    2019-03-14T13:10Z
    IsOnlyGetClusterBackUp

    boolean

    No

    Menentukan apakah akan menanyakan informasi tentang node anak dalam cadangan kluster. Nilai yang valid:

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

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

    true
    SrcRegion

    string

    No

    Wilayah tempat instans berada.

    Catatan

    • Parameter ini wajib ditentukan saat Anda menanyakan set cadangan instans yang telah dirilis.

    • Parameter ini wajib ditentukan saat Anda menanyakan cadangan geo-redundant.

    cn-hangzhou
    DestRegion

    string

    No

    Wilayah tempat cadangan geo-redundant berada.

    Catatan

    Parameter ini wajib ditentukan saat Anda menanyakan 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

    RequestId

    string

    ID permintaan.

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

    integer

    Jumlah maksimum entri yang dikembalikan dalam permintaan ini.

    10
    PageNumber

    integer

    Nomor halaman yang dikembalikan.

    1
    PageSize

    integer

    Jumlah entri yang dikembalikan per halaman.

    30
    ClusterBackups

    array<object>

    Detail set cadangan kluster. Cadangan kluster berisi set cadangan semua node.

    array<object>

    Detail set cadangan kluster. Cadangan kluster berisi set cadangan semua node.

    IsAvail

    integer

    Menunjukkan apakah set cadangan kluster valid. Nilai yang valid:

    • 1: Set cadangan kluster valid.

    • 0: Set cadangan node anak tidak lengkap atau gagal.

    1
    ClusterBackupId

    string

    ID cadangan kluster.

    cb-o8c2ugnxo26kx***
    ClusterBackupStatus

    string

    Status cadangan kluster.

    OK
    ClusterBackupStartTime

    string

    Waktu mulai cadangan kluster.

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

    string

    Ukuran set cadangan kluster, dalam byte.

    107374182400
    ClusterBackupEndTime

    string

    Waktu selesai cadangan kluster.

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

    string

    Mode cadangan kluster.

    Automated
    ExtraInfo

    object

    Informasi tambahan. Nilainya berupa string dalam format JSON.

    RegistryFromHistory

    string

    Menunjukkan apakah set cadangan dimigrasikan dari cadangan historis. Nilai 1 menunjukkan bahwa cadangan tersebut dimigrasikan.

    1
    Backups

    array<object>

    Set cadangan masing-masing node anak dalam cadangan kluster.

    array<object>

    Set cadangan masing-masing node anak dalam cadangan kluster.

    BackupId

    string

    ID cadangan.

    738025367
    InstanceName

    string

    Nama shard dalam kluster MongoDB.

    d-bp16cb162771****

    BackupDownloadURL

    string

    URL publik tempat Anda dapat mengunduh file cadangan. Jika file cadangan tidak tersedia untuk diunduh, string kosong dikembalikan.

    http://oss.com/xxx
    BackupIntranetDownloadURL

    string

    URL internal tempat Anda dapat mengunduh file cadangan. Jika file cadangan tidak tersedia untuk diunduh, string kosong dikembalikan.

    http://oss.com/xxx
    BackupStartTime

    string

    Waktu mulai cadangan. Waktu dalam format yyyy-MM-ddTHH:mm:ssZ dan ditampilkan dalam UTC.

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

    string

    Waktu selesai cadangan. Waktu dalam format yyyy-MM-ddTHH:mm:ssZ dan ditampilkan dalam UTC.

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

    string

    Ukuran file cadangan, dalam byte.

    77544597650
    IsAvail

    string

    Menunjukkan apakah set cadangan tersedia. Nilai yang valid:

    • 0: tidak tersedia.

    • 1: tersedia.

    1
    BackupStatus

    string

    Status cadangan. Nilai yang valid:

    • Success: Cadangan berhasil.

    • Failed: Cadangan gagal.

    Success
    BackupName

    string

    Nama cadangan.

    12345678.tar.gz
    ExtraInfo

    object

    Informasi tentang node instans yang terkait dengan cadangan.

    NodeId

    string

    ID node.

    d-2ze75ab1fa5d****
    StorageSize

    string

    storage space node, dalam MB.

    20480
    InstanceClass

    string

    Spesifikasi node.

    mdb.shard.4x.large.d
    NodeType

    string

    Jenis node.

    db
    Progress

    string

    Kemajuan cadangan dalam persentase. Parameter ini hanya dikembalikan untuk cadangan yang sedang berlangsung.

    50
    AttachLogStatus

    string

    Status cadangan log yang dilampirkan. Nilai yang valid:

    • Init: inisialisasi.

    • No_Need: Tidak tersedia cadangan log yang dilampirkan.

    • Running: Cadangan log yang dilampirkan sedang berlangsung.

    • Ready: Cadangan log yang dilampirkan telah selesai.

    • Failed: Cadangan log yang dilampirkan gagal.

    Catatan

    Jika nilai parameter ClusterBackupStatus adalah OK, ini hanya menunjukkan bahwa cadangan penuh berhasil. Untuk instans kluster yang mengaktifkan cadangan log, cadangan log yang dilampirkan harus selesai sebelum Anda dapat melakukan pemulihan berdasarkan titik waktu atau memastikan konsistensi data.

    Ready
    EngineVersion

    string

    Versi engine database instans saat cadangan dibuat. Nilai yang valid:

    • 7.0

    • 6.0

    • 5.0

    • 4.4

    • 4.2

    • 4.0

    • 3.4

    4.2
    BackupExpireTime

    string

    Waktu kedaluwarsa cadangan. Waktu dalam format yyyy-MM-ddTHH:mm:ssZ dan ditampilkan dalam UTC.

    Penting

    Nilai "9999-01-01T00:00:00Z" menunjukkan bahwa cadangan disimpan secara permanen.

    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.