Referensi API DescribeDownloadBackupSetStorageInfo - Data Management - Alibaba Cloud - Data Management

Deskripsi operasi

Applicable engines

RDS MySQL (cloud disk edition)
RDS PostgreSQL
PolarDB for MySQL
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

dbs:DescribeDownloadBackupSetStorageInfo

get

*BackupPlan

acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionCode	string	Yes	ID Wilayah tempat Instans berada.	cn-hangzhou
Duration	string	Yes	Jika tujuan unduhan adalah URL, parameter ini menentukan periode validitas tautan. Periode validitas default URL adalah 2 jam (7.200 detik). Anda dapat menetapkan periode validitas dengan nilai dari 5 menit (300 detik) hingga 1 hari (86.400 detik). Konversikan nilai ke detik sebelum Anda meneruskannya. Misalnya, untuk menetapkan periode validitas ke 5 menit, teruskan 300.	300
InstanceName	string	No	ID Instans. Catatan Jika Anda menentukan InstanceName, Anda juga harus menentukan BackupSetId.	rm-uf6qqf569n435****
TaskId	string	No	ID Tugas unduhan. Jika Anda tidak menentukan TaskId, Anda harus menentukan BackupSetId dan InstanceName. Untuk Tampilan ID Tugas, klik Backup and Restoration untuk Instans target lalu buka tab Backup Download.	dt-s0ugzak9****
BackupSetId	string	No	ID set cadangan.	30****
ClusterName	string	No	Parameter ini hanya diperlukan untuk Instans MongoDB. Parameter ini menentukan nama kluster sharded.	dds-example

Elemen respons

Element	Type	Description	Example
	object	The returned data.
RequestId	string	The request ID.	44B8C2F5-919D-5D29-BCD5-DEB03467****
ErrCode	string	The error code.	DBS.ParamIsInValid
Success	string	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
ErrMessage	string	The error message.	Argument: regionCode Must not be empty
Code	string	The error code.	DBS.ParamIsInValid
Message	string	The error message.	Argument: regionCode Must not be empty
Data	object	The returned data.
PublicUrl	string	The public URL to download the backup set.	http://dbs-137383785969**-cn-hangzhou-1iv12nblw.oss-cn-hangzhou.aliyuncs.com/dt-u7u4bufa**/dbs_target_file_path/test_456
PrivateUrl	string	The private URL to download the backup set.	http://dbs-137383785969**-cn-hangzhou-1iv12nblw.oss-cn-hangzhou-internal.aliyuncs.com/dt-u7u4bufa**/dbs_target_file_path/test_123
ExpirationTime	integer	The validity period of the link. Catatan The value is a UNIX timestamp.	1661329050

Contoh

Respons sukses

JSONformat

{
  "RequestId": "44B8C2F5-919D-5D29-BCD5-DEB03467****",
  "ErrCode": "DBS.ParamIsInValid",
  "Success": "true",
  "ErrMessage": "Argument: regionCode Must not be empty",
  "Code": "DBS.ParamIsInValid",
  "Message": "Argument: regionCode Must not be empty",
  "Data": {
    "PublicUrl": "http://dbs-137383785969****-cn-hangzhou-1iv12nblw****.oss-cn-hangzhou.aliyuncs.com/dt-u7u4bufa****/dbs_target_file_path/test_456",
    "PrivateUrl": "http://dbs-137383785969****-cn-hangzhou-1iv12nblw****.oss-cn-hangzhou-internal.aliyuncs.com/dt-u7u4bufa****/dbs_target_file_path/test_123",
    "ExpirationTime": 1661329050
  }
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
403	Request.Forbidden	Have no Permissions

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.

Data Management:DescribeDownloadBackupSetStorageInfo