DescribeHistoryTasks - Tair (Redis® OSS-Compatible) - Alibaba Cloud Documentation Center

Mengkueri daftar tugas di pusat tugas.

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

kvstore:DescribeHistoryTasks

get

*全部资源

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	No	ID wilayah event tertunda. Anda dapat memanggil DescribeRegions untuk mengkueri ID wilayah.	cn-beijing
PageSize	integer	No	Jumlah rekaman per halaman. Nilai valid: 10 hingga 100. Nilai default: 10.	10
PageNumber	integer	No	Nomor halaman hasil kueri. Nilai valid: bilangan bulat positif. Nilai default: 1.	1
InstanceType	string	No	Tipe instans. Nilai tetap adalah Instance.	Instance
Status	string	No	Status tugas. Digunakan untuk memfilter tugas dengan status yang sesuai: Scheduled: menunggu eksekusi Running: sedang dieksekusi Succeed: berhasil dieksekusi Failed: eksekusi gagal Cancelling: sedang dihentikan Canceled: dihentikan Waiting: menunggu waktu yang telah ditetapkan Catatan Nilai default kosong, menunjukkan bahwa semua status dipilih. Untuk memilih beberapa status, pisahkan dengan koma (,).	Scheduled
InstanceId	string	No	ID instans. Digunakan untuk mengkueri tugas dari instans yang sesuai. Nilai default kosong, menunjukkan tidak ada batasan. Untuk mengkueri beberapa instans, pisahkan ID instans dengan koma (,). Mendukung maksimum 30 ID instans.	r-uf62br2491p5l****
TaskId	string	No	ID tugas. Digunakan untuk mengkueri tugas dengan ID yang diketahui. Nilai default kosong, menunjukkan tidak ada batasan. Untuk mengkueri beberapa tugas, pisahkan ID tugas dengan koma (,). Mendukung maksimum 30 ID tugas.	t-83br18hloy3faf****
TaskType	string	No	Tipe tugas. Digunakan untuk mengkueri tugas dengan tipe tertentu. Nilai default kosong, menunjukkan tidak ada batasan. Nilai valid: ModifyInsSpec: perubahan spesifikasi atau migrasi DeleteInsNode: menghapus shard AddInsNode: menambahkan shard HaSwitch: alih bencana master-replika instans RestartIns: memulai ulang instans CreateIns: membuat instans ModifyInsConfig: perubahan konfigurasi Catatan Untuk mengkueri beberapa tipe tugas, pisahkan dengan koma (,).	ModifyInsSpec
FromStartTime	string	Yes	Waktu mulai paling awal dari tugas yang akan dikueri. Format: yyyy-MM-ddTHH:mm:ssZ (waktu UTC). Data dalam 30 hari terakhir dapat dikueri paling awal.	2022-01-02T11:31:03Z
ToStartTime	string	Yes	Waktu mulai paling akhir dari tugas yang akan dikueri. Format: yyyy-MM-ddTHH:mm:ssZ (waktu UTC). Nilai harus lebih lambat daripada waktu mulai paling awal tugas.	2022-02-02T11:31:03Z
FromExecTime	integer	No	Durasi eksekusi tugas minimum. Digunakan untuk memfilter tugas yang durasi eksekusinya lebih besar dari nilai ini, dalam detik. Nilai default: 0, menunjukkan tidak ada batasan.	0
ToExecTime	integer	No	Durasi eksekusi tugas maksimum. Digunakan untuk memfilter tugas yang durasi eksekusinya tidak kurang dari nilai ini, dalam detik. Nilai default: 0, menunjukkan tidak ada batasan.	0

Elemen respons

Element	Type	Description	Example
	object
PageNumber	integer	Nomor halaman yang sedang ditampilkan.	1
RequestId	string	ID permintaan.	5D622714-AEDD-4609-9167-F5DDD3D1****
PageSize	integer	Jumlah maksimum rekaman yang ditampilkan per halaman.	10
TotalCount	integer	Jumlah total tugas yang sesuai dengan kondisi kueri, tanpa memperhitungkan paginasi.	5
Items	array<object>	Daftar objek tugas.
	object	Objek tugas, dalam format kamus.
Status	string	Status tugas. Scheduled: menunggu eksekusi Running: sedang dieksekusi Succeed: berhasil dieksekusi Failed: eksekusi gagal Cancelling: sedang dihentikan Canceled: dihentikan Waiting: menunggu waktu yang telah ditetapkan.	Running
TaskId	string	ID tugas.	t-83br18hloy3faf****
CurrentStepName	string	Nama langkah yang sedang dieksekusi. Jika kosong, tugas belum dimulai.	exec_task
StartTime	string	Waktu mulai tugas. Format: yyyy-MM-ddTHH:mm:ssZ (waktu UTC).	2022-02-03T11:31:03Z
EndTime	string	Waktu akhir tugas. Format: yyyy-MM-ddTHH:mm:ssZ (waktu UTC).	2022-02-03T12:06:17Z
TaskType	string	Tipe tugas. ModifyInsSpec: perubahan spesifikasi atau migrasi DeleteInsNode: menghapus shard AddInsNode: menambahkan shard HaSwitch: alih bencana master-replika instans RestartIns: memulai ulang instans CreateIns: membuat instans ModifyInsConfig: perubahan konfigurasi.	ModifyInsSpec
RemainTime	integer	Perkiraan sisa waktu eksekusi, dalam detik. 0 menunjukkan bahwa eksekusi telah selesai.	1000
Progress	number	Progres saat ini, dalam rentang [0,100].	79.0
RegionId	string	ID wilayah.	cn-shanghai
InstanceType	string	Tipe instans. Nilai tetap adalah Instance.	Instance
InstanceId	string	ID instans.	r-bp1zxszhcgatnx****
InstanceName	string	Nama instans.	dba-tair-test-qcloud
DbType	string	Tipe DB. Nilai tetap adalah redis.	redis
Product	string	Produk. Nilai tetap adalah kvstore.	kvstore
TaskDetail	string	Detail tugas. taskType yang berbeda menghasilkan output yang berbeda.	{\"callerUid\":\"test\"}
ReasonCode	string	Alasan memulai tugas saat ini.	小版本升级
ActionInfo	string	Informasi operasi yang diizinkan. Dalam penggunaan aktual, operasi Action dicocokkan dalam informasi ini berdasarkan currentStepName+status. Jika tidak ada Action yang dicocokkan, status tugas saat ini tidak mendukung operasi apa pun. Contoh: `{"steps": [ { "step_name": "exec_task", // nama langkah, cocok dengan currentStepName "action_info": { // operasi yang didukung oleh langkah "Waiting": [ // status, cocok dengan status "modifySwitchTime" // operasi Action; dapat terdapat beberapa aksi, menunjukkan beberapa operasi yang didukung ] } }, { "step_name": "init_task", // nama langkah "action_info": { // operasi yang didukung oleh langkah "Running": [ // status "cancel", // operasi "pause" ] } } ] }` Operasi yang mungkin didukung oleh sistem: retry: coba ulang cancel: batalkan modifySwitchTime: mengubah waktu pengalihan atau waktu pemulihan.	{"steps":[{"action_info":{"Waiting":["modifySwitchTime"]},"step_name":"exec_task"}]}
Uid	string	ID pengguna tempat sumber daya berada.	141345906006****
CallerSource	string	ID pengguna yang meminta. Ketika callerSource adalah User, ini mewakili UID pengguna.	141345906006****
CallerUid	string	Sumber permintaan. System: otomatis oleh sistem User: pengguna.	User

Contoh

Respons sukses

JSONformat

{
  "PageNumber": 1,
  "RequestId": "5D622714-AEDD-4609-9167-F5DDD3D1****",
  "PageSize": 10,
  "TotalCount": 5,
  "Items": [
    {
      "Status": "Running",
      "TaskId": "t-83br18hloy3faf****",
      "CurrentStepName": "exec_task",
      "StartTime": "2022-02-03T11:31:03Z",
      "EndTime": "2022-02-03T12:06:17Z",
      "TaskType": "ModifyInsSpec",
      "RemainTime": 1000,
      "Progress": 79,
      "RegionId": "cn-shanghai",
      "InstanceType": "Instance",
      "InstanceId": "r-bp1zxszhcgatnx****",
      "InstanceName": "dba-tair-test-qcloud",
      "DbType": "redis",
      "Product": "kvstore",
      "TaskDetail": "{\\\"callerUid\\\":\\\"test\\\"}",
      "ReasonCode": "小版本升级",
      "ActionInfo": "{\"steps\":[{\"action_info\":{\"Waiting\":[\"modifySwitchTime\"]},\"step_name\":\"exec_task\"}]}",
      "Uid": "141345906006****",
      "CallerSource": "141345906006****",
      "CallerUid": "User"
    }
  ]
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	Param.Invalid	Param invalid
400	Param.Invalid.TimeEndBeforeStart	Param invalid. End time before start time

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.