Jalankan tugas CreateDownload API untuk mengekspor data backup - Data Management

Buat Tugas Unduh Lanjutan.

Deskripsi operasi

Engine yang didukung

RDS MySQL (instans Cloud Disk)
RDS PostgreSQL
PolarDB for MySQL
ApsaraDB for MongoDB

Dokumentasi terkait

Untuk instans yang memenuhi syarat, Anda dapat membuat Tugas Unduh Lanjutan untuk suatu Set Cadangan tertentu atau untuk titik waktu tertentu. Anda dapat mengatur tujuan unduhan ke URL atau menulis data langsung ke bucket Object Storage Service (OSS) Anda untuk analitik data dan pengarsipan offline.

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

create

*DBInstance

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

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionCode	string	Yes	ID wilayah tempat instans berada. Anda dapat memanggil operasi DescribeDBInstanceAttribute untuk instans ApsaraDB RDS atau operasi DescribeDBClusterAttribute untuk kluster PolarDB guna menanyakan ID wilayah tersebut.	cn-beijing
InstanceName	string	Yes	ID instans.	rm-wz994c1t1****
BakSetType	string	No	Jenis tugas unduhan. Nilai yang valid: full: Mengunduh set cadangan penuh. pitr: Mengunduh data dari titik waktu tertentu.	full
BakSetId	string	No	ID set cadangan. Anda dapat memanggil operasi DescribeBackups untuk instans ApsaraDB RDS atau operasi DescribeBackups untuk kluster PolarDB guna mendapatkan ID set cadangan tersebut. Catatan Parameter ini wajib jika `BakSetType` diatur ke `full`.	146005****
DownloadPointInTime	string	No	Titik waktu untuk pengunduhan. Tentukan stempel waktu UNIX dalam milidetik (ms). Catatan Parameter ini wajib jika `BakSetType` diatur ke `pitr`.	1661331864000
BakSetSize	string	No	Ukuran set cadangan penuh, dalam byte. Anda dapat memanggil operasi DescribeBackups untuk instans ApsaraDB RDS atau operasi DescribeBackups untuk kluster PolarDB guna menanyakan ukurannya.	216****
FormatType	string	No	Format target data yang diunduh. Nilai yang valid: CSV SQL Parquet Bson qp.xb Catatan Parameter ini wajib. Format `Bson` hanya tersedia untuk instans MongoDB. Format `qp.xb` hanya tersedia untuk instans ApsaraDB RDS for MySQL. Valid values: qp.xb : qp.xb csv : CSV bson : Bson csv-with-header : csv-with-header parquet : Parquet sql : SQL	CSV
TargetType	string	No	Jenis tujuan unduhan. Nilai yang valid: OSS URL	OSS
TargetBucket	string	No	Nama bucket OSS tujuan. Parameter ini wajib jika `TargetType` diatur ke `OSS`. Pastikan akun Anda telah diberikan role AliyunDBSDefaultRole. Untuk informasi selengkapnya, lihat Berikan izin kepada role RAM. Anda juga dapat memberikan role tersebut di konsol dengan mengikuti petunjuk di layar.	test123
TargetPath	string	No	Jalur tujuan untuk data yang diunduh. Catatan Parameter ini wajib jika `TargetType` diatur ke `OSS`.	test_db/path
TargetOssRegion	string	No	Wilayah tempat bucket OSS tujuan berada. Catatan Parameter ini wajib jika `TargetType` diatur ke `OSS`.	cn-beijing
PrimaryKeyTypeOnly	string	No	Parameter ini hanya wajib untuk instans MongoDB. Parameter ini menentukan apakah kunci primer dalam tabel bersifat unik. Atur nilainya ke `true` jika kunci primer unik, atau `false` jika tidak.	false
IsCluster	string	No	Parameter ini hanya wajib untuk instans MongoDB. Atur nilainya ke `true` jika instans merupakan kluster sharded, atau `false` jika tidak.	false
AdminDatabase	string	No	Parameter ini hanya wajib untuk instans MongoDB. Parameter ini menentukan nama database otentikasi. Nilai default-nya adalah `admin`.	admin
UseZstd	string	No	Menentukan apakah akan menggunakan algoritma kompresi zstd. Nilai default: `false`.	false
ClusterName	string	No	Parameter ini hanya wajib untuk kluster sharded MongoDB. Parameter ini menentukan ID kluster sharded.	dds-0xid8e5336******
IsPhysical	boolean	No	Parameter ini hanya wajib saat Anda mengunduh data dalam format `qp.xb` dari instans ApsaraDB RDS for MySQL. Dalam kasus ini, atur nilainya ke `true`.	true

Elemen respons

Element	Type	Description	Example
	object	Data respons.
RequestId	string	ID permintaan.	A08F908D-2C35-583F-93C1-ED80753F****
ErrCode	string	Kode kesalahan.	DBS.ParamIsInValid
Success	string	Menunjukkan apakah permintaan berhasil. Nilai yang valid: true: Permintaan berhasil. false: Permintaan gagal.	true
ErrMessage	string	Pesan kesalahan.	formatType can not be empty
Code	string	Kode status.	DBS.ParamIsInValid
Message	string	Pesan kesalahan.	formatType can not be empty
Data	object	Detail tugas unduhan.
BakSetId	string	ID set cadangan penuh.	146005****
DownloadStatus	string	Status tugas unduhan. Nilai yang valid: initializing: Tugas sedang diinisialisasi. queueing: Tugas sedang dalam antrian. running: Tugas sedang berjalan. failed: Tugas gagal. finished: Tugas selesai. expired: Tugas telah kedaluwarsa. Catatan Jika tujuan unduhan adalah URL, tautan tersebut kedaluwarsa tiga hari setelah tugas selesai.	initializing
Progress	string	Jumlah tabel yang telah diunduh dibandingkan dengan jumlah total tabel. Catatan Jika tugas sedang diinisialisasi, `0/0` dikembalikan.	0/0
BackupSetTime	integer	Titik waktu set cadangan, dikembalikan sebagai stempel waktu UNIX dalam milidetik.	1661373070000
RegionCode	string	ID wilayah.	cn-beijing
TargetPath	string	Jalur tujuan untuk pengunduhan data. Catatan Parameter ini hanya dikembalikan ketika `TargetType` adalah `OSS`.	test_db/path
DbList	string	Jika pengunduhan ditujukan untuk database atau tabel tertentu, parameter ini mencantumkan nama-namanya.	testdb
ExportDataSize	integer	Ukuran data yang diekspor, dalam byte.	0
ImportDataSize	integer	Ukuran data yang diproses, dalam byte.	0
GmtCreate	integer	Waktu pembuatan tugas, dikembalikan sebagai stempel waktu UNIX dalam milidetik.	1661940917570
TaskId	string	ID tugas unduhan.	dt-qxnsfq5s****
Format	string	Format ke mana data dikonversi.	CSV
TargetType	string	Jenis tujuan unduhan.	URL

Contoh

Respons sukses

JSONformat

{
  "RequestId": "A08F908D-2C35-583F-93C1-ED80753F****",
  "ErrCode": "DBS.ParamIsInValid",
  "Success": "true",
  "ErrMessage": "formatType can not be empty",
  "Code": "DBS.ParamIsInValid",
  "Message": "formatType can not be empty",
  "Data": {
    "BakSetId": "146005****",
    "DownloadStatus": "initializing",
    "Progress": "0/0",
    "BackupSetTime": 1661373070000,
    "RegionCode": "cn-beijing",
    "TargetPath": "test_db/path",
    "DbList": "testdb",
    "ExportDataSize": 0,
    "ImportDataSize": 0,
    "GmtCreate": 1661940917570,
    "TaskId": "dt-qxnsfq5s****",
    "Format": "CSV",
    "TargetType": "URL"
  }
}

Kode kesalahan

HTTP status code	Error code	Error message
200	DBS.DownloadTask.CannotFind	Can not find download task.
200	DBS.DownloadTask.JobAlreadyExist	Job already submit in recent days, please check it.
200	DBS.DownloadTask.OnlyOneRunningOrFailedTask	There can be only one running or failed task for the instance.
200	DBS.DownloadTask.OssForbid	OSS is forbidden to access. Please check your OSS bucket.
200	DBS.DownloadTask.OssStorageTypeInvalid	Unsupported bucket storage. Please make sure that your OSS bucket's storgae type is standard.
200	Forbidden.InstanceNotFound	instance not found
200	DBS.DownloadTask.BakSetError	DBS download task bak set error. Your backup set does not meet the requirements.
200	DBS.DownloadTask.CustinIdNotSupport	DBS DownloadTask CustinIdNotSupport.
200	DBS.DownloadTask.CustinNameNotSupport	DBS DownloadTask CustinNameNotSupport.
200	DBS.DownloadTask.DbTypeNotSupport	DBS DownloadTask DbTypeNotSupport.
200	DBS.DownloadTask.InstanceInfoNotSupport	DBS DownloadTask InstanceInfoNotSupport.
200	DBS.DownloadTask.InstanceParamNotSupport	DBS DownloadTask InstanceParamNotSupport.
200	DBS.DownloadTask.InstanceStorageTypeNotSupport	DBS DownloadTask InstanceStorageTypeNotSupport.
200	DBS.DownloadTask.InstanceVersionNotSupport	DBS DownloadTask InstanceVersionNotSupport.
200	DBS.DownloadTask.NotSupport	DBS DownloadTask NotSupport.
200	DBS.DownloadTask.RegionNotSupport	DBS DownloadTask RegionNotSupport.
200	DBS.DownloadTask.UserNotSupport	DBS DownloadTask UserNotSupport.
403	Request.Forbidden	Have no Permissions
403	DBS.NoPermissionException	Rejected by ValidationChecker.
404	DBS.NotExists	data source do not existed.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.