Otomatisasi Kueri Backup MongoDB dengan API DescribeBackups - ApsaraDB for MongoDB - Alibaba Cloud - ApsaraDB for MongoDB

Mengkueri cadangan 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 adalah instans kluster sharded, Anda juga harus menentukan parameter NodeId.	dds-bp1a7009eb24****
NodeId	string	No	ID node shard di instans kluster sharded. Catatan Parameter ini diperlukan jika Anda menentukan ID instans kluster sharded untuk parameter DBInstanceId.	d-bp128a003436****
BackupId	string	No	ID cadangan. Jika Anda menentukan ID instans kluster sharded untuk parameter DBInstanceId, jumlah ID cadangan harus sama dengan jumlah node shard. Pisahkan ID cadangan dengan koma (,).	2072**,2072,2072**
PageNumber	integer	No	Nomor halaman. Nilai harus lebih besar dari 0 dan tidak lebih besar dari nilai maksimum tipe data integer. Nilai default: 1.	1
PageSize	integer	No	Jumlah entri yang akan dikembalikan di 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.	2022-01-13T13:00Z
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.	2022-01-14T13:00Z
SrcRegion	string	No	Wilayah tempat instans berada. Catatan Parameter ini diperlukan untuk memulihkan instans yang telah dihapus. Parameter ini diperlukan untuk geo-redundancy.	cn-beijing
DestRegion	string	No	Wilayah tempat cadangan berada. Catatan Parameter ini diperlukan 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	The total number of backups.	1
RequestId	string	The request ID.	275D43C3-F12F-5224-B375-************
PageSize	integer	The number of entries returned per page. Valid values: 30 (Default) 50 100	30
PageNumber	integer	The page number.	1
Backups	object
Backup	array<object>	The details of the backup files.
	object	The details of the backup files.
BackupStatus	string	The backup status. Valid values: Success: The backup is successful. Failed: The backup failed.	Success
BackupType	string	The backup type. Valid values: FullBackup: full backup. IncrementalBackup: incremental backup.	FullBackup
BackupStartTime	string	The start time of the backup. The time is in the yyyy-MM-ddTHH:mm:ssZ format and is displayed in UTC.	2022-01-14T03:56:17Z
BackupIntranetDownloadURL	string	The internal download URL for the backup file. Catatan Use this URL to download the backup file from an ECS instance. The ECS instance must be in the same network as the MongoDB instance.	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	The size of the backup file. Unit: bytes.	6168576
BackupDownloadURL	string	The external download URL for the backup file. If the file is not available for download, an empty string is returned.	http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/custins5559**/hins1936_data_2022052504_qp.xb?Expires=165361&OSSAccessKeyId=********************&Signature=****************************&Region=cn-hangzhou
BackupMode	string	The backup mode. Valid values: Automated: automatic backup. Manual: manual backup.	Automated
BackupEndTime	string	The end time of the backup. The time is in the yyyy-MM-ddTHH:mm:ssZ format and is displayed in UTC.	2022-01-14T03:57:34Z
BackupId	string	The backup ID.	32102****
BackupDBNames	string	The name of the database that is backed up.	database
BackupMethod	string	The backup method. Valid values: Snapshot: snapshot backup. Physical: physical backup. Logical: logical backup.	Physical
BackupJobId	string	The ID of the backup set job.	1123xxxx
BackupName	string	The name of the backup set. This parameter is currently invalid.	12345678.tar.gz
BackupScale	string	The backup granularity. This parameter is currently invalid.	DBInstance
IsAvail	boolean	Indicates whether the backup set is available. Valid values: false: unavailable. true: available.	1
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 expiration time of the backup. 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-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.