Ringkasan API DescribeBackupSetDownloadTaskList - Data Management - Alibaba Cloud - Data Management

Mengkueri daftar tugas unduhan untuk set cadangan di Cadangan Basis Data (DBS).

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

get

*全部资源

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
BackupPlanId	string	No	ID rencana cadangan. Panggil operasi DescribeBackupPlanList untuk memperoleh nilai parameter ini. Catatan Anda harus menentukan salah satu dari BackupPlanId atau BackupSetDownloadTaskId.	dbsqhnuhyw3****
BackupSetDownloadTaskId	string	No	ID tugas unduhan set cadangan. Untuk cadangan penuh, panggil operasi CreateFullBackupSetDownload untuk memperoleh nilai parameter ini. Untuk cadangan inkremental, panggil operasi CreateIncrementBackupSetDownload untuk memperoleh nilai parameter ini.	urxgrxt7****
PageSize	integer	No	Jumlah entri yang dikembalikan per halaman. Nilai valid: 30, 50, dan 100. Catatan Nilai default adalah 30.	30
PageNum	integer	No	Nomor halaman. Nilai harus berupa bilangan bulat non-negatif yang tidak melebihi nilai maksimum tipe integer. Nilai default adalah 0.	1
ClientToken	string	No	Token klien yang digunakan untuk memastikan idempotensi permintaan. Parameter ini mencegah permintaan duplikat.	ETnLKlblzczshOTUbOCzXXXXXX

Elemen respons

Element	Type	Description	Example
	object	The details of the returned parameters.
HttpStatusCode	integer	The HTTP status code.	200
PageNum	integer	The page number.	0
RequestId	string	The request ID.	6DC3D286-E0E6-5988-A558-2184984B****
ErrCode	string	The error code.	Param.NotFound
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
ErrMessage	string	The error message.	The specified parameter %s value is not valid.
TotalPages	integer	The total number of pages.	1
TotalElements	integer	The total number of download records for backup sets.	1
PageSize	integer	The number of entries returned per page.	30
Items	object
BackupSetDownloadTaskDetail	array<object>	The details of the backup set download task.
	object	The details of the backup set download task.
BackupSetDownloadStatus	string	The status of the backup set download. Valid values: checking: The system is performing a precheck. init: The precheck failed and the task has not started. check_pass: The precheck is passed. pause: The task is paused. schedule: The task is waiting to be scheduled. running: The task is running. stop: The task failed. finish: The task is complete.	finish
BackupSetDataSize	integer	The size of the backup set data.	237837
BackupSetDownloadTargetType	string	The target type for the backup set download. Catatan This parameter is returned only for automatic downloads. The value "agent" indicates that a backup gateway is installed.	无
BackupSetDownloadDir	string	The folder on the server where the backup set is downloaded. Catatan This parameter has a value only for automatic downloads.	无
ErrMessage	string	The error message.	java.lang.IndexOutOfBoundsException.
BackupSetDownloadCreateTime	integer	The UNIX timestamp that indicates when the task was created.	1642044001000
BackupPlanId	string	The ID of the backup plan.	qhnuhyw3****
BackupSetDbType	string	The database type.	MySQL
BackupSetDownloadInternetUrl	string	The public download URL for the backup set. Catatan This parameter has a value only for manual downloads after the data format is transformed.	"//dbs-137XXXX-cn-hangzhou-1hr5cpbtmXXXX.oss-cn-hangzhou.example"
BackupSetId	string	The ID of the source backup set.	1h7za2yws****
BackupSetDownloadIntranetUrl	string	The internal download URL for the backup set. Catatan This parameter has a value only for manual downloads after the data format is transformed.	"//dbs-13XXXX-cn-hangzhou-1hr5cpbtmXXXX.oss-cn-hangzhou-internal.example"
BackupGatewayId	integer	The ID of the backup gateway. This parameter has a value only for automatic downloads.	无
BackupSetDownloadWay	string	The download method. Valid values: manual: Manual download. auto: Automatic download.	manual
BackupSetDownloadFinishTime	integer	The UNIX timestamp that indicates when the task was complete.	1642044013000
BackupSetJobType	string	The type of the source backup set task. Valid values: cbs_backup_sub_full: Logical full backup task. cbs_backup_sub_cont: Logical incremental backup task.	cbs_backup_sub_cont
BackupSetDownloadTaskId	string	The ID of the backup set download task.	urxgrxt7****
BackupSetDownloadTaskName	string	The name of the backup set download task.	1h7za2yws****-ManualCont
BackupSetDataFormat	string	The data format of the downloaded backup set. Valid values: Native SQL CSV JSON	Native
BackupSetCode	string	The code of the source backup set.	mysql-bin.00XXXX

Contoh

Respons sukses

JSONformat

{
  "HttpStatusCode": 200,
  "PageNum": 0,
  "RequestId": "6DC3D286-E0E6-5988-A558-2184984B****",
  "ErrCode": "Param.NotFound",
  "Success": true,
  "ErrMessage": "The specified parameter %s value is not valid.",
  "TotalPages": 1,
  "TotalElements": 1,
  "PageSize": 30,
  "Items": {
    "BackupSetDownloadTaskDetail": [
      {
        "BackupSetDownloadStatus": "finish",
        "BackupSetDataSize": 237837,
        "BackupSetDownloadTargetType": "无",
        "BackupSetDownloadDir": "无",
        "ErrMessage": "java.lang.IndexOutOfBoundsException.",
        "BackupSetDownloadCreateTime": 1642044001000,
        "BackupPlanId": "qhnuhyw3****",
        "BackupSetDbType": "MySQL",
        "BackupSetDownloadInternetUrl": "\"//dbs-137XXXX-cn-hangzhou-1hr5cpbtmXXXX.oss-cn-hangzhou.example\"",
        "BackupSetId": "1h7za2yws****",
        "BackupSetDownloadIntranetUrl": "\"//dbs-13XXXX-cn-hangzhou-1hr5cpbtmXXXX.oss-cn-hangzhou-internal.example\"",
        "BackupGatewayId": 0,
        "BackupSetDownloadWay": "manual",
        "BackupSetDownloadFinishTime": 1642044013000,
        "BackupSetJobType": "cbs_backup_sub_cont",
        "BackupSetDownloadTaskId": "urxgrxt7****",
        "BackupSetDownloadTaskName": "1h7za2yws****-ManualCont",
        "BackupSetDataFormat": "Native",
        "BackupSetCode": "mysql-bin.00XXXX"
      }
    ]
  }
}

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.