DescribePlanMaintenanceWindows - Elastic Compute Service

Mengkueri jendela O&M.

Deskripsi operasi

Mengkueri kebijakan pemeliharaan yang dikonfigurasi. Setiap kebijakan berisi dua properti pemeliharaan:

Jendela pengatur waktu pemeliharaan: Periode pengatur waktu yang Anda tentukan untuk menjalankan operasi O&M.
Aksi pemeliharaan: Kebijakan penanganan instans mati yang Anda tentukan.

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

ecs:DescribePlanMaintenanceWindows

list

*All Resources

*

None

Sintaks permintaan

GET  HTTP/1.1

Parameter permintaan

Parameter	Type	Required	Description	Example
Enable	boolean	No	Apakah jendela diaktifkan atau dinonaktifkan.	true
RegionId	string	Yes	ID wilayah instans. Anda dapat memanggil DescribeRegions untuk mengkueri daftar wilayah terbaru.	cn-hangzhou
PlanWindowId	string	No	ID jendela O&M.	pw-bp1jarob1aup7yvlrdt6
PlanWindowName	string	No	Nama jendela O&M.	WIndowName
TargetResourceGroupId	string	No	ID kelompok sumber daya tempat jendela O&M berlaku.	rg-d85g5yocioezmdrll
TargetResourceTags	object	No	Tag tempat jendela O&M berlaku.
Value	string	No	Nilai tag tempat jendela berlaku.	tagValue
Key	string	No	Kunci tag tempat jendela berlaku.	tagKey
NextToken	string	No	Token paginasi. Atur parameter ini ke nilai NextToken yang dikembalikan dalam pemanggilan API sebelumnya.	AAAAAdDWBF2
MaxResults	integer	No	Jumlah entri per halaman untuk kueri terpaginasi. Nilai maksimum: 100. Nilai default: Jika nilai tidak ditentukan atau kurang dari 10, nilai default adalah 10. Jika nilai lebih dari 100, nilai default adalah 100.	10

Elemen respons

Element	Type	Description	Example
	object	Skema Respons.
TotalCount	integer	Jumlah total entri yang sesuai dengan kondisi kueri. Parameter ini bersifat opsional dan mungkin tidak dikembalikan secara default.	1
RequestId	string	ID permintaan.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
PlanMaintenanceWindowList	array<object>	pengatur waktu pembuatan.
	array<object>	Jenis target. Nilai valid: Tag ResourceGroup Instance AliUid.
PlanWindowId	string	ID jendela O&M.	pw-bp1bqkbjb7h4j8zqzwvp
PlanWindowName	string	Nama jendela O&M.	WindowName
Enable	boolean	Apakah jendela O&M diaktifkan.	true
SupportMaintenanceAction	string	Aksi pemeliharaan yang didukung.	Reboot
CreateTime	string	pengatur waktu pembuatan jendela O&M. pengatur waktu mengikuti standar ISO 8601 dalam UTC. Format: yyyy-MM-ddTHH:mm:ssZ.	2025-04-11T02:20:41Z
ModifiedTime	string	pengatur waktu terakhir jendela O&M dimodifikasi. pengatur waktu mengikuti standar ISO 8601 dalam UTC. Format: yyyy-MM-ddTHH:mm:ssZ.	2025-02-22 10:14:28 +0800
TimePeriod	object	Siklus pengulangan jendela.
PeriodUnit	string	Jenis periode. Daily menunjukkan pengulangan harian. Weekly menunjukkan pengulangan mingguan.	Year
RangeList	array<object>	Rentang waktu dari periode pengulangan jendela pemeliharaan (dalam zona waktu UTC).
	object
StartTime	string	Waktu mulai dari jendela pemeliharaan.	Monday,22:00
EndTime	string	Waktu berakhir dari jendela pemeliharaan.	Monday,22:00
TargetResource	object	Sumber daya tempat jendela O&M berlaku.
Scope	string	Jenis sumber daya yang dikonfigurasi untuk jendela pemeliharaan.	Tag
ResourceGroupId	string	ID dari grup sumber daya tempat jendela pemeliharaan berlaku.	rg-aek2qxeteo7fr6y
Tags	array<object>	Tag tempat jendela pemeliharaan berlaku.
	object
Key	string	Kunci tag.	tagKey
Value	string	Nilai tag.	tagValue
MinMaintenanceInterval	integer
NextToken	string	Token kueri yang dikembalikan oleh panggilan ini.	AAAAAdDWBF2
MaxResults	integer	Jumlah entri per halaman untuk kueri terpaginasi. Nilai maksimum: 100. Nilai default: Jika nilai tidak ditentukan atau kurang dari 10, nilai default adalah 10. Jika nilai lebih dari 100, nilai default adalah 100.	10

Contoh

Respons sukses

JSONformat

{
  "TotalCount": 1,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "PlanMaintenanceWindowList": [
    {
      "PlanWindowId": "pw-bp1bqkbjb7h4j8zqzwvp",
      "PlanWindowName": "WindowName",
      "Enable": true,
      "SupportMaintenanceAction": "Reboot",
      "CreateTime": "2025-04-11T02:20:41Z",
      "ModifiedTime": "2025-02-22 10:14:28 +0800",
      "TimePeriod": {
        "PeriodUnit": "Year",
        "RangeList": [
          {
            "StartTime": "Monday,22:00",
            "EndTime": "Monday,22:00"
          }
        ]
      },
      "TargetResource": {
        "Scope": "Tag",
        "ResourceGroupId": "rg-aek2qxeteo7fr6y",
        "Tags": [
          {
            "Key": "tagKey",
            "Value": "tagValue"
          }
        ]
      }
    }
  ],
  "NextToken": "AAAAAdDWBF2",
  "MaxResults": 10
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
500	InternalError	Internal error.	Terjadi kesalahan yang tidak diketahui.
403	AccessForbidden	User not authorized to operate on the specified resource.	Anda tidak diizinkan untuk menggunakan sumber daya yang ditentukan.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.