すべてのプロダクト
Search

このプロダクト

    Application Real-Time Monitoring Service:CreatePrometheusAlertRule

    ドキュメントセンター

    Application Real-Time Monitoring Service:CreatePrometheusAlertRule

    最終更新日:Apr 11, 2026

    アラート ルールを作成します。

    操作説明

    説明

    Prometheus アラート ルールを作成するには、CreateOrUpdateAlertRule インターフェースを使用することを推奨します。

    今すぐお試しください

    この 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:CreatePrometheusAlertRule

    create

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    必須

    リージョン ID。

    cn-hangzhou
    AlertName

    string

    必須

    アラート ルールの名前。

    Prometheus_Alert
    ClusterId

    string

    必須

    クラスター ID。

    c0bad479465464e1d8c1e641b0afb****
    Type

    string

    任意

    アラート ルールのタイプ。有効値：

    • 99: カスタムアラート

    • 101: Prometheus Service のアラート

    101
    NotifyType

    string

    任意

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

    • ALERT_MANAGER: アラート通知はオペレーションセンターによって送信されます。これがデフォルト値です。

    • DISPATCH_RULE: アラート通知は、指定された通知ポリシーに基づいて送信されます。

    ALERT_MANAGER
    DispatchRuleId

    integer

    任意

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

    10282
    Expression

    string

    必須

    アラート ルールの式。式は PromQL 構文に従う必要があります。

    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
    Duration

    string

    必須

    持続時間。値の範囲は 1～1440 分です。

    10m
    Message

    string

    必須

    アラート通知の内容。タグは `{{$labels.xxx}}` 形式で参照できます。

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

    string

    任意

    JSON 文字列で記述されたタグ。各タグの名前と値を指定する必要があります。

    [{"Value": "critical","Name": "severity"}]
    Annotations

    string

    任意

    JSON 文字列で記述されたアノテーション。各アノテーションの名前と値を指定する必要があります。

    [{"Value": "xxx","Name": "description"}]
    Tags

    array<object>

    任意

    タグ。

    object

    任意

    タグ。

    Key

    string

    任意

    タグキー。

    type
    Value

    string

    任意

    タグ値。

    value1

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエスト ID。

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

    object

    返された構造体。

    Status

    integer

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

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

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

    1
    Type

    string

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

    Kubernetes组件告警
    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 分です。

    10m
    DispatchRuleId

    integer

    通知ポリシーの ID。

    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}}%
    Code

    integer

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

    200
    Success

    boolean

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

    true
    Message

    string

    返されたメッセージ。

    success

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "9FEA6D00-317F-45E3-9004-7FB8B0B7****",
  "PrometheusAlertRule": {
    "Status": 1,
    "Type": "Kubernetes组件告警",
    "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": "10m",
    "DispatchRuleId": 10282,
    "AlertName": "Prometheus_Alert",
    "AlertId": 3888704,
    "ClusterId": "c0bad479465464e1d8c1e641b0afb****",
    "Labels": [
      {
        "Name": "severity",
        "Value": "critical"
      }
    ],
    "Annotations": [
      {
        "Name": "message",
        "Value": "${{$labels.pod_name}}CPU使用率大于80%，当前值{{$value}}%"
      }
    ]
  },
  "Code": 200,
  "Success": true,
  "Message": "success"
}

    エラーコード

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

    変更履歴

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