Referensi & Parameter API DescribeScheduleTasks-PolarDB-Alibaba Cloud - PolarDB

Mengambil detail semua Tugas terjadwal.

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

polardb:DescribeScheduleTasks

get

*DBCluster

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
Status	string	No	Status Tugas. Nilai valid: pending: Tugas menunggu untuk dijalankan. executing: Tugas sedang dijalankan. failure: Tugas gagal dan menunggu percobaan ulang. finish: Tugas selesai. cancel: Tugas dibatalkan. expired: Tugas telah kedaluwarsa karena tidak dimulai dalam jendela pengatur waktu terjadwal. rollback: Tugas sedang di-rollback. Catatan Jika parameter ini dihilangkan, Tugas terjadwal di semua status akan dikueri.	finish
DBClusterId	string	No	ID Kluster. Catatan Anda dapat memanggil operasi DescribeDBClusters untuk mengkueri detail semua Kluster di Wilayah tertentu, termasuk ID Kluster. Jika parameter ini dihilangkan, Tugas terjadwal untuk semua Kluster di akun Anda akan dikueri.	pc-**************
RegionId	string	No	ID Wilayah. Catatan Anda dapat memanggil operasi DescribeRegions untuk mengkueri Wilayah yang tersedia. Jika parameter ini dihilangkan, Tugas terjadwal di semua Wilayah di akun Anda akan dikueri.	cn-hangzhou
PageNumber	integer	No	Nomor halaman yang akan dikembalikan. Nilai harus berupa bilangan bulat yang lebih besar dari 0. Nilai default: 1.	1
PageSize	integer	No	Jumlah entri yang akan dikembalikan pada setiap halaman. Nilai valid: 30 (default), 50, dan 100.	30
TaskAction	string	No	Aksi Tugas terjadwal. Nilai valid: CreateDBNodes ModifyDBNodeClass UpgradeDBClusterVersion ModifyDBClusterPrimaryZone Catatan Detail Tugas hanya dikembalikan jika Anda menentukan parameter `PlannedStartTime` saat memanggil salah satu operasi API di atas. Jika tidak, bidang `TimerInfos` di tanggapan akan kosong. Jika parameter ini dihilangkan, Tugas terjadwal dari semua tipe akan dikueri.	CreateDBNodes
DBClusterDescription	string	No	Deskripsi Kluster.	testdb
OrderId	string	No	ID Pesanan. Catatan ID Pesanan hanya boleh berisi angka.	20951253014****
PlannedStartTime	string	No	Waktu mulai paling awal dari Tugas. Pengatur waktu dalam UTC.	2021-01-28T12:00Z
PlannedEndTime	string	No	Waktu mulai paling akhir dari Tugas. Pengatur waktu dalam UTC. Jika Tugas tidak dimulai pada pengatur waktu ini, maka akan kedaluwarsa.	2021-01-28T12:30Z
ResourceGroupId	string	No	ID kelompok sumber daya.	rg-************

Elemen respons

Element	Type	Description	Example
	object
Data	object	The result set.
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	30
TimerInfos	array<object>	Details of scheduled tasks.
	object
Action	string	The task type.	CreateDBNodes
CrontabJobId	string	The ID of the scheduled O&M task.	86293c29-a03d-4872-b625-***********
DBClusterId	string	The cluster ID.	pc-**************
DbClusterDescription	string	The cluster description.	test_cluster
DbClusterStatus	string	The cluster status.	Running
OrderId	string	The order ID. Catatan This parameter is returned only when `Action` is set to CreateDBNodes or ModifyDBNodeClass.	208161753******
PlannedEndTime	string	The latest start time of the task. The time is in UTC.	2021-01-28T12:30Z
PlannedFlashingOffTime	string		2021-01-28T12:30Z
PlannedStartTime	string	The earliest start time of the task. The time is in UTC.	2021-01-28T12:00Z
PlannedTime	string	The expected start time of the task. The time is in UTC.	2021-01-28T12:16Z
Region	string	The region ID of the scheduled task.	cn-hangzhou
Status	string	The status of the task.	finish
TaskCancel	boolean	Indicates whether the scheduled task can be canceled. Valid values: true: The task can be canceled. false: The task cannot be canceled.	true
TaskId	string	The task ID.	53879cdb-9a00-428e-acaf-ff4cff******
TotalRecordCount	integer	The total number of entries.	1
Message	string	The response message. Catatan If the request is successful, Successful is returned. Otherwise, an error message is returned.	Successful
RequestId	string	The request ID.	936C7025-27A5-4CB1-BB31-540E1F0CCA12
Success	boolean	Indicates whether the request was successful.	true

Contoh

Respons sukses

JSONformat

{
  "Data": {
    "PageNumber": 1,
    "PageSize": 30,
    "TimerInfos": [
      {
        "Action": "CreateDBNodes",
        "CrontabJobId": "86293c29-a03d-4872-b625-***********",
        "DBClusterId": "pc-**************",
        "DbClusterDescription": "test_cluster",
        "DbClusterStatus": "Running",
        "OrderId": "208161753******",
        "PlannedEndTime": "2021-01-28T12:30Z",
        "PlannedFlashingOffTime": "2021-01-28T12:30Z",
        "PlannedStartTime": "2021-01-28T12:00Z",
        "PlannedTime": "2021-01-28T12:16Z",
        "Region": "cn-hangzhou",
        "Status": "finish",
        "TaskCancel": true,
        "TaskId": "53879cdb-9a00-428e-acaf-ff4cff******"
      }
    ],
    "TotalRecordCount": 1
  },
  "Message": "Successful",
  "RequestId": "936C7025-27A5-4CB1-BB31-540E1F0CCA12",
  "Success": true
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	InvalidOrderId.Malformed	The specified parameter OrderId is not valid.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.