作成済みのアラートルールをクエリします。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
arms:GetAlertRules |
get |
*All Resource
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| AlertIds |
string |
任意 |
アラートルールの一意の ID。
説明
GetAlertRules API を呼び出す際、他のリクエストパラメーターを指定してレスポンスから AlertIds パラメーターを取得できます。その後、AlertIds パラメーターを指定して、指定されたアラートルールをクエリできます。 |
["12345"] |
| AlertNames |
string |
任意 |
アラートルールの名前。新しいバージョンのアラートルールを作成する際、重複した名前を指定することはできません。ただし、既存のアラートルールには重複した名前が存在する場合があります。そのため、AlertName パラメーターはアラートルールを一意に識別するものではありません。
|
["test"] |
| RegionId |
string |
必須 |
リージョン ID。 |
cn-hangzhou |
| AlertType |
string |
任意 |
アラートルールのタイプ。新しいバージョンのアラート管理を使用する場合に必須となります。有効な値：
|
APPLICATION_MONITORING_ALERT_RULE |
| AlertStatus |
string |
任意 |
アラートルールのステータス。有効な値：
説明
PAUSED ステータスは、異常によりアラートルールが一時停止していることを示します。これは、しきい値が過度に大きい場合や、関連するクラスターが削除された場合に発生する可能性があります。 |
RUNNING |
| ClusterId |
string |
任意 |
監視対象クラスターの ID。 |
ceba9b9ea5b924dd0b6726d2de6****** |
| ProductCode |
string |
任意 |
このパラメーターを設定する必要はありません。 |
null |
| Page |
integer |
必須 |
返すページの番号。 |
1 |
| Size |
integer |
必須 |
1ページあたりに返されるアラートルールの数。 |
20 |
| Tags |
array<object> |
任意 |
タグのリスト。 |
|
|
object |
任意 |
|||
| Key |
string |
任意 |
タグキー。 |
type |
| Value |
string |
任意 |
タグ値。 |
prod |
| BizRegionId |
string |
任意 |
ルールが存在するビジネスリージョンの ID。 |
cn-hangzhou |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
返される構造体。 |
||
| RequestId |
string |
リクエスト ID。 |
337B8F7E-0A64-5768-9225-E9B3CF****** |
| PageBean |
object |
返されるページングされた結果。 |
|
| Total |
integer |
クエリされたアラートルールの総数。 |
1 |
| Page |
integer |
返されたページ番号。 |
1 |
| Size |
integer |
1 ページあたりに返されるアラートルールの数。 |
20 |
| AlertRules |
array<object> |
アラートルール。 |
|
|
array<object> |
各アラートルールの詳細。 |
||
| AlertId |
integer |
アラートルール ID。 |
5730*** |
| AlertName |
string |
アラートルールの名前。 |
arms-test |
| UserId |
string |
Alibaba Cloud アカウントの ID。 |
1131971649****** |
| RegionId |
string |
リージョン ID。 |
cn-hangzhou |
| AlertType |
string |
アラートルールのタイプ。 有効な値：
|
APPLICATION_MONITORING_ALERT_RULE |
| AlertStatus |
string |
アラートルールのステータス。 有効な値：
説明
PAUSED 状態は、アラートルールが異常により一時停止していることを示します。原因として、指定されたしきい値が大きすぎることや、関連付けられたクラスターが削除されたことなどが考えられます。 |
RUNNING |
| CreatedTime |
integer |
アラートルールが作成された時刻。値はミリ秒単位のタイムスタンプです。 |
1640333981000 |
| UpdatedTime |
integer |
アラートルールが更新された時刻。値はミリ秒単位のタイムスタンプです。 |
1640333981000 |
| Extend |
string |
拡張フィールド。 説明
このフィールドには、既存のアプリケーションモニタリングのアラートルールにおける連絡先、アラートテンプレート、通知内容などの情報が含まれます。 |
{\"alarmContext\":\"{\\\"content\\\":\\\"报警名称:$报警名称\\\\n筛选条件: $筛选\\\\n报警时间: $报警时间\\\\n报警内容: $报警内容\\\\n注意！：该报警未收到恢复邮件之前，正在持续报警中，24小时后会再次提醒您！\\\",\\\"subTitle\\\":\\\"\\\"}\",\"alertWays\":\"[0,1]\",\"contactGroupIds\":\"381,5075\",\"notice\":\"{\\\"endTime\\\":1480607940000,\\\"noticeEndTime\\\":1480607940000,\\\"noticeStartTime\\\":1480521600000,\\\"startTime\\\":1480521600000}\"} |
| NotifyStrategy |
string |
通知ポリシーの名前。 |
ALERT_MANAGER |
| Pids |
array |
アプリケーションモニタリングまたはブラウザ監視のアラートルールが適用されるアプリケーションのプロセス ID (PID) の配列です。 |
|
|
string |
アプリケーションの PID。 |
["b590lhguqs@40d8deedfa9******"] |
|
| AutoAddNewApplication |
boolean |
アプリケーションモニタリングまたはブラウザ監視で作成された新しいアプリケーションにアラートルールを適用するかどうかを示します。 有効な値：
|
false |
| MetricsType |
string |
アプリケーションモニタリングまたはブラウザ監視のアラートルールのメトリクスタイプ。 |
JVM |
| AlertRuleContent |
object |
アプリケーションモニタリングまたはブラウザ監視のアラートルールの内容。 |
|
| Condition |
string |
アプリケーションモニタリングまたはブラウザ監視のアラートルールで指定された複数のアラート条件間の関係。 有効な値：
|
OR |
| AlertRuleItems |
array<object> |
アプリケーションモニタリングまたはブラウザ監視のアラートルールのトリガー条件。 |
|
|
object |
アラート条件の詳細。 |
||
| N |
integer |
直近 N 分。 |
1 |
| MetricKey |
string |
アラート条件のメトリクス。 |
appstat.jvm.non_heap_used |
| Aggregate |
string |
アラート条件の集計方法。 有効な値：
|
AVG |
| Operator |
string |
メトリクス値としきい値を比較するために使用される演算子。 有効な値：
|
CURRENT_GTE |
| Value |
string |
アラート条件のしきい値。 |
1 |
| Filters |
object |
アプリケーションモニタリングまたはブラウザ監視のアラートルールのフィルター条件。 |
|
| DimFilters |
array<object> |
アプリケーションモニタリングまたはブラウザ監視のアラートルールの各フィルター条件に関する情報。 |
|
|
object |
フィルター条件の詳細。 |
||
| FilterKey |
string |
フィルター条件のキー。 |
rootIp |
| FilterOpt |
string |
フィルター条件の論理演算子。 |
ALL |
| FilterValues |
array |
フィルター条件の値。 |
|
|
string |
フィルター条件の値。 |
null |
|
| CustomSLSFilters |
array<object> |
ブラウザ監視のアラートルールのカスタムフィルター条件。 |
|
|
object |
カスタムフィルター条件の詳細。 |
||
| Key |
string |
フィルター条件のキー。 |
username |
| Opt |
string |
フィルター条件の論理演算子。 有効な値：
|
= |
| Value |
string |
フィルター条件の値。 |
test |
| T |
string |
ブラウザ監視のログタイプ。 このフィールドは他のフィルター条件には含まれません。 |
null |
| Show |
boolean |
このフィルター条件をフロントエンドに表示するかどうかを示します。 |
false |
| CustomSLSGroupByDimensions |
array |
集計ディメンションの配列です。 |
|
|
string |
集計ディメンションの値。 |
["page"] |
|
| CustomSLSWheres |
array |
カスタムフィルター条件の配列です。 |
|
|
string |
カスタムフィルター条件の値。 |
["t like '%api%'"] |
|
| AlertCheckType |
string |
Prometheus アラートルールのチェックタイプ。
|
STATIC |
| ClusterId |
string |
Prometheus アラートルールのクラスター ID。 |
ceba9b9ea5b924dd0b6726d2de6****** |
| AlertGroup |
integer |
Prometheus アラートルールのアラート連絡先グループ ID。
|
1 |
| PromQL |
string |
Prometheus アラートルールの PromQL ステートメント。 |
node_memory_MemAvailable_bytes{} / node_memory_MemTotal_bytes{} * 100 |
| Duration |
string |
Prometheus アラートルールの期間。 |
1 |
| Level |
string |
Prometheus アラートルールの重大度レベル。
|
P2 |
| Message |
string |
Prometheus アラートルールのアラートメッセージ。 |
命名空间: {{$labels.namespace}} / Pod: {{$labels.pod_name}} / 容器: {{$labels.container}} CPU使用率{{$labels.metrics_params_opt_label_value}} {{$labels.metrics_params_value}}%, 当前值{{ printf "%.2f" $value }}% |
| Labels |
array<object> |
Prometheus アラートルールのラベルの配列です。 |
|
|
object |
ラベルの構造体。 |
||
| Name |
string |
ラベルキー。 |
123 |
| Value |
string |
ラベル値。 |
abc |
| Annotations |
array<object> |
Prometheus アラートルールのアノテーションの配列です。 |
|
|
object |
アノテーションの構造体。 |
||
| Name |
string |
アノテーションのキー。 |
123 |
| Value |
string |
アノテーションの値。 |
abc |
| Tags |
array<object> |
アラートルールのタグの配列です。 |
|
|
object |
|||
| Key |
string |
タグキー。 |
type |
| Value |
string |
タグ値。 |
prod |
例
成功レスポンス
JSONJSON
{
"RequestId": "337B8F7E-0A64-5768-9225-E9B3CF******",
"PageBean": {
"Total": 1,
"Page": 1,
"Size": 20,
"AlertRules": [
{
"AlertId": 0,
"AlertName": "arms-test",
"UserId": "1131971649******",
"RegionId": "cn-hangzhou",
"AlertType": "APPLICATION_MONITORING_ALERT_RULE",
"AlertStatus": "RUNNING",
"CreatedTime": 1640333981000,
"UpdatedTime": 1640333981000,
"Extend": "{\\\"alarmContext\\\":\\\"{\\\\\\\"content\\\\\\\":\\\\\\\"报警名称:$报警名称\\\\\\\\n筛选条件: $筛选\\\\\\\\n报警时间: $报警时间\\\\\\\\n报警内容: $报警内容\\\\\\\\n注意！：该报警未收到恢复邮件之前，正在持续报警中，24小时后会再次提醒您！\\\\\\\",\\\\\\\"subTitle\\\\\\\":\\\\\\\"\\\\\\\"}\\\",\\\"alertWays\\\":\\\"[0,1]\\\",\\\"contactGroupIds\\\":\\\"381,5075\\\",\\\"notice\\\":\\\"{\\\\\\\"endTime\\\\\\\":1480607940000,\\\\\\\"noticeEndTime\\\\\\\":1480607940000,\\\\\\\"noticeStartTime\\\\\\\":1480521600000,\\\\\\\"startTime\\\\\\\":1480521600000}\\\"}",
"NotifyStrategy": "ALERT_MANAGER",
"Pids": [
"[\"b590lhguqs@40d8deedfa9******\"]"
],
"AutoAddNewApplication": false,
"MetricsType": "JVM",
"AlertRuleContent": {
"Condition": "OR",
"AlertRuleItems": [
{
"N": 1,
"MetricKey": "appstat.jvm.non_heap_used",
"Aggregate": "AVG",
"Operator": "CURRENT_GTE",
"Value": "1"
}
]
},
"Filters": {
"DimFilters": [
{
"FilterKey": "rootIp",
"FilterOpt": "ALL",
"FilterValues": [
"null"
]
}
],
"CustomSLSFilters": [
{
"Key": "username",
"Opt": "=",
"Value": "test",
"T": "null",
"Show": false
}
],
"CustomSLSGroupByDimensions": [
"[\"page\"]"
],
"CustomSLSWheres": [
"[\"t like '%api%'\"]"
]
},
"AlertCheckType": "STATIC",
"ClusterId": "ceba9b9ea5b924dd0b6726d2de6******",
"AlertGroup": 1,
"PromQL": "node_memory_MemAvailable_bytes{} / node_memory_MemTotal_bytes{} * 100",
"Duration": "1",
"Level": "P2",
"Message": "命名空间: {{$labels.namespace}} / Pod: {{$labels.pod_name}} / 容器: {{$labels.container}} CPU使用率{{$labels.metrics_params_opt_label_value}} {{$labels.metrics_params_value}}%, 当前值{{ printf \"%.2f\" $value }}%",
"Labels": [
{
"Name": "123",
"Value": "abc"
}
],
"Annotations": [
{
"Name": "123",
"Value": "abc"
}
],
"Tags": [
{
"Key": "type",
"Value": "prod"
}
]
}
]
}
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。