Gunakan DescribeMetricRuleBlackList API untuk mengkueri kebijakan blacklist - Cloud Monitor - Alibaba Cloud - Cloud Monitor

Mengkueri daftar kebijakan blacklist alert.

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

cms:DescribeMetricRuleBlackList

list

*全部资源

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
Namespace	string	No	Namespace layanan Alibaba Cloud. Untuk informasi tentang namespace layanan Alibaba Cloud, lihat Metrik layanan cloud.	acs_ecs_dashboard
PageNumber	integer	No	Nomor halaman saat ini. Nilai default: 1.	1
PageSize	integer	No	Jumlah entri per halaman. Nilai default: 10.	100
Order	integer	No	Urutan pengurutan hasil kueri berdasarkan waktu. Nilai valid: DESC (default): urutan menurun. ASC: urutan menaik.	DESC
Category	string	No	Kategori layanan Alibaba Cloud. Misalnya, Redis memiliki `kvstore_standard` (Edisi Standar), `kvstore_sharding` (Edisi Kluster), dan `kvstore_splitrw` (Edisi read/write splitting).	ecs
Ids	array	No	ID kebijakan blacklist alert.
	string	No	ID kebijakan blacklist alert.	a9ad2ac2-3ed9-11ed-b878-0242ac12****
Name	string	No	Nama kebijakan blacklist alert. Parameter ini mendukung pencocokan kabur.	Blacklist-01
ScopeType	string	No	Cakupan efektif kebijakan blacklist alert. Nilai valid: USER: Kebijakan blacklist alert hanya berlaku dalam akun Alibaba Cloud saat ini. GROUP: Kebijakan blacklist alert berlaku dalam kelompok aplikasi yang ditentukan.	USER
IsEnable	boolean	No	Status kebijakan blacklist alert. Nilai valid: true: diaktifkan. false: dinonaktifkan.	true
InstanceIds	array	No	ID instans dalam kebijakan blacklist alert. Nilai valid N: 0 hingga 10.
	string	No	ID instans dalam kebijakan blacklist alert.	i-2ze2d6j5uhg20x47****

Untuk informasi lebih lanjut tentang parameter permintaan umum, lihat Parameter umum.

Elemen respons

Element	Type	Description	Example
	object	Tidak ada.
Code	string	Kode status. Catatan Nilai 200 menunjukkan keberhasilan.	200
Message	string	Pesan error.	The Request is not authorization.
RequestId	string	ID permintaan.	D63E76CB-29AA-5B9F-88CE-400A6F28D428
Total	integer	Jumlah total kebijakan blacklist alert.	1
Success	boolean	Apakah operasi berhasil. Nilai valid: true: berhasil. false: gagal.	true
DescribeMetricRuleBlackList	array<object>	Kebijakan blacklist alert.
	array<object>	Kebijakan blacklist alert.
EffectiveTime	string	Periode efektif kebijakan blacklist alert.	00:00-23:59
UpdateTime	string	Stempel waktu ketika kebijakan blacklist alert terakhir diubah. Unit: milidetik.	1665718373000
CreateTime	string	Stempel waktu ketika kebijakan blacklist alert dibuat. Unit: milidetik.	1665714561000
ScopeType	string	Cakupan efektif kebijakan blacklist alert. Nilai valid: USER: Kebijakan blacklist alert hanya berlaku dalam akun Alibaba Cloud saat ini. GROUP: Kebijakan blacklist alert berlaku dalam kelompok aplikasi yang ditentukan.	USER
IsEnable	boolean	Status kebijakan blacklist alert. Nilai valid: true: diaktifkan. false: dinonaktifkan.	true
Namespace	string	Namespace layanan Alibaba Cloud.	acs_ecs_dashboard
Category	string	Kategori layanan Alibaba Cloud. Misalnya, Redis memiliki `kvstore_standard` (Edisi Standar), `kvstore_sharding` (Edisi Kluster), dan `kvstore_splitrw` (Edisi read/write splitting).	ecs
EnableEndTime	integer	Stempel waktu mulai kebijakan blacklist alert. Unit: milidetik.	1640608200000
Name	string	Nama kebijakan blacklist alert.	Blacklist-01
EnableStartTime	integer	Stempel waktu akhir kebijakan blacklist alert. Unit: milidetik.	1640237400000
Id	string	ID kebijakan blacklist alert.	93514c96-ceb8-47d8-8ee3-93b6d98b****
Metrics	array<object>	Metrik pemantauan instans.
	object	Metrik pemantauan instans.
Resource	string	The extended dimension of the instance. For example, `{"device":"C:"}` means that the blacklist policy is applied to all C drives of an Elastic Compute Service (ECS) instance.	[{"device":"C:"}]
MetricName	string	The name of the metric.	disk_utilization
Instances	array	Instans dari layanan Alibaba Cloud yang ditentukan dalam kebijakan blacklist alert.
	string	Instans dari layanan Alibaba Cloud yang ditentukan dalam kebijakan blacklist alert.	i-rj99xc6cptkk64ml****
ScopeValue	array	ID kelompok aplikasi.
	string	ID kelompok aplikasi. Nilainya dalam format JSON Array. Catatan Parameter ini hanya dikembalikan jika `ScopeType` diatur ke `GROUP`.	["67**","78**"]

Contoh

Respons sukses

JSONformat

{
  "Code": "200",
  "Message": "The Request is not authorization.",
  "RequestId": "D63E76CB-29AA-5B9F-88CE-400A6F28D428",
  "Total": 1,
  "Success": true,
  "DescribeMetricRuleBlackList": [
    {
      "EffectiveTime": "00:00-23:59",
      "UpdateTime": "1665718373000",
      "CreateTime": "1665714561000",
      "ScopeType": "USER",
      "IsEnable": true,
      "Namespace": "acs_ecs_dashboard",
      "Category": "ecs",
      "EnableEndTime": 1640608200000,
      "Name": "Blacklist-01",
      "EnableStartTime": 1640237400000,
      "Id": "93514c96-ceb8-47d8-8ee3-93b6d98b****",
      "Metrics": [
        {
          "Resource": "[{\"device\":\"C:\"}]",
          "MetricName": "disk_utilization"
        }
      ],
      "Instances": [
        "i-rj99xc6cptkk64ml****"
      ],
      "ScopeValue": [
        "[\"67****\",\"78****\"]"
      ]
    }
  ]
}

Kode kesalahan

HTTP status code	Error code	Error message
400	ParameterInvalid	Illegal parameters.
500	InternalError	The request processing has failed due to some unknown error.
403	AccessForbidden	User not authorized to operate on the specified resource.
404	ResourceNotFound	The specified resource is not found.
409	ResourceConflict	Concurrent modification of resources.
409	ResourceExist	Resources already exist.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.