DescribeHistoryTasks - ApsaraDB RDS - Alibaba Cloud Documentation Center

Mengkueri riwayat catatan tugas operasi dan pemeliharaan. Mendukung pengkuerian tugas yang dibuat dalam 30 hari terakhir.

Deskripsi operasi

Mesin yang didukung

RDS MySQL
RDS PostgreSQL
RDS SQL Server.

Dokumentasi fitur terkait

Penting Sebelum menggunakan API ini, baca dokumentasi fitur dengan saksama untuk memastikan Anda sepenuhnya memahami prasyarat dan dampak penggunaan API ini sebelum melakukan operasi.

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

rds:DescribeHistoryTasks

get

*全部资源

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	No	ID wilayah tempat event tertunda berada. Anda dapat memanggil operasi DescribeRegions untuk mendapatkan ID wilayah.	cn-beijing
PageSize	integer	No	Jumlah entri per halaman. Nilai valid: 10 hingga 100. Nilai default: 10.	10
PageNumber	integer	No	Nomor halaman yang akan dikembalikan. Nilai harus berupa bilangan bulat positif. Nilai default: 1.	1
InstanceType	string	No	Hanya Instans yang didukung.	Instance
Status	string	No	Status tugas. Nilai valid: Scheduled: Tugas menunggu untuk dieksekusi. Running: Tugas sedang dieksekusi. Succeed: Tugas berhasil dieksekusi. Failed: Tugas gagal dieksekusi. Cancelling: Tugas sedang dihentikan. Canceled: Tugas telah dihentikan. Waiting: Tugas menunggu waktu yang telah ditetapkan. Untuk mengkueri tugas dengan beberapa status, pisahkan status dengan koma (,). Nilai default kosong, yang berarti semua status dipilih.	Scheduled
InstanceId	string	No	ID instans, yang digunakan untuk mengkueri tugas dari instans yang sesuai. Pisahkan beberapa ID instans dengan koma (,). Mendukung maksimum 30 ID instans. Nilai default kosong, yang berarti tidak ada batasan.	rm-uf62br2491p5l****
TaskId	string	No	ID tugas, yang dapat diperoleh dengan memanggil operasi DescribeTasks. Jika Anda memiliki beberapa ID tugas, pisahkan dengan koma (,). Mendukung maksimum 30 ID tugas. Nilai default kosong, yang berarti tidak ada batasan.	t-83br18hloy3faf****
TaskType	string	No	Tipe tugas, yang digunakan untuk mengkueri tugas dengan tipe tertentu. Pisahkan beberapa tipe tugas dengan koma (,). Mendukung maksimum 30 tipe tugas. Nilai default kosong, yang berarti tidak ada batasan.	autotest_dispatch_cases
FromStartTime	string	Yes	Awal rentang waktu untuk waktu mulai tugas. Menunjukkan bahwa tugas yang waktu mulainya setelah waktu ini akan dikueri. Waktu dinyatakan dalam standar ISO 8601 dan harus dalam UTC+0 dengan format yyyy-MM-ddTHH:mm:ssZ. Waktu paling awal yang didukung adalah 30 hari pengatur waktu saat ini. Waktu yang lebih dari 30 hari dari waktu saat ini akan secara otomatis dikonversi menjadi 30 hari pengatur waktu saat ini.	2022-01-02T11:31:03Z
ToStartTime	string	Yes	Akhir rentang waktu untuk waktu mulai tugas. Menunjukkan bahwa tugas yang waktu mulainya sebelum waktu ini akan dikueri. Waktu dinyatakan dalam standar ISO 8601 dan harus dalam UTC+0 dengan format yyyy-MM-ddTHH:mm:ssZ.	2022-03-02T11:31:03Z
FromExecTime	integer	No	Nilai minimum durasi eksekusi tugas. Parameter ini digunakan untuk memfilter tugas yang durasi eksekusinya lebih besar dari nilai ini. Unit: detik. Nilai default adalah 0, yang berarti tidak ada batasan.	0
ToExecTime	integer	No	Nilai maksimum durasi eksekusi tugas. Parameter ini digunakan untuk memfilter tugas yang durasi eksekusinya tidak kurang dari nilai ini. Unit: detik. Nilai default adalah 0, yang berarti tidak ada batasan.	0
ResourceGroupId	string	No	ID kelompok sumber daya.	rg-ae****

Elemen respons

Element	Type	Description	Example
	object	Detail parameter yang dikembalikan.
Items	array<object>	Daftar tugas.
	object	Objek tugas.
ActionInfo	string	Informasi aksi yang diizinkan. Penggunaan sebenarnya adalah mencocokkan Action berdasarkan currentStepName+status dalam informasi ini. Jika tidak ada Action yang cocok, status tugas saat ini tidak mendukung operasi tersebut. Contoh: `"steps": [ { "step_name": "exec_task", // Step name, matches currentStepName "action_info": { // Actions supported by the step "Waiting": [ // Status, matches status "modifySwitchTime" // Action, multiple actions may be supported ] } }, { "step_name": "init_task", // Step name "action_info": { // Actions supported by the step "Running": [ // Status "cancel", // Action "pause" ] } } ] }` Operasi yang didukung oleh sistem: retry: Coba ulang cancel: Batalkan modifySwitchTime: Ubah waktu pengalihan atau waktu pemulihan.	{\"steps\":[{\"action_info\":{\"Waiting\":[\"modifySwitchTime\"]},\"step_name\":\"exec_task\"}]}
CallerSource	string	ID pengguna yang memulai permintaan. Ketika callerSource adalah User, ini menunjukkan UID pengguna.	141345906006****
CallerUid	string	Sumber permintaan. Nilai valid: System: Sistem User: Pengguna.	User
CurrentStepName	string	Nama langkah yang sedang dieksekusi. Jika kosong, tugas belum dimulai.	exec_task
DbType	string	Tipe database.	mysql
EndTime	string	Waktu akhir tugas.	2022-02-03T12:06:17Z
InstanceId	string	ID instans.	rm-uf62br2491p5l****
InstanceName	string	Nama instans.	test
InstanceType	string	Tipe instans.	Instance
Product	string	Produk.	rds
Progress	number	Progres saat ini.	79.0
ReasonCode	string	Alasan tugas saat ini dimulai.	****
RegionId	string	ID wilayah.	cn-shanghai
RemainTime	integer	Estimasi sisa waktu eksekusi, dalam detik (s).	1000
StartTime	string	Waktu mulai tugas.	2022-02-03T11:31:03Z
Status	string	Status tugas. Scheduled: Tugas menunggu untuk dieksekusi. Running: Tugas sedang dieksekusi. Succeed: Tugas berhasil dieksekusi. Failed: Tugas gagal dieksekusi. Cancelling: Tugas sedang dihentikan. Canceled: Tugas telah dihentikan. Waiting: Tugas menunggu waktu yang telah ditetapkan.	Running
TaskDetail	string	Detail tugas.	{\"callerUid\":\"test\"}
TaskId	string	ID tugas.	t-83br18hloy3faf****
TaskType	string	Tipe tugas.	autotest_dispatch_cases
Uid	string	ID pengguna yang memiliki sumber daya.	141345906006****
PageNumber	integer	Nomor halaman hasil kueri.	1
PageSize	integer	Jumlah entri per halaman.	10
RequestId	string	ID permintaan unik. Jika Anda mengalami masalah, berikan ID permintaan ini agar staf kami dapat melakukan pemecahan masalah untuk Anda.	5CD61041-35F7-10F7-BE94-33A48B22****
TotalCount	integer	Jumlah total tugas yang memenuhi kondisi filter, tanpa memperhitungkan paginasi.	2

Contoh

Respons sukses

JSONformat

{
  "Items": [
    {
      "ActionInfo": "{\\\"steps\\\":[{\\\"action_info\\\":{\\\"Waiting\\\":[\\\"modifySwitchTime\\\"]},\\\"step_name\\\":\\\"exec_task\\\"}]}",
      "CallerSource": "141345906006****",
      "CallerUid": "User",
      "CurrentStepName": "exec_task",
      "DbType": "mysql",
      "EndTime": "2022-02-03T12:06:17Z",
      "InstanceId": "rm-uf62br2491p5l****",
      "InstanceName": "test",
      "InstanceType": "Instance",
      "Product": "rds",
      "Progress": 79,
      "ReasonCode": " ****",
      "RegionId": "cn-shanghai",
      "RemainTime": 1000,
      "StartTime": "2022-02-03T11:31:03Z",
      "Status": "Running",
      "TaskDetail": "{\\\"callerUid\\\":\\\"test\\\"}",
      "TaskId": "t-83br18hloy3faf****",
      "TaskType": "autotest_dispatch_cases",
      "Uid": "141345906006****"
    }
  ],
  "PageNumber": 1,
  "PageSize": 10,
  "RequestId": "5CD61041-35F7-10F7-BE94-33A48B22****",
  "TotalCount": 2
}

Kode kesalahan

HTTP status code	Error code	Error message
400	Param.Invalid	Param invalid
400	Param.Invalid.TimeEndBeforeStart	Param invalid. End time before start time
400	Order.ComboInstanceNotAllowOperate	A package instance is not allowed to operate independently.
400	Price.PricingPlanResultNotFound	Pricing plan price result not found.
400	Order.NoRealNameAuthentication	You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.
400	InsufficientAvailableQuota	Your account quota limit is less than 0, please recharge before trying to purchase.
400	CommodityServiceCalling.Exception	Failed to call commodity service.
400	RegionDissolvedEOM	Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.
400	Commodity.InvalidComponent	The module you purchased is not legal, please buy it again.
400	RegionEndTimeDissolvedAustralia	Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.
400	Price.CommoditySys	Commodity system call exception.
400	Pay.InsufficientBalance	Insufficient available balance.
400	Order.PeriodInvalid	There is a problem with the period you selected, please choose again.
400	pay.noCreditCard	Account not bound to credit card.
400	Order.InstHasUnpaidOrder	There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.
400	noAvailablePaymentMethod	No payment method is specified for your account. We recommend that you add a payment method.
400	BasicInfoUncompleted	Your information is incomplete. Complete your information before the operation.
400	Risk.RiskControlRejection	Your account is abnormal, please contact customer service for details.
400	Api.NotSupport	Specified api is not supported.
400	ContainForbiddenLabelError	There is a label that prohibits placing orders. Please contact your distributor for assistance.
400	InvalidDBInstanceId.NotFound	The DBInstanceId provided does not exist in records.
400	InvalidInstanceLevel.DiskType	Specified instance level not support request disk type
400	InvalidParam	Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.
400	KmsApiError	User secret key invalid.
400	System.SaleValidateFailed	Sales expression validation system error.
400	Abs.InvalidAccount.NotFound	account is not found.
400	SqlExecuteFailedOrTimeout	sql command execution failed or timed out:%s.
400	ColdData.EngineVersionNotSupport	The current instance engine version not support coldDataEnabled.
400	ColdData.MinorVersionNotSupport	The current instance minor version not support coldDataEnabled.
400	IncorrectTargetClasscode	The current instance type does not support this operation.
400	InvalidConnectionString.Duplicate	Specified connection string already exists in the RDS.
400	RequiredParam.NotFound	Required input param is not found.
400	Parameters.Invalid	Parameter error, please check the parameters.
400	BackupPolicyNotSupport	Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.
400	InvalideStatus.Format	The instance status does not support this operation.
400	InvalidReleasedKeepPolicy.Format	Specified Released Keep Policy is not valid.
400	InvalidDBInstanceEngineType.Format	the DB instance engine type does not support this operation.
400	Pay.NoCreditCard	No credit cards.
400	VpcNetworkTypeNotSupport	The vpc network type instance does not support this operation.
400	MirrorInsExists	Specified DB instance mirror ins already existed.
400	UnsupportedClassCode	The specified DB instance class stops selling.
400	InvalidBackupSet	The specified database does not exist in the backup set.
400	OrdTCommodityQueryError	Failed to query for product.
400	ProductInstanceReleased	The instance has been released. Please check before placing the order.
400	RegionEndTimeDissolvedIndia	The region is no longer supported.
400	InvalidRequest	Invalid Request.
500	ExternalFailure	The request processing has failed due to external service failure.
500	RequestMetaDataFailed	The service request failed. Please try again later or contact service personnel.
500	InvokeProxyFailure	The request processing has failed due to service failure of rds api.
403	OrderStatus.UnPaid	The specified db instance has unpaid order.
403	InvalidReduceDiskSize	The storage capacity after the scale-down must be larger than the used amount.
403	CloudSSDNotSupport	Cloud ssd does not support this operation, please upgrade to essd.
403	InvalidUserOperatorPermission	The user permission does not support this operation.
403	InvalidVswitchId	Specified conn vswitch id is not valid.
403	IncorrectMinorVersion	Current engine minor version does not support operations.
403	OperationDenied.ZoneResource	There is no available zone for inventory.
403	NotInFlowController	Sorry,no permission.
403	InvalidKmsKey	Kms key is disabled.
403	InvalidInstanceLevel.Malformed	Current DB instance level does not support this operation.
404	InvalidClusterKms	The current instance does not authorized to access the Key Management Service.
404	Request.NotFound	The requested resource is not available.
404	HostInfo.NotFound	The specified host info is not found.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.