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

Menampilkan daftar task di pusat task.

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. Anda dapat memanggil operasi DescribeRegions untuk mengambil daftar wilayah terbaru.	cn-beijing
PageSize	integer	No	Jumlah entri per halaman. Nilai yang valid: 10 hingga 100. Nilai default: 10.	10
PageNumber	integer	No	Nomor halaman. Halaman dimulai dari halaman 1. Nilai default: 1.	1
InstanceType	string	No	Tetapkan nilainya ke Instance.	Instance
Status	string	No	Status task. Nilai yang valid: Scheduled Running Succeed Failed Cancelling Canceled Waiting Catatan Parameter ini kosong secara default, yang berarti semua status task akan ditampilkan. Pisahkan beberapa status dengan koma (,).	Scheduled
InstanceId	string	No	ID instans. Parameter ini kosong secara default, yang berarti Anda dapat menentukan sejumlah ID instans tanpa batas. Pisahkan beberapa ID instans dengan koma (,). Anda dapat menentukan hingga 30 ID instans.	r-uf62br2491p5l****
TaskId	string	No	ID task. Parameter ini kosong secara default, yang berarti Anda dapat menentukan sejumlah ID task tanpa batas. Pisahkan beberapa ID task dengan koma (,). Anda dapat menentukan hingga 30 ID task.	t-83br18hloy3faf****
TaskType	string	No	Jenis task. Parameter ini kosong secara default, yang berarti Anda dapat menentukan sejumlah jenis task tanpa batas. ModifyInsSpec DeleteInsNode AddInsNode HaSwitch RestartIns CreateIns ModifyInsConfig Catatan Pisahkan beberapa jenis task dengan koma (,).	ModifyInsSpec
FromStartTime	string	Yes	Awal rentang waktu untuk kueri. Tentukan waktu dalam standar ISO 8601 dengan format yyyy-MM-ddTHH:mm:ssZ. Waktu harus dalam UTC. Waktu mulai dapat paling awal 30 hari sebelum waktu saat ini.	2022-01-02T11:31:03Z
ToStartTime	string	Yes	Akhir rentang waktu untuk kueri. Tentukan waktu dalam standar ISO 8601 dengan format yyyy-MM-ddTHH:mm:ssZ. Waktu harus dalam UTC. Hanya task yang memiliki waktu mulai lebih awal dari atau sama dengan waktu yang ditentukan oleh parameter ini yang akan ditampilkan.	2022-02-02T11:31:03Z
FromExecTime	integer	No	Durasi eksekusi minimum sebuah task. Parameter ini digunakan untuk memfilter task yang durasi eksekusinya lebih lama dari durasi minimum tersebut. Satuan: detik. Nilai default adalah 0, yang berarti tidak ada batasan.	0
ToExecTime	integer	No	Durasi eksekusi maksimum sebuah task. Parameter ini digunakan untuk memfilter task yang durasi eksekusinya lebih pendek dari atau sama dengan durasi maksimum tersebut. Satuan: detik. Nilai default adalah 0, yang berarti tidak ada batasan.	0

Elemen respons

Element	Type	Description	Example
	object
PageNumber	integer	Nomor halaman yang dikembalikan.	1
RequestId	string	ID permintaan.	5D622714-AEDD-4609-9167-F5DDD3D1****
PageSize	integer	Jumlah maksimum entri yang dikembalikan per halaman.	10
TotalCount	integer	Jumlah total task yang memenuhi kriteria ini tanpa mempertimbangkan paginasi.	5
Items	array<object>	Objek task yang diambil dari kueri.
	object
Status	string	Status task. Scheduled Running Succeed Failed Cancelling Canceled Waiting	Running
TaskId	string	ID task.	t-83br18hloy3faf****
CurrentStepName	string	Nama langkah saat ini. Jika parameter ini kosong, task belum dimulai.	exec_task
StartTime	string	Waktu mulai task. Waktu mengikuti standar ISO 8601 dalam format yyyy-MM-ddTHH:mm:ssZ. Waktu ditampilkan dalam UTC.	2022-02-03T11:31:03Z
EndTime	string	Waktu selesai task. Waktu mengikuti standar ISO 8601 dalam format yyyy-MM-ddTHH:mm:ssZ. Waktu ditampilkan dalam UTC.	2022-02-03T12:06:17Z
TaskType	string	Jenis task. ModifyInsSpec DeleteInsNode AddInsNode HaSwitch RestartIns CreateIns ModifyInsConfig	ModifyInsSpec
RemainTime	integer	Perkiraan sisa waktu untuk menyelesaikan task. Satuan: detik. Nilai 0 menunjukkan bahwa task telah selesai.	1000
Progress	number	Progres task. Nilai yang valid: 0 hingga 100.	79.0
RegionId	string	ID wilayah.	cn-shanghai
InstanceType	string	Tipe instans. Nilai kembali adalah Instance.	Instance
InstanceId	string	ID instans.	r-bp1zxszhcgatnx****
InstanceName	string	Nama instans.	dba-tair-test-qcloud
DbType	string	Jenis database. Nilai kembali adalah redis.	redis
Product	string	Produk. Nilai kembali adalah kvstore.	kvstore
TaskDetail	string	Detail task. Detailnya bervariasi tergantung jenis task.	{\"callerUid\":\"test\"}
ReasonCode	string	Alasan mengapa task saat ini diinisiasi.	小版本升级
ActionInfo	string	Kumpulan aksi yang diperbolehkan yang dapat dilakukan pada task. Sistem mencocokkan nama langkah saat ini dan status task dengan aksi yang tersedia yang ditentukan oleh ActionInfo. Jika tidak ditemukan aksi yang cocok, status task saat ini tidak mendukung aksi apa pun. Contoh: `{"steps": [ { "step_name": "exec_task", // Nama langkah, yang sesuai dengan CurrentStepName. "action_info": { // Aksi yang didukung untuk langkah ini. "Waiting": [ // Status, yang sesuai dengan Status. "modifySwitchTime" // Aksi. Beberapa aksi didukung. ] } }, { "step_name": "init_task", // Nama langkah. "action_info": { // Aksi yang didukung untuk langkah ini. "Running": [ // Status. "cancel", // Aksi. "pause" ] } } ] }` Sistem mungkin mendukung aksi berikut: retry cancel modifySwitchTime: mengubah waktu switching atau pemulihan.	{"steps":[{"action_info":{"Waiting":["modifySwitchTime"]},"step_name":"exec_task"}]}
Uid	string	ID pengguna yang memiliki sumber daya tersebut.	141345906006****
CallerSource	string	ID pengguna yang membuat permintaan. Jika CallerSource diatur ke User, CallerUid menunjukkan ID unik (UID) pengguna tersebut.	141345906006****
CallerUid	string	Sumber permintaan. Nilai yang valid: System User	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.