CreateGroupMetricRules - アラートAPI| Alibaba Cloud ドキュメントセンター

デバッグ

API Explorer を使用してデバッグを実行できます。 API Explorer を使用することで、さまざまな操作を実行して API の使用を簡素化できます。たとえば、API の取得、API の呼び出し、SDK サンプルコードの動的生成を行うことができます。

リクエストパラメーター


パラメーター	データ型	必須/省略可能	例	説明
GroupId	Long	必須	123456	アプリケーショングループの ID 。
Action	String	省略可能	CreateGroupMetricRules	実行する操作。値を CreateGroupMetricRules に設定します。
GroupMetricRules.N.Category	String	省略可能	ecs	サービス名の省略形。 N の有効値 : 1 ~ 200 。
GroupMetricRules.N.Dimensions	String	省略可能	[{"instanceId":"xxxxxx"}]	拡張されたリソースの分析コード。 N の有効値 : 1 ~ 200 。
GroupMetricRules.N.EffectiveInterval	String	省略可能	00:00-23:59	アラートルールの有効期間。 N の有効値 : 1 ~ 200 。
GroupMetricRules.N.EmailSubject	String	省略可能	An alert occurs	アラート通知メールの件名。 N の有効値 : 1 ~ 200 。
GroupMetricRules.N.Escalations.Critical.ComparisonOperator	String	省略可能	GreaterThanOrEqualToThreshold	critical レベルのアラートのしきい値の比較演算子。有効値 : GreaterThanOrEqualToThreshold GreaterThanThreshold LessThanOrEqualToThreshold LessThanThreshold NotEqualToThreshold GreaterThanYesterday LessThanYesterday GreaterThanLastWeek LessThanLastWeek GreaterThanLastPeriod LessThanLastPeriod N の有効値 : 1 ~ 200 。
GroupMetricRules.N.Escalations.Critical.Statistics	String	省略可能	Average	critical レベルのアラートの統計方法。統計方法はメトリックによって異なります。 N の有効値 : 1 ~ 200 。
GroupMetricRules.N.Escalations.Critical.Threshold	String	省略可能	90	critical レベルのアラートのしきい値。 N の有効値 : 1 ~ 200 。
GroupMetricRules.N.Escalations.Critical.Times	Integer	省略可能	3	メトリック値が連続して critical レベルのアラートのしきい値を超えるとアラートがトリガーされるようにする連続回数。 N の有効値 : 1 ~ 200 。
GroupMetricRules.N.Escalations.Info.ComparisonOperator	String	省略可能	GreaterThanOrEqualToThreshold	info レベルのアラートのしきい値の比較演算子。有効値 : GreaterThanOrEqualToThreshold GreaterThanThreshold LessThanOrEqualToThreshold LessThanThreshold NotEqualToThreshold GreaterThanYesterday LessThanYesterday GreaterThanLastWeek LessThanLastWeek GreaterThanLastPeriod LessThanLastPeriod N の有効値 : 1 ~ 200 。
GroupMetricRules.N.Escalations.Info.Statistics	String	省略可能	Average	info レベルのアラートの統計方法。 N の有効値 : 1 ~ 200 。
GroupMetricRules.N.Escalations.Info.Threshold	String	省略可能	90	info レベルのアラートのしきい値。 N の有効値 : 1 ~ 200 。
GroupMetricRules.N.Escalations.Info.Times	Integer	省略可能	3	メトリック値が連続して info レベルのアラートのしきい値を超えるとアラートがトリガーされるようにする連続回数。 N の有効値 : 1 ~ 200 。
GroupMetricRules.N.Escalations.Warn.ComparisonOperator	String	省略可能	GreaterThanOrEqualToThreshold	warn レベルのアラートのしきい値の比較演算子。有効値 : GreaterThanOrEqualToThreshold GreaterThanThreshold LessThanOrEqualToThreshold LessThanThreshold NotEqualToThreshold GreaterThanYesterday LessThanYesterday GreaterThanLastWeek LessThanLastWeek GreaterThanLastPeriod LessThanLastPeriod N の有効値 : 1 ~ 200 。
GroupMetricRules.N.Escalations.Warn.Statistics	String	省略可能	Average	warn レベルのアラートの統計方法。 N の有効値 : 1 ~ 200 。
GroupMetricRules.N.Escalations.Warn.Threshold	String	省略可能	90	warn レベルのアラートのしきい値。 N の有効値 : 1 ~ 200 。
GroupMetricRules.N.Escalations.Warn.Times	Integer	省略可能	3	メトリック値が連続して warn レベルのアラートのしきい値を超えるとアラートがトリガーされるようにする連続回数。 N の有効値 : 1 ~ 200 。
GroupMetricRules.N.Interval	String	省略可能	60	アラートの検出期間。 N の有効値 : 1 ~ 200 。 N の有効値 : 1 ~ 200 。
GroupMetricRules.N.MetricName	String	省略可能	cpu_total	メトリックの名前。詳細については、DescribeMetricMetaList を呼び出すか、あるいは「プリセットメトリックリファレンス」をご参照ください。 N の有効値 : 1 ~ 200 。
GroupMetricRules.N.Namespace	String	省略可能	acs_ecs_dashboard	サービスのデータ名前空間。詳細については、DescribeMetricMetaList を呼び出すか、あるいは「プリセットメトリックリファレンス」をご参照ください。 N の有効値 : 1 ~ 200 。
GroupMetricRules.N.NoEffectiveInterval	String	省略可能	00:00-05:30	アラートルールの無効期間。 N の有効値 : 1 ~ 200 。
GroupMetricRules.N.Period	String	省略可能	60	集計期間。単位 : 秒。 N の有効値 : 1 ~ 200 。 N の有効値 : 1 ~ 200 。
GroupMetricRules.N.RuleId	String	省略可能	bfae2ca5b4e07d2c7278772eccda169808c7b****	アラートルールの ID 。一意性を確保するため、呼び出し元によってアラートルールの ID が生成されます。 N の有効値 : 1 ~ 200 。
GroupMetricRules.N.RuleName	String	省略可能	Alert rule 1	アラートルールの名前。 N の有効値 : 1 ~ 200 。
GroupMetricRules.N.SilenceTime	Integer	省略可能	86400	トリガー条件が満たされても新しいアラートが送信されないミュート期間。単位 : 秒。既定値 : 86400 。最小値 : 3600 。 N の有効値 : 1 ~ 200 。 N の有効値 : 1 ~ 200 。
GroupMetricRules.N.Webhook	String	省略可能	http://www.aliyun.com	アラート発生時にトリガーされるコールバック URL。 N の有効値 : 1 ~ 200 。

3 つのアラートトリガー条件のうち少なくとも 1 つを選択する必要があります。指定しない場合は、アラートルールを作成できません。

レスポンスパラメーター


パラメーター	データ型	例	説明
Code	Integer	200	ステータスコード。値が 200 の場合、呼び出しが成功したことを示します。値が 200 以外の場合、呼び出しが失敗したことを示します。
Message	String	success	エラーメッセージ。
RequestId	String	461CF2CD-2FC3-4B26-8645-7BD27E7D0F1D	トラブルシューティングのリクエスト ID。
Resources			作成されたアラートルールが適用されるリソースの一覧。
└Code	Integer	200	ステータスコード。値が 200 の場合、呼び出しが成功したことを示します。
└Message	String	success	エラーメッセージ。
└RuleId	String	a151cd6023eacee2f0978e03863cc1697c89508****	アラートルールの ID 。
└RuleName	String	Alert rule 1	アラートルールの名前。
└Success	Boolean	true	呼び出しが成功したかを示します。値が true の場合、呼び出しが成功したことを示します。値が false の場合、呼び出しが失敗したことを示します。
Success	Boolean	true	呼び出しが成功したかを示します。値が true の場合、呼び出しが成功したことを示します。値が false の場合、呼び出しが失敗したことを示します。

例

リクエスト例


http(s)://[Endpoint]/? Action=CreateGroupMetricRules
&GroupId=123456
&GroupMetricRules. 1.Category=ecs
&GroupMetricRules. 1.MetricName=cpu_total
&GroupMetricRules. 1.1amespace=acs_ecs_dashboard
&GroupMetricRules. 1.RuleId=bfae2ca5b4e07d2c7278772eccda169808c7b****
&GroupMetricRules. 1.RuleName=Alert rule 1
&<Common request parameters>

通常のレスポンス例

XML形式

<CreateGroupMetricRulesResponse>
  <RequestId>65D50468-ECEF-48F1-A6E1-D952E89D9436</RequestId>
  <Success>true</Success> 
  <Code>200</Code>
  <Resource>
    <AlertResults>
      <RuleId>xxxx1298766</RuleId>
      <Success>true</Success> 
      <RuleName>My rule name 1</RuleName>
      <Code>200</Code>
    </AlertResults>
    <AlertResults>
      <Message>Metric not found. </Message> 
      <RuleId>hyu91929****</RuleId>
      <Success>false</Success>
      <RuleName>RuleId 2</RuleName>
      <Code>404</Code> 
    </AlertResults>
  </Resource>
</CreateGroupMetricRulesResponse>

JSON 形式

{
	"RequestId":"65D50468-ECEF-48F1-A6E1-D952E89D9436",
	"Success":true,
	"Code": "200"
	"Resource":{
		"AlertResults":[
			{
				"RuleId":"xxxx1298766",
				"RuleName":"My rule name 1",
				"Success":true,
				"Code": "200"
			},
			{
				"Message":"Metric not found.",
				"RuleId":"hyu91929****",
				"RuleName":"RuleId 2",
				"Success":"false",
				"Code":"404"
			}
		]
	}
}

エラーコード

エラーコードを表示