CloudMonitor アラート統合のための ListAlertActions API 概要 - CloudMonitor

アラートアクションの統合を照会します。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

cms:ListAlertActions

list

*AlertAction

acs:cms:{#regionId}:{#accountId}:alertaction/*

なし

リクエスト構文

GET /alertActions HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
alertActionIds	array	任意	アラートアクション統合の一意の ID。
	string	任意	アラートアクション統合の一意の ID。	testId
type	string	任意	アラートアクション統合のタイプ。	FC
alertActionName	string	任意	アラートアクション統合の名前。	testName
pageNumber	integer	任意	ページ番号。デフォルト値: 1。	1
pageSize	integer	任意	1 ページあたりのエントリー数。デフォルト値: 100。	100

レスポンスフィールド

フィールド	型	説明	例
	object
requestId	string	リクエスト ID。	8FDE2569-626B-5176-9844-28877A*****
total	integer	エントリーの総数。	9
pageNumber	integer	ページ番号。	1
pageSize	integer	1 ページあたりのエントリー数。	100
alertActions	array<object>	アラートアクション統合設定のリスト。
	array<object>	アラートアクション統合設定のリスト。
fcParam	object	Function Compute のパラメーター。
regionId	string	リージョン ID。	cn-beijing
service	string	Function Compute のサービス名。	test
function	string	Function Compute サービスの関数名。	test
ebParam	object	イベントバスを指定します。
regionId	string	リージョン ID。	cn-heyuan
subject	string	件名。	test
ebSource	string	イベントプロバイダー。	test
eventBusName	string	イベントバスの名前。	test
alertActionId	string	アラートアクション統合の一意の ID。	test
slsParam	object	Simple Log Service のパラメーター。
regionId	string	リージョン ID。	cn-hangzhou
project	string	Simple Log Service プロジェクトの名前。	test
logstore	string	Simple Log Service Logstore の名前。	test
fc3Param	object	Function Compute 3.0 のパラメーター。
regionId	string	リージョン ID。	cn-qingdao
function	string	Function Compute サービスの関数名。	test
qualifier	string	関数のバージョンまたはエイリアス。	test
mnsParam	object	Simple Message Queue (旧称：MNS) のパラメーター。
mnsType	string	Simple Message Queue (旧称：MNS) のリソースタイプ。	queue
regionId	string	リージョン ID。	cn-hangzhou
name	string	リソースの名前。リソースタイプが `queue` の場合、このパラメーターはキュー名を指定します。リソースタイプが `topic` の場合、このパラメーターはトピック名を指定します。	test
pagerDutyParam	object	PagerDuty のパラメーター。
key	string	PagerDuty の統合キー。	fsfer4543t5t65g4t4
url	string	PagerDuty の統合 Webhook。バージョン 1 と 2 がサポートされています。	https://events.pagerduty.com/v2/enqueue
type	string	アラートアクション統合のタイプ。	FC
webhookParam	object	Webhook のパラメーター。
headers	object	リクエストヘッダー。
	string	リクエストヘッダー。	{'X-Total-Count': 0}
method	string	Webhook のリクエストメソッド。	GET
contentType	string	データ形式。このパラメーターは、リクエストメソッドが POST の場合にのみ有効です。	JSON
url	string	アラートのコールバック URL。	http://www.test.com
essParam	object	Auto Scaling のパラメーター。
essGroupId	string	Auto Scaling グループの ID。	testId
regionId	string	リージョン ID。	cn-beijing
essRuleId	string	スケーリングルールの ID。	testId
alertActionName	string	アラートアクション統合の名前。	testName

例

成功レスポンス

JSONJSON

{
  "requestId": "8FDE2569-626B-5176-9844-28877A*****",
  "total": 9,
  "pageNumber": 1,
  "pageSize": 100,
  "alertActions": [
    {
      "fcParam": {
        "regionId": "cn-beijing",
        "service": "test",
        "function": "test"
      },
      "ebParam": {
        "regionId": "cn-heyuan",
        "subject": "test",
        "ebSource": "test",
        "eventBusName": "test"
      },
      "alertActionId": "test",
      "slsParam": {
        "regionId": "cn-hangzhou",
        "project": "test",
        "logstore": "test"
      },
      "fc3Param": {
        "regionId": "cn-qingdao",
        "function": "test",
        "qualifier": "test"
      },
      "mnsParam": {
        "mnsType": "queue",
        "regionId": "cn-hangzhou",
        "name": "test"
      },
      "pagerDutyParam": {
        "key": "fsfer4543t5t65g4t4",
        "url": "https://events.pagerduty.com/v2/enqueue"
      },
      "type": "FC",
      "webhookParam": {
        "headers": {
          "key": "{'X-Total-Count': 0}"
        },
        "method": "GET",
        "contentType": "JSON",
        "url": "http://www.test.com"
      },
      "essParam": {
        "essGroupId": "testId",
        "regionId": "cn-beijing",
        "essRuleId": "testId"
      },
      "alertActionName": "testName"
    }
  ]
}

エラーコード

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

変更履歴

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