Otomatisasi Kueri Backup MongoDB dengan API DescribeBackups - ApsaraDB for MongoDB

Mengambil informasi backup dari instans MongoDB.

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

get

*Instance

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

None

Parameter permintaan

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	ID instans. Catatan Jika instans tersebut merupakan instansi kluster sharded, Anda juga harus menentukan parameter NodeId.	dds-bp1a7009eb24****
NodeId	string	No	ID node shard dalam instansi kluster sharded. Catatan Parameter ini wajib ditentukan jika Anda menetapkan ID instansi kluster sharded untuk parameter DBInstanceId.	d-bp128a003436****
BackupId	string	No	ID backup. Jika Anda menentukan ID instansi kluster sharded untuk parameter DBInstanceId, jumlah ID backup harus sama dengan jumlah node shard. Pisahkan ID backup dengan koma (,).	2072**,2072,2072**
PageNumber	integer	No	Nomor halaman. Nilainya harus lebih besar dari 0 dan tidak melebihi nilai maksimum tipe data integer. Nilai default: 1.	1
PageSize	integer	No	Jumlah entri yang ditampilkan 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.	2022-01-13T13:00Z
EndTime	string	No	Akhir rentang waktu untuk kueri. Waktu akhir harus lebih lambat dari waktu mulai. Tentukan waktu dalam format yyyy-MM-ddTHH:mmZ. Waktu harus dalam UTC. Catatan Parameter ini tidak berlaku jika Anda menentukan parameter BackupId.	2022-01-14T13:00Z
SrcRegion	string	No	Wilayah tempat instans berada. Catatan Parameter ini wajib ditentukan untuk memulihkan instans yang telah dihapus. Parameter ini wajib ditentukan untuk geo-redundancy.	cn-beijing
DestRegion	string	No	Wilayah tempat backup berada. Catatan Parameter ini wajib ditentukan untuk geo-redundancy.	cn-hangzhou
ResourceGroupId	string	No	ID kelompok sumber daya.	rg-xxxx
BackupJobId	string	No	ID pekerjaan cadangan.	775051

Elemen respons

Element	Type	Description	Example
	object
TotalCount	integer	Total jumlah backup.	1
RequestId	string	ID permintaan.	275D43C3-F12F-5224-B375-************
PageSize	integer	Jumlah entri yang ditampilkan per halaman. Nilai yang valid: 30 (Default) 50 100	30
PageNumber	integer	Nomor halaman.	1
Backups	object
Backup	array<object>	Detail file backup.
	object	Detail file backup.
BackupStatus	string	Status backup. Nilai yang valid: Success: Backup berhasil. Failed: Backup gagal.	Success
BackupType	string	Tipe backup. Nilai yang valid: FullBackup: cadangan penuh. IncrementalBackup: cadangan inkremental.	FullBackup
BackupStartTime	string	Waktu mulai backup. Waktu dalam format yyyy-MM-ddTHH:mm:ssZ dan ditampilkan dalam UTC.	2022-01-14T03:56:17Z
BackupIntranetDownloadURL	string	URL unduh internal untuk file backup. Catatan Gunakan URL ini untuk mengunduh file backup dari Instance ECS. Instance ECS harus berada dalam jaringan yang sama dengan instans MongoDB.	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	Ukuran file backup. Satuan: byte.	6168576
BackupDownloadURL	string	URL unduh eksternal untuk file backup. Jika file tidak tersedia untuk diunduh, string kosong akan dikembalikan.	http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/custins5559**/hins1936_data_2022052504_qp.xb?Expires=165361&OSSAccessKeyId=********************&Signature=****************************&Region=cn-hangzhou
BackupMode	string	Mode backup. Nilai yang valid: Automated: backup otomatis. Manual: backup manual.	Automated
BackupEndTime	string	Waktu selesai backup. Waktu dalam format yyyy-MM-ddTHH:mm:ssZ dan ditampilkan dalam UTC.	2022-01-14T03:57:34Z
BackupId	string	ID backup.	32102****
BackupDBNames	string	Nama database yang dibackup.	database
BackupMethod	string	Metode backup. Nilai yang valid: Snapshot: Cadangan snapshot. Physical: backup fisik. Logical: cadangan logis.	Physical
BackupJobId	string	ID pekerjaan set cadangan.	1123xxxx
BackupName	string	Nama set cadangan. Parameter ini saat ini tidak berlaku.	12345678.tar.gz
BackupScale	string	Granularitas cadangan. Parameter ini saat ini tidak berlaku.	DBInstance
IsAvail	boolean	Menunjukkan apakah set cadangan tersedia. Nilai yang valid: false: tidak tersedia. true: tersedia.	1
EngineVersion	string	Versi mesin database instans saat backup dibuat. Nilai yang valid: 7.0 6.0 5.0 4.4 4.2 4.0 3.4	4.2
BackupExpireTime	string	Waktu kedaluwarsa backup. Waktu dalam format yyyy-MM-ddTHH:mm:ssZ dan ditampilkan dalam UTC. Penting Nilai "9999-01-01T00:00:00Z" menunjukkan bahwa backup disimpan secara permanen.	2025-08-30T09:49:11Z

Contoh

Respons sukses

JSONformat

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

Kode kesalahan

HTTP status code	Error code	Error message
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.