Referensi API DescribeDownloadTask untuk tugas backup RDS & PolarDB - Data Management - Alibaba Cloud - Data Management

Mengkueri daftar tugas unduhan tingkat lanjut untuk instans RDS for MySQL, RDS for PostgreSQL, dan PolarDB Basis Data Relasional Cloud-Native for MySQL.

Deskripsi operasi

Applicable engines

ApsaraDB RDS for MySQL instances that use cloud disks
ApsaraDB RDS for 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:DescribeDownloadTask

get

*DBInstance

acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionCode	string	Yes	ID Wilayah tempat Instans berada. Untuk mendapatkan ID Wilayah, panggil DescribeDBInstanceAttribute.	cn-hangzhou
InstanceName	string	No	ID Instans. Catatan Parameter ini wajib diisi.	rm-bp1imnmcjxdz7****
DatasourceId	string	No	ID Sumber data di DBS. Formatnya adalah: ds-${ID Instans}_${ID Wilayah}.	ds-rm-2ze8g2am97624****_cn-hangzhou
BackupSetId	string	No	ID set cadangan. Untuk mendapatkan ID set cadangan, panggil DescribeBackups.	216****
State	string	No	Status Tugas unduhan. Nilai valid: initializing: Tugas sedang diinisialisasi. queueing: Tugas berada dalam Antrian. running: Tugas sedang Berjalan. failed: Tugas gagal. finished: Tugas berhasil. expired: Unduhan telah kedaluwarsa.	queueing
TaskType	string	No	Tipe Tugas unduhan. Nilai valid: full: unduhan set cadangan penuh. pitr: unduhan pemulihan titik pengatur waktu.	full
StartTime	string	No	Awal rentang pengatur waktu untuk mengkueri Tugas berdasarkan pengatur waktu pembuatannya. Ini adalah Stempel waktu UNIX dalam milidetik (ms).	1661941554000
EndTime	string	No	Akhir rentang pengatur waktu untuk mengkueri Tugas berdasarkan pengatur waktu pembuatannya. Ini adalah Stempel waktu UNIX dalam milidetik (ms).	1661941556000
PageSize	string	No	Jumlah entri yang akan ditampilkan di setiap halaman.	50
CurrentPage	string	No	Nomor halaman.	1
OrderDirect	string	No	Arah Pengurutan. Nilai valid: asc: Pesanan menaik. desc: Pesanan menurun. Ini adalah nilai default.	desc
OrderColumn	string	No	Bidang yang digunakan untuk Pengurutan. Nilai default adalah gmt_create, yang menunjukkan pengatur waktu pembuatan.	gmt_create
ClusterName	string	No	Nama kluster sharded. Parameter ini hanya diperlukan untuk instans MongoDB.	dds-example

Elemen respons

Element	Type	Description	Example
	object	The returned parameters.
RequestId	string	The request ID.	5D285EB9-A443-592D-9F3D-A888FAC3****
ErrCode	string	The error code.	DBS.InternalError
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.	instanceName can not be empty
Code	string	The error code.	DBS.InternalError
Message	string	The error message.	instanceName can not be empty
Data	object	The task details.
PageNumber	integer	The page number. It must be greater than 0 and not exceed the maximum value of the integer data type. Default value: 1.	1
TotalPages	integer	The total number of pages.	2
Extra	string	Additional information about the task that is used to back up data to the cloud.	dbtest
TotalElements	integer	The total number of download tasks.	1
PageSize	integer	The number of entries returned per page.	10
Content	object
List	array<object>	The task details.
	object	The task details.
TaskId	string	The download task ID.	dt-qxntlvgu****
RegionCode	string	The region ID.	cn-hangzhou
Format	string	The destination format to which the downloaded data is converted. Valid values: csv SQL Parquet	csv
DbList	string	The list of databases.	[dbtest]
BakSetId	string	The ID of the full backup set.	148261****
DownloadStatus	string	The state of the download task. Valid values: initializing: The task is being initialized. queueing: The task is in a queue. running: The task is running. failed: The task failed. finished: The task is successful. expired: The download has expired.	queueing
ExportDataSize	string	The volume of exported data, in bytes.	0
ImportDataSize	string	The volume of processed data, in bytes.	0
BackupSetTime	string	The point in time of the point-in-time download task. This is a UNIX timestamp in milliseconds (ms).	1663162216000
TargetType	string	The type of the download destination. Valid values: OSS URL	URL
TargetPath	string	The destination path of the downloaded data. This parameter is returned when TargetType is set to OSS.	test_db/path
Progress	string	The number of exported tables/The total number of tables to be exported.	0/0
GmtCreate	string	The time when the task was created. This is a UNIX timestamp in milliseconds.	1663321957000

Contoh

Respons sukses

JSONformat

{
  "RequestId": "5D285EB9-A443-592D-9F3D-A888FAC3****",
  "ErrCode": "DBS.InternalError",
  "Success": "true",
  "ErrMessage": "instanceName can not be empty",
  "Code": "DBS.InternalError",
  "Message": "instanceName can not be empty",
  "Data": {
    "PageNumber": 1,
    "TotalPages": 2,
    "Extra": "dbtest",
    "TotalElements": 1,
    "PageSize": 10,
    "Content": {
      "List": [
        {
          "TaskId": "dt-qxntlvgu****",
          "RegionCode": "cn-hangzhou",
          "Format": "csv",
          "DbList": "[dbtest]",
          "BakSetId": "148261****",
          "DownloadStatus": "queueing",
          "ExportDataSize": "0",
          "ImportDataSize": "0",
          "BackupSetTime": "1663162216000",
          "TargetType": "URL",
          "TargetPath": "test_db/path",
          "Progress": "0/0",
          "GmtCreate": "1663321957000"
        }
      ]
    }
  }
}

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