GetAlert - - Alibaba Cloud ドキュメントセンター

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

log:GetAlert

get

*All Resource

*

なし

リクエスト構文

GET /alerts/{alertName} HTTP/1.1

パスパラメーター

パラメーター	型	必須 / 任意	説明	例
alertName	string	必須	アラートルールの ID。	alert-0123456789-123456

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
project	string	必須	プロジェクトの名前。	ali-test-project

レスポンスフィールド

フィールド	型	説明	例
	Alert	アラートルールの設定。

例

成功レスポンス

JSONJSON

{
  "name": "alert-123456",
  "displayName": "alertNameExample",
  "description": "Alert Desc",
  "configuration": {
    "muteUntil": 1698907508,
    "version": "2.0",
    "type": "default",
    "templateConfiguration": {
      "id": "sls.app.ack.ip.not_enough",
      "type": "sys",
      "version": "1",
      "lang": "cn",
      "tokens": {
        "test": "test",
        "test2": 1
      },
      "aonotations": {
        "test": "test",
        "test2": 1
      }
    },
    "dashboard": "DasnboardExample",
    "threshold": 1,
    "noDataFire": false,
    "noDataSeverity": 6,
    "sendResolved": false,
    "queryList": [
      {
        "chartTitle": "chartExmaple",
        "query": "* | select *",
        "timeSpanType": "Relative",
        "start": "-5m",
        "end": "now",
        "storeType": "log",
        "project": "projectExample",
        "store": "store Example",
        "region": "cn-hangzhou",
        "roleArn": "",
        "dashboardId": "dashboardExample",
        "powerSqlMode": "auto",
        "ui": ""
      }
    ],
    "annotations": [
      {
        "key": "title",
        "value": "example value"
      }
    ],
    "labels": [
      {
        "key": "title",
        "value": "example value"
      }
    ],
    "conditionConfiguration": {
      "condition": "cnt > 100",
      "countCondition": "__count__ > 5"
    },
    "severityConfigurations": [
      {
        "severity": 8,
        "evalCondition": {
          "condition": "cnt > 100",
          "countCondition": "__count__ > 5"
        }
      }
    ],
    "joinConfigurations": [
      {
        "type": "left_join",
        "condition": "$0.id == $1.id"
      }
    ],
    "groupConfiguration": {
      "type": "custom",
      "fields": [
        "id"
      ]
    },
    "policyConfiguration": {
      "alertPolicyId": "sls.builtin.dynamic",
      "actionPolicyId": "example_action_policy",
      "repeatInterval": "10m"
    },
    "autoAnnotation": false,
    "sinkEventStore": {
      "enabled": true,
      "endpoint": "cn-shanghai-intranet.log.aliyuncs.com",
      "project": "exampleProject",
      "eventStore": "exampleStore",
      "roleArn": "acs:ram::123456789:role/aliyunlogetlrole"
    },
    "sinkCms": {
      "enabled": true
    },
    "sinkAlerthub": {
      "enabled": true
    },
    "tags": [
      "host"
    ]
  },
  "schedule": {
    "type": "Cron",
    "cronExpression": "0/5 * * * *",
    "runImmediately": false,
    "timeZone": "+0800",
    "delay": 4,
    "interval": "1m"
  },
  "createTime": 0,
  "lastModifiedTime": 0,
  "status": "ENABLED/DISABLED"
}

エラーコード

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

変更履歴

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