DescribeScheduleTasks - 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 yang valid: pending: Tugas sedang menunggu untuk dieksekusi. executing: Tugas sedang dieksekusi. failure: Tugas gagal dan menunggu percobaan ulang. finish: Tugas telah selesai. cancel: Tugas dibatalkan. expired: Tugas telah kedaluwarsa. Artinya, tugas tidak dimulai dalam jendela waktu yang dijadwalkan. rollback: Tugas sedang dikembalikan (rollback). Catatan Jika Anda tidak menentukan parameter ini, tugas terjadwal dalam semua status akan dikembalikan.	finish
DBClusterId	string	No	ID kluster. Catatan Panggil operasi DescribeDBClusters untuk menanyakan detail semua kluster di suatu wilayah, termasuk ID kluster tersebut. Jika Anda tidak menentukan parameter ini, tugas terjadwal dari semua kluster yang termasuk dalam akun Anda akan dikembalikan.	pc-**************
RegionId	string	No	ID wilayah. Catatan Panggil operasi DescribeRegions untuk menanyakan wilayah yang tersedia. Jika Anda tidak menentukan parameter ini, tugas terjadwal di semua wilayah yang termasuk dalam akun Anda akan dikembalikan.	cn-hangzhou
PageNumber	integer	No	Nomor halaman. Nilainya harus berupa bilangan bulat yang lebih besar dari 0. Nilai default: 1.	1
PageSize	integer	No	Jumlah entri yang dikembalikan per halaman. Nilai yang valid: 30 (default), 50, atau 100.	30
TaskAction	string	No	Jenis tugas. Nilai yang valid: CreateDBNodes ModifyDBNodeClass UpgradeDBClusterVersion ModifyDBClusterPrimaryZone Catatan Detail tugas hanya dikembalikan jika Anda menentukan parameter `PlannedStartTime`. Jika tidak, parameter `TimerInfos` akan kosong. Jika Anda tidak menentukan parameter ini, tugas terjadwal dari semua jenis akan dikembalikan.	CreateDBNodes
DBClusterDescription	string	No	Deskripsi kluster.	testdb
OrderId	string	No	ID pesanan. Catatan ID hanya boleh berisi angka dari 0 hingga 9.	20951253014****
PlannedStartTime	string	No	Waktu mulai paling awal dari tugas. Waktu dalam UTC.	2021-01-28T12:00Z
PlannedEndTime	string	No	Waktu mulai paling akhir dari tugas. Waktu dalam UTC.	2021-01-28T12:30Z
ResourceGroupId	string	No	ID kelompok sumber daya.	rg-************

Elemen respons

Element	Type	Description	Example
	object
Data	object	Data respons.
PageNumber	integer	Nomor halaman.	1
PageSize	integer	Jumlah entri pada halaman saat ini.	30
TimerInfos	array<object>	Detail tugas terjadwal.
	object
Action	string	Jenis tugas.	CreateDBNodes
CrontabJobId	string	ID tugas O&M terjadwal.	86293c29-a03d-4872-b625-***********
DBClusterId	string	ID kluster.	pc-**************
DbClusterDescription	string	Deskripsi kluster.	test_cluster
DbClusterStatus	string	Status kluster.	Running
OrderId	string	ID pesanan. Catatan Parameter ini hanya dikembalikan ketika `Action` diatur ke CreateDBNodes atau ModifyDBNodeClass.	208161753******
PlannedEndTime	string	Waktu mulai paling akhir dari tugas. Waktu dalam UTC.	2021-01-28T12:30Z
PlannedFlashingOffTime	string
PlannedStartTime	string	Waktu mulai paling awal dari tugas. Waktu dalam UTC.	2021-01-28T12:00Z
PlannedTime	string	Waktu mulai yang diharapkan dari tugas. Waktu dalam UTC.	2021-01-28T12:16Z
Region	string	ID wilayah dari tugas terjadwal.	cn-hangzhou
Status	string	Status tugas.	finish
TaskCancel	boolean	Menunjukkan apakah tugas terjadwal dapat dibatalkan. Nilai yang valid: true: Tugas dapat dibatalkan. false: Tugas tidak dapat dibatalkan.	true
TaskId	string	ID tugas.	53879cdb-9a00-428e-acaf-ff4cff******
TotalRecordCount	integer	Jumlah total entri.	1
Message	string	Pesan respons. Catatan Jika permintaan berhasil, "Successful" dikembalikan. Jika permintaan gagal, pesan error dikembalikan.	Successful
RequestId	string	ID permintaan.	936C7025-27A5-4CB1-BB31-540E1F0CCA12
Success	boolean	Menunjukkan apakah permintaan berhasil.	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": "",
        "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.