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

Menampilkan daftar task download lanjutan untuk instans RDS for MySQL, RDS for PostgreSQL, dan PolarDB for MySQL.

Deskripsi operasi

Engine yang didukung

Instans ApsaraDB RDS for MySQL yang menggunakan cloud disk
ApsaraDB RDS for PostgreSQL
PolarDB for MySQL
MongoDB

Dokumen terkait

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-${Instance ID}_${Region ID}.	ds-rm-2ze8g2am97624****_cn-hangzhou
BackupSetId	string	No	ID set cadangan. Untuk mendapatkan ID set cadangan, panggil DescribeBackups.	216****
State	string	No	Status task download. Nilai yang valid: initializing: Task sedang diinisialisasi. queueing: Task berada dalam antrian. running: Task sedang berjalan. failed: Task gagal. finished: Task berhasil. expired: Download telah kedaluwarsa.	queueing
TaskType	string	No	Tipe task download. Nilai yang valid: full: download set cadangan penuh. pitr: download pemulihan pada titik waktu.	full
StartTime	string	No	Awal rentang waktu untuk menanyakan task berdasarkan waktu pembuatannya. Ini merupakan Stempel waktu UNIX dalam milidetik (ms).	1661941554000
EndTime	string	No	Akhir rentang waktu untuk menanyakan task berdasarkan waktu pembuatannya. Ini merupakan Stempel waktu UNIX dalam milidetik (ms).	1661941556000
PageSize	string	No	Jumlah entri yang ditampilkan per halaman.	50
CurrentPage	string	No	Nomor halaman.	1
OrderDirect	string	No	Arah pengurutan. Nilai yang valid: asc: urutan menaik. desc: urutan menurun. Ini adalah nilai default.	desc
OrderColumn	string	No	Bidang yang digunakan untuk pengurutan. Nilai default adalah gmt_create, yang menunjukkan waktu pembuatan.	gmt_create
ClusterName	string	No	Nama kluster sharded. Parameter ini hanya wajib diisi untuk instans MongoDB.	dds-example

Elemen respons

Element	Type	Description	Example
	object	Parameter yang dikembalikan.
RequestId	string	ID permintaan.	5D285EB9-A443-592D-9F3D-A888FAC3****
ErrCode	string	Kode kesalahan.	DBS.InternalError
Success	string	Menunjukkan apakah permintaan berhasil. Nilai yang valid: true: Permintaan berhasil. false: Permintaan gagal.	true
ErrMessage	string	Pesan kesalahan.	instanceName can not be empty
Code	string	Kode kesalahan.	DBS.InternalError
Message	string	Pesan kesalahan.	instanceName can not be empty
Data	object	Detail task.
PageNumber	integer	Nomor halaman. Harus lebih besar dari 0 dan tidak melebihi nilai maksimum tipe data integer. Nilai default: 1.	1
TotalPages	integer	Total jumlah halaman.	2
Extra	string	Informasi tambahan tentang task yang digunakan untuk mencadangkan data ke cloud.	dbtest
TotalElements	integer	Total jumlah task download.	1
PageSize	integer	Jumlah entri yang dikembalikan per halaman.	10
Content	object
List	array<object>	Detail task.
	object	Detail task.
TaskId	string	ID task download.	dt-qxntlvgu****
RegionCode	string	ID wilayah.	cn-hangzhou
Format	string	Format tujuan konversi data yang di-download. Nilai yang valid: csv SQL Parquet	csv
DbList	string	Daftar database.	[dbtest]
BakSetId	string	ID set cadangan penuh.	148261****
DownloadStatus	string	Status task download. Nilai yang valid: initializing: Task sedang diinisialisasi. queueing: Task berada dalam antrian. running: Task sedang berjalan. failed: Task gagal. finished: Task berhasil. expired: Download telah kedaluwarsa.	queueing
ExportDataSize	string	Volume data yang diekspor, dalam byte.	0
ImportDataSize	string	Volume data yang diproses, dalam byte.	0
BackupSetTime	string	Titik waktu untuk task download pemulihan pada titik waktu. Ini merupakan Stempel waktu UNIX dalam milidetik (ms).	1663162216000
TargetType	string	Tipe tujuan download. Nilai yang valid: OSS URL	URL
TargetPath	string	Jalur tujuan data yang di-download. Parameter ini dikembalikan ketika TargetType diatur ke OSS.	test_db/path
Progress	string	Jumlah tabel yang diekspor/Jumlah total tabel yang akan diekspor.	0/0
GmtCreate	string	Waktu pembuatan task. Ini merupakan Stempel waktu UNIX dalam milidetik.	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.