PutEventRuleTargets API によるイベントトリガーアラートルールターゲットの追加・変更 - CMS - Alibaba Cloud - Cloud Monitor

PutEventRuleTargets 操作を呼び出して、イベントトリガーアラートルールの通知チャネルを追加または変更します。

今すぐお試しください

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

create

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RuleName	string	必須	アラートルールの名前。	testEventRule
FcParameters	array<object>	任意	Function Compute 通知方法。
	object	任意	なし。
FunctionName	string	任意	関数の名前。N の有効な値: 1～5。	fc-test
Region	string	任意	Function Compute サービスが存在するリージョン。N の有効な値: 1～5。	cn-hangzhou
ServiceName	string	任意	Function Compute サービスのサービス名。N の有効な値: 1～5。	fc-test
Id	string	任意	ルールターゲットの一意の識別子。N の有効な値: 1～5。	1
ContactParameters	array<object>	任意	アラート連絡先グループ通知方法。
	object	任意	なし。
ContactGroupName	string	任意	アラート連絡先グループの名前。N の有効な値: 1～5。	Default alert contact group
Id	string	任意	ルールターゲットの一意の識別子。N の有効な値: 1～5。	2
Level	string	任意	アラート通知レベル。N の有効な値: 1～5。有効な値: 4: DingTalk、メール。	4
MnsParameters	array<object>	任意	Simple メッセージキュー (旧 MNS) 通知方法。
	object	任意	なし。
Region	string	任意	Simple メッセージキュー (旧 MNS) が存在するリージョン。N の有効な値: 1～5。	cn-hangzhou
Queue	string	任意	キューの名前。N の有効な値: 1～5。	queue1
Id	string	任意	ルールターゲットの一意の識別子。N の有効な値: 1～5。	3
Topic	string	任意	Simple メッセージキュー (旧 MNS) の Topic。	topic_sample
WebhookParameters	array<object>	任意	URL コールバック通知方法。URL コールバックを呼び出してアラート通知を送信します。
	object	任意	なし。
Protocol	string	任意	プロトコル名。N の有効な値: 1～5。有効な値: http telnet ping。	http
Url	string	任意	コールバック呼び出し URL。N の有効な値: 1～5。	http://www.aliyun.com
Method	string	任意	HTTP コールバック呼び出しのリクエストメソッド。N の有効な値: 1～5。 GET と POST のみがサポートされています。	GET
Id	string	任意	ルールターゲットの一意の識別子。N の有効な値: 1～5。	4
SlsParameters	array<object>	任意	Log Service 通知方法。
	object	任意	なし。
LogStore	string	任意	Log Service の Logstore。N の有効な値: 1～5。	testlogstore
Region	string	任意	Log Service が存在するリージョン。N の有効な値: 1～5。	cn-hangzhou
Project	string	任意	Log Service のプロジェクト。N の有効な値: 1～5。	testproject
Id	string	任意	ルールターゲットの一意の識別子。N の有効な値: 1～5。	5
OpenApiParameters	array<object>	任意	API 呼び出しコールバック通知パラメーターのリスト。
	object	任意	なし。
Action	string	任意	API 名。	PutLogs
Arn	string	任意	リソースの Alibaba Cloud リソースネーム (ARN)。N の有効な値: 1～5。フォーマット: `arn:acs:${Service}:${Region}:${Account}:${ResourceType}/${ResourceId}`。各フィールドの説明は次のとおりです: Service: Alibaba Cloud サービス。 Region: リージョン ID。 Account: Alibaba Cloud アカウント ID。 ResourceType: リソースタイプ。 ResourceId: リソース ID。	acs:log:cn-hangzhou::project/cms-log-mon*/logstore/cxxxx*
Id	string	任意	API 呼び出しコールバック通知方法の一意の識別子。	3
Product	string	任意	API が属する Alibaba Cloud サービスの ID。	log
Region	string	任意	リソースが存在するリージョン。	cn-hangzhou
Role	string	任意	ロール名。	MyRole
Version	string	任意	API バージョン。	2019-01-01
JsonParams	string	任意	アラートコールバック呼び出しの JSON フォーマットのパラメーター。	{"customField1":"value1","customField2":"$.name"}

レスポンスフィールド

フィールド	型	説明	例
	object
Code	string	状態コード。説明値 200 は成功を示します。	200
Message	string	エラーメッセージ。	The Request is not authorization.
RequestId	string	リクエスト ID。	409C64DA-CF14-45DF-B463-471C790DD15A
Success	boolean	操作が成功したかどうかを示します。値 true は成功を示します。値 false は失敗を示します。	true
FailedParameterCount	string	失敗したパラメーターの数。	2
FailedContactParameters	object
ContactParameter	array<object>	ルールターゲットに作成に失敗したアラート連絡先グループが含まれている場合に返されるパラメーター。
	object	なし。
ContactGroupName	string	アラートグループの名前。	Default alert contact group
Id	integer	受信者の ID。	2
Level	string	アラート通知方法。有効な値： 4：アラート通知は DingTalk とメールで送信されます。	4
FailedMnsParameters	object
MnsParameter	array<object>	ルールターゲットに作成に失敗した Simple メッセージキュー (旧 MNS) インスタンスが含まれている場合に返されるパラメーター。
	object	なし。
Queue	string	MNS キューの名前。	testQueue
Id	integer	受信者の ID。	2
Region	string	リージョン ID。	cn-hangzhou
FailedFcParameters	object
FcParameter	array<object>	ルールターゲットに作成に失敗した Function Compute サービスが含まれている場合に返されるパラメーター。
	object	なし。
ServiceName	string	Function Compute サービスの名前。	serviceTest1
FunctionName	string	関数名。	functionTest1
Id	integer	受信者の ID。	1
Region	string	リージョン ID。	cn-hangzhou

例

成功レスポンス

JSONJSON

{
  "Code": "200",
  "Message": "The Request is not authorization.",
  "RequestId": "409C64DA-CF14-45DF-B463-471C790DD15A",
  "Success": true,
  "FailedParameterCount": "2",
  "FailedContactParameters": {
    "ContactParameter": [
      {
        "ContactGroupName": "Default alert contact group",
        "Id": 2,
        "Level": "4"
      }
    ]
  },
  "FailedMnsParameters": {
    "MnsParameter": [
      {
        "Queue": "testQueue",
        "Id": 2,
        "Region": "cn-hangzhou"
      }
    ]
  },
  "FailedFcParameters": {
    "FcParameter": [
      {
        "ServiceName": "serviceTest1",
        "FunctionName": "functionTest1",
        "Id": 1,
        "Region": "cn-hangzhou"
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	%s	%s
500	%s	%s
500	InternalError	The request processing has failed due to some unknown error.
403	%s	%s
404	%s	%s

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

変更履歴

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