すべてのプロダクト
Search
ドキュメントセンター

Application Real-Time Monitoring Service:ListPrometheusAlertRules

最終更新日:Apr 11, 2026

Prometheus インスタンスに作成されたアラートルールをクエリします。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

  • アクション:特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

  • API:アクションを具体的に実行するための API。

  • アクセスレベル:各 API に対して事前定義されているアクセスの種類。有効な値:create、list、get、update、delete。

  • リソースタイプ:アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

    • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

    • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

  • 条件キー:サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

  • 依存アクション:ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

arms:ListPrometheusAlertRules

list

*All Resource

*

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

Name

string

任意

アラートルールの名前。

Prometheus_Alert

RegionId

string

必須

インスタンスのリージョン ID。

cn-hangzhou

ClusterId

string

必須

クラスターの ID。

c0bad479465464e1d8c1e641b0afb****

Type

string

任意

アラートルールのタイプ。

自定义

Status

integer

任意

アラートルールを有効にするかどうかを指定します。有効な値:

  • 1:アラートルールを有効にします。

  • 0:アラートルールを無効にします。

1

MatchExpressions

string

任意

JSON 文字列で記述されるタグの一致条件。このパラメーターの詳細については、「MatchExpressions パラメーターの追加説明」をご参照ください。

[{"key":"severity","value":"critical","operator":"re"}]

Tags

array<object>

任意

タグ。

object

任意

タグ。

Key

string

任意

タグキー。

owner

Value

string

任意

タグ値。

zhangsan

MatchExpressions パラメーターの追加説明

JSON 文字列の例と説明

[
{
    "key":"severity",                           // タグのキー。
    "value":"critical",                           // タグの値。
    "operator":"re"                           // eq: 等しい。re: 正規表現に一致する。
}
]

レスポンスフィールド

フィールド

説明

object

RequestId

string

リクエスト ID。

9FEA6D00-317F-45E3-9004-7FB8B0B7****

PrometheusAlertRules

array<object>

返される構造体。

array<object>

返される構造体。

Status

integer

アラートルールが有効かどうかを示します。有効な値:

  • 1:アラートルールは有効です。

  • 0:アラートルールは無効です。

1

Type

string

アラートルールのタイプ。

自定义

NotifyType

string

アラート通知の送信に使用されるメソッド。有効な値:

  • ALERT_MANAGER:アラート通知はオペレーションセンターによって送信されます。

  • DISPATCH_RULE:アラート通知は

ALERT_MANAGER

Expression

string

アラートルールの式。

100 * (sum(rate(container_cpu_usage_seconds_total[1m])) by (pod_name) / sum(label_replace(kube_pod_container_resource_limits_cpu_cores, \"pod_name\", \"$1\", \"pod\", \"(.*)\")) by (pod_name))>75

Message

string

アラートメッセージ。タグは {{$labels.xxx}} 形式で参照できます。

${{$labels.pod_name}}CPU使用率大于80%,当前值{{$value}}%

Duration

string

アラートの持続時間。有効な値:1~1440。単位:分。

1m

DispatchRuleId

integer

通知ポリシーの ID。このパラメーターは、NotifyType パラメーターが DISPATCH_RULE に設定されている場合に返されます。

10282

AlertName

string

アラートルールの名前。

Prometheus_Alert

AlertId

integer

アラートルールの ID。

3888704

ClusterId

string

クラスターの ID。

c0bad479465464e1d8c1e641b0afb****

Labels

array<object>

アラートルールのラベル。

object

アラートルールのラベル。

Name

string

ラベルの名前。

severity

Value

string

インスタンスに関連付けられているタグの値。

critical

Annotations

array<object>

アラートルールのアノテーション。

object

アラートルールのアノテーション。

Name

string

アノテーションの名前。

message

Value

string

アノテーションの値。

${{$labels.pod_name}}CPU使用率大于80%,当前值{{$value}}%

Tags

array<object>

タグ。

object

タグ。

Key

string

タグキー。

key

Value

string

タグ値。

value

Code

integer

HTTP ステータスコード。ステータスコード 200 は、リクエストが成功したことを示します。その他のステータスコードは、リクエストが失敗したことを示します。

200

Message

string

返されるメッセージ。

success

Success

boolean

リクエストが成功したかどうかを示します。

True

成功レスポンス

JSONJSON

{
  "RequestId": "9FEA6D00-317F-45E3-9004-7FB8B0B7****",
  "PrometheusAlertRules": [
    {
      "Status": 1,
      "Type": "自定义",
      "NotifyType": "ALERT_MANAGER",
      "Expression": "100 * (sum(rate(container_cpu_usage_seconds_total[1m])) by (pod_name) / sum(label_replace(kube_pod_container_resource_limits_cpu_cores, \\\"pod_name\\\", \\\"$1\\\", \\\"pod\\\", \\\"(.*)\\\")) by (pod_name))>75",
      "Message": "${{$labels.pod_name}}CPU使用率大于80%,当前值{{$value}}%",
      "Duration": "1m",
      "DispatchRuleId": 10282,
      "AlertName": "Prometheus_Alert",
      "AlertId": 3888704,
      "ClusterId": "c0bad479465464e1d8c1e641b0afb****",
      "Labels": [
        {
          "Name": "severity",
          "Value": "critical"
        }
      ],
      "Annotations": [
        {
          "Name": "message",
          "Value": "${{$labels.pod_name}}CPU使用率大于80%,当前值{{$value}}%"
        }
      ],
      "Tags": [
        {
          "Key": "key",
          "Value": "value"
        }
      ]
    }
  ],
  "Code": 200,
  "Message": "success",
  "Success": true
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。