この操作では、アプリケーショングループにアラートルールテンプレートを適用し、アラートルールを生成します。
デバッグ
API Explorer を使用してデバッグを実行できます。 API Explorer を使用することで、さまざまな操作を実行して API の使用を簡素化できます。 たとえば、API の呼び出し、SDK サンプル コードの動的な生成、API の取得をすることができます。
リクエストパラメーター
パラメーター | データ型 | 必須/省略可能 | 例 | 説明 |
---|---|---|---|---|
Action | String | 必須 | ApplyMetricRuleTemplate |
実行する操作。 値を ApplyMetricRuleTemplate に設定します。 |
GroupId | Long | 必須 | 12345 |
アプリケーショングループの ID 。 |
TemplateIds | String | 必須 | 123 |
アラートルールテンプレートの ID 。 |
ApplyMode | String | 省略可能 | GROUP_INSTANCE_FIRST |
|
EnableEndTime | Long | 省略可能 | 23 |
アラート期間の終了時刻。 値が 00 ~ 23 の場合、00:59 から 23:59 までの期間を示します。 |
EnableStartTime | Long | 省略可能 | 00 |
アラート期間の開始時刻。 値が 00 ~ 23 の場合、00:00 から 23:00 までの期間を示します。 |
SilenceTime | Long | 省略可能 | 86400 |
トリガー条件が満たされているにも関わらず新しいアラートが送信されないミュート期間の期間。 単位 : 秒 。 既定値 : 86400 秒 (1 日) 。 メトリック値が連続してアラートルールのしきい値を超えた場合でも、各ミュート期間中に送信されるアラートは 1 件のみになります。 |
Webhook | String | 省略可能 | http://www.aliyun.com |
アラート発生時にトリガーされるコールバック URL。 指定された URL に POST リクエストが送信されます。 |
レスポンスパラメーター
パラメーター | データ型 | 例 | 説明 |
---|---|---|---|
Code | Integer | 200 |
ステータスコード。 |
Message | String | success |
エラーメッセージ。 |
RequestId | String | 1B25BAE2-DA60-428C-8414-37A11EEB49B5 |
トラブルシューティングのリクエスト ID。 |
Resource |
影響を受けるリソース。 |
||
└AlertResults |
生成されたアラートルールの詳細。 |
||
└Code | String | 200 |
ステータスコード。 |
└GroupId | Long | 123456 |
アプリケーショングループの ID 。 |
└Message | String | success |
エラーメッセージ。 |
└RuleId | String | applyTemplate44491519-xxxx-xxx |
アラートルールの ID 。 |
└RuleName | String | ruleNamex |
アラートルールの名前。 |
└Success | Boolean | true |
呼び出しが成功したかを示します。 値が true の場合、呼び出しが成功したことを示します。 値が false の場合、呼び出しが失敗したことを示します。 |
└GroupId | Long | 12345 |
アプリケーショングループの ID 。 |
Success | Boolean | true |
呼び出しが成功したかを示します。 値が true の場合、呼び出しが成功したことを示します。 値が false の場合、呼び出しが失敗したことを示します。 |
例
リクエスト例
http(s)://[Endpoint]/? Action=ApplyMetricRuleTemplate
&GroupId=12345
&TemplateIds=123
&<Common request parameters>
通常のレスポンス例
XML
形式
<ApplyMetricRuleTemplateResponse>
<RequestId>3F897F3C-020A-4993-95B4-63ABB84F83E6</RequestId>
<Resource>
<AlertResults>
<DisplayName>xxxx11</DisplayName>
<Code>200</Code>
<Success>true</Success>
<Name>applyTemplate12345-321</Name>
<GroupId>123456</GroupId>
</AlertResults>
<AlertResults>
<DisplayName>abb33</DisplayName>
<Code>200</Code>
<Success>true</Success>
<Name>applyTemplate12345-322</Name>
<GroupId>123456</GroupId>
</AlertResults>
<AlertResults>
<DisplayName>aaaa</DisplayName>
<Code>200</Code>
<Success>true</Success>
<Name>applyTemplate12345-322</Name>
<GroupId>123456</GroupId>
</AlertResults>
<GroupId>3040150</GroupId>
</Resource>
<ErrorCode>200</ErrorCode>
<Success>true</Success>
</ApplyMetricRuleTemplateResponse>
JSON
形式
{
"Resource":{
"AlertResults":[
{
"Name":"applyTemplate12345-321",
"Success":true,
"DisplayName":"xxxx11",
"GroupId":"123456"
"Code": "200"
},
{
"Name":"applyTemplate12345-322",
"Success":true,
"DisplayName":"abb33",
"GroupId":123457,
"Code": "200"
},
{
"Name":"applyTemplate12345-322",
"Success":true,
"DisplayName":"aaaa",
"GroupId":123459,
"Code": "200"
}
],
"GroupId":3040150
},
"RequestId":"3F897F3C-020A-4993-95B4-63ABB84F83E6"、
"Success":true,
"ErrorCode":200
}