Kueri aturan alert inisiatif dengan menggunakan DescribeActiveMetricRuleList-Cloud Monitor-Alibaba Cloud - Cloud Monitor

Mengkueri aturan peringatan inisiatif.

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:DescribeActiveMetricRuleList

get

*全部资源

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
Product	string	Yes	Singkatan layanan cloud yang mendukung aturan peringatan inisiatif. Untuk informasi selengkapnya tentang cara mendapatkan nama layanan cloud, lihat DescribeProductsOfActiveMetricRule.	ecs

Elemen respons

Element	Type	Description	Example
	object	None.
Code	string	The HTTP status code. Catatan The status code 200 indicates that the request was successful.	200
Message	string	The returned message.	The Request is not authorization.
RequestId	string	The request ID.	F82E6667-7811-4BA0-842F-5B2DC42BBAAD
Success	boolean	Indicates whether the request was successful. Valid values: true false	true
Datapoints	object
Alarm	array<object>	The details of the alert rules.
	object
SilenceTime	string	The mute period during which new alerts are not sent even if the trigger conditions are met. Unit: seconds.	86400
MetricName	string	The metric name.	cpu_total
EvaluationCount	string	The consecutive number of times for which the metric value meets the alert condition before an alert is triggered.	3
Webhook	string	The callback URL.	https://www.aliyun.com
State	string	Indicates whether the alert rule is enabled.	Enable
ContactGroups	string	The alert contact group.	ECS_Group
Namespace	string	The namespace of the cloud service.	acs_ecs_dashboard
RuleName	string	The name of the alert rule.	SystemDefault_acs_rds_dashboard_CpuUsage
RuleId	string	The ID of the alert rule.	a151cd6023eacee2f0978e03863cc1697c89508****
Period	string	The aggregation period of monitoring data. Unit: seconds.	60
ComparisonOperator	string	The comparison operator that is used in the alert rule. Valid values: `>` `<` `>=` `<=` `=` `=`	>
EndTime	string	The end of the time period during which the alert rule is effective. Unit: hours. For example, the value 23 indicates `23:59:59`.	24
StartTime	string	The beginning of the time period during which the alert rule is effective. Unit: hours. For example, the value 00 indicates `00:00:00`.	00
Threshold	string	The alert threshold.	90
Statistics	string	The statistical method.	Average
Enable	string	Indicates whether the alert rule is enabled. Valid values: true: The alert rule is enabled. false: The alert rule is disabled.	true
AlertList	object
Alert	array<object>	The details of the alert rules. The result is in the same structure as that returned by the DescribeMetricRuleList operation.
	array<object>
SilenceTime	string	The mute period during which new alerts are not sent even if the trigger conditions are met. Unit: seconds.	86400
MetricName	string	The name of the metric.	cpu_total
Webhook	string	The callback URL.	http://www.aliyun.com
ContactGroups	string	The alert contact group.	ECS_Group
Namespace	string	The namespace of the Alibaba Cloud service.	acs_ecs_dashboard
EffectiveInterval	string	The time period during which the alert rule is effective.	00:00-23:59
NoEffectiveInterval	string	The time period during which the alert rule is ineffective.	00:00-06:00
MailSubject	string	The subject of the alert notification email.	ECS_Bucket
RuleName	string	The name of the alert rule.	myAlert
RuleId	string	The ID of the alert rule.	ruleIdxxxx
Period	string	The aggregation period of monitoring data. Unit: seconds.	60
AlertState	string	The status of the alert rule. Valid values: OK: The alert rule has no active alerts. ALARM: The alert rule has active alerts. INSUFFICIENT_DATA: No data is found.	OK
Dimensions	string	The monitoring data of the specified resource.	""
EnableState	boolean	Indicates whether the alert rule is enabled. Valid values: true: The alert rule is enabled. false: The alert rule is disabled.	true
Resources	string	The resources that are associated with the alert rule.	[{"resource":"_ALL"}]
Escalations	object	The conditions for triggering different levels of alerts.
Info	object	The conditions for triggering Info-level alerts.
ComparisonOperator	string	The operator that is used to compare the metric value with the threshold for Info-level alerts. Valid values: GreaterThanOrEqualToThreshold: greater than or equal to the threshold GreaterThanThreshold: greater than the threshold LessThanOrEqualToThreshold: less than or equal to the threshold LessThanThreshold: less than the threshold NotEqualToThreshold: not equal to the threshold GreaterThanYesterday: greater than the metric value at the same time yesterday LessThanYesterday: less than the metric value at the same time yesterday GreaterThanLastWeek: greater than the metric value at the same time last week LessThanLastWeek: less than the metric value at the same time last week GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle LessThanLastPeriod: less than the metric value in the last monitoring cycle	GreaterThanThreshold
Times	string	The consecutive number of times for which the metric value meets the alert condition before an Info-level alert is triggered.	3
Threshold	string	The threshold for Info-level alerts.	95
Statistics	string	The statistical methods for Info-level alerts.	Average
Warn	object	The conditions for triggering Warn-level alerts.
ComparisonOperator	string	The operator that is used to compare the metric value with the threshold for Warn-level alerts. Valid values: GreaterThanOrEqualToThreshold: greater than or equal to the threshold GreaterThanThreshold: greater than the threshold LessThanOrEqualToThreshold: less than or equal to the threshold LessThanThreshold: less than the threshold NotEqualToThreshold: not equal to the threshold GreaterThanYesterday: greater than the metric value at the same time yesterday LessThanYesterday: less than the metric value at the same time yesterday GreaterThanLastWeek: greater than the metric value at the same time last week LessThanLastWeek: less than the metric value at the same time last week GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle LessThanLastPeriod: less than the metric value in the last monitoring cycle	GreaterThanThreshold
Times	string	The consecutive number of times for which the metric value meets the alert condition before a Warn-level alert is triggered.	3
Threshold	string	The threshold for Warn-level alerts.	80
Statistics	string	The statistical methods for Warn-level alerts.	Average
Critical	object	The trigger condition for Critical-level alerts.
ComparisonOperator	string	The operator that is used to compare the metric value with the threshold for Critical-level alerts. Valid values: GreaterThanOrEqualToThreshold: greater than or equal to the threshold GreaterThanThreshold: greater than the threshold LessThanOrEqualToThreshold: less than or equal to the threshold LessThanThreshold: less than the threshold NotEqualToThreshold: not equal to the threshold GreaterThanYesterday: greater than the metric value at the same time yesterday LessThanYesterday: less than the metric value at the same time yesterday GreaterThanLastWeek: greater than the metric value at the same time last week LessThanLastWeek: less than the metric value at the same time last week GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle LessThanLastPeriod: less than the metric value in the last monitoring cycle	GreaterThanThreshold
Times	string	The consecutive number of times for which the metric value meets the alert condition before a Critical-level alert is triggered.	3
Threshold	string	The threshold for Critical-level alerts.	99
Statistics	string	The statistical methods for Critical-level alerts.	Average

Contoh

Respons sukses

JSONformat

{
  "Code": "200",
  "Message": "The Request is not authorization.",
  "RequestId": "F82E6667-7811-4BA0-842F-5B2DC42BBAAD",
  "Success": true,
  "Datapoints": {
    "Alarm": [
      {
        "SilenceTime": "86400",
        "MetricName": "cpu_total",
        "EvaluationCount": "3",
        "Webhook": "https://www.aliyun.com",
        "State": "Enable",
        "ContactGroups": "ECS_Group",
        "Namespace": "acs_ecs_dashboard",
        "RuleName": "SystemDefault_acs_rds_dashboard_CpuUsage",
        "RuleId": "a151cd6023eacee2f0978e03863cc1697c89508****",
        "Period": "60",
        "ComparisonOperator": ">",
        "EndTime": "24",
        "StartTime": "00",
        "Threshold": "90",
        "Statistics": "Average",
        "Enable": "true"
      }
    ]
  },
  "AlertList": {
    "Alert": [
      {
        "SilenceTime": "86400",
        "MetricName": "cpu_total",
        "Webhook": "http://www.aliyun.com",
        "ContactGroups": "ECS_Group",
        "Namespace": "acs_ecs_dashboard",
        "EffectiveInterval": "00:00-23:59",
        "NoEffectiveInterval": "00:00-06:00",
        "MailSubject": "ECS_Bucket",
        "RuleName": "myAlert",
        "RuleId": "ruleIdxxxx",
        "Period": "60",
        "AlertState": "OK",
        "Dimensions": "\"\"",
        "EnableState": true,
        "Resources": "[{\"resource\":\"_ALL\"}]",
        "Escalations": {
          "Info": {
            "ComparisonOperator": "GreaterThanThreshold",
            "Times": "3",
            "Threshold": "95",
            "Statistics": "Average"
          },
          "Warn": {
            "ComparisonOperator": "GreaterThanThreshold",
            "Times": "3",
            "Threshold": "80",
            "Statistics": "Average"
          },
          "Critical": {
            "ComparisonOperator": "GreaterThanThreshold",
            "Times": "3",
            "Threshold": "99",
            "Statistics": "Average"
          }
        }
      }
    ]
  }
}

Kode kesalahan

HTTP status code	Error code	Error message
400	ParameterInvalid	%s
401	AccessDeniedException	You donot have sufficient access to perform this action.
402	LimitExceeded	The quota for this customer had been reached.
403	AccessForbidden	The X.509 certificate or cms access key ID provided does not exist in our records.
404	ResourceNotFound	The specified resource is not found.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.