この操作では、イベントアラートの一覧を照会します。
デバッグ
API Explorer を使用してデバッグを実行できます。 API Explorer では、さまざまな操作を行ってAPI の使用を簡素化することができます。 たとえば、API の呼び出し、SDK サンプル コードの動的な生成、API の取得をすることができます。
リクエストパラメーター
パラメーター | データ型 | 必須/省略可能 | 例 | 説明 |
---|---|---|---|---|
Action | String | 必須 | DescribeEventRuleList |
実行する操作。 値を DescribeEventRuleList に設定します。 |
GroupId | String | 省略可能 | 12345 |
アプリケーショングループの ID 。 |
NamePrefix | String | 省略可能 | test |
アラートルールの名前のプレフィックス。 あいまい検索がサポートされています。 |
PageNumber | String | 省略可能 | 1 |
現在のページの番号。 既定値: 1 。 |
PageSize | String | 省略可能 | 10 |
各ページのレコード数。 |
レスポンスパラメーター
パラメーター | データ型 | 例 | 説明 |
---|---|---|---|
Code | String | 200 |
HTTP ステータスコード。 値が 200 の場合、呼び出しが成功したことを示します。 |
EventRules |
イベントルール。 |
||
└Description | String | event |
ルールの説明。 |
└EventPattern |
イベントルール。 |
||
└EventTypeList | Exception |
イベントの種類。 |
|
└LevelList | ["CRITICAL", "WARN", "INFO"] |
イベントのレベル。 有効値 : CRITICAL WARN INFO |
|
└NameList | ["Agent_Status_Stopped"] |
イベント名のリスト。 |
|
└Product | String | CloudMonitor |
サービス名の省略形。 |
└EventType | String | SYSTEM |
イベントの種類。 有効値 : SYSTEM、CUSTOM。 |
└GroupId | String | 12345 |
アプリケーショングループの ID 。 |
└Name | String | evnetName |
ルールの名前。 |
└State | String | ENABLED |
ルールのステータス。 値が ENABLED の場合、ルールが有効になっていることを示します。 値が DISABLED の場合、ルールが無効になっていることを示します。 |
Message | String | success |
エラーメッセージ。 |
RequestId | String | D0E6D82B-16B5-422A-8136-EE5BDC01E415 |
トラブルシューティングのリクエスト ID。 |
Success | Boolean | true |
呼び出しが成功したかを示します。 値が true の場合、呼び出しが成功したことを示します。 値が false の場合、呼び出しが失敗したことを示します。 |
Total | Integer | 21 |
返されるレコードの合計。 |
例
リクエスト例
http(s)://[Endpoint]/? Action=DescribeEventRuleList
&<Common request parameters>
通常のレスポンス例
XML
形式
<DescribeEventRuleListResponse>
<Datapoints>
<EventRule>
<Name>aaabbb</Name>
<State>ENABLED</State>
<EventPattern>
<EventTypeList>
<EventTypeList>Exception</EventTypeList>
</EventTypeList>
<Product>CloudMonitor</Product>
<LevelList>
<LevelList>*</LevelList>
</LevelList>
<NameList>
<NameList>Alert_SendShortMessageFailed_QuotaReached</NameList>
<NameList>Group_AddResourcesFailed_QuotaReached</NameList>
<NameList>Agent_Status_Stopped</NameList>
<NameList>Agent_Status_Running</NameList>
</NameList>
</EventPattern>
<EventType>SYSTEM</EventType>
</EventRule>
<EventRule>
<Name>default_group_event_rule_3384581</Name>
<Description>Default group event rule</Description>
<State>ENABLED</State>
<EventPattern>
<Product>*</Product>
<LevelList>
<LevelList>CRITICAL</LevelList>
<LevelList>WARN</LevelList>
</LevelList>
<NameList>
<NameList>*</NameList>
</NameList>
</EventPattern>
<EventType>SYSTEM</EventType>
<GroupId>338****</GroupId>
</EventRule>
</Datapoints>
<RequestId>D0E6D82B-16B5-422A-8136-EE5BDC01E415</RequestId>
<Success>true</Success>
<Code>200</Code>
<Total>20</Total>
</DescribeSiteMonitorListResponse>
JSON
形式
{
"Datapoints":{
"EventRule":[
{
"Name":"aaabbb",
"State":"ENABLED",
"EventPattern":{
"EventTypeList":{
"EventTypeList":[
"Exception"
]
},
"Product":"CloudMonitor",
"LevelList":{
"LevelList":[
"*"
]
},
"NameList":{
"NameList":[
"Alert_SendShortMessageFailed_QuotaReached",
"Group_AddResourcesFailed_QuotaReached",
"Agent_Status_Stopped",
"Agent_Status_Running"
]
}
},
"EventType":"SYSTEM"
},
{
"Name":"default_group_event_rule_3384581",
"Description":"Default group event rule",
"State":"ENABLED",
"EventPattern":{
"Product":"*",
"LevelList":{
"LevelList":[
"CRITICAL",
"WARN"
]
},
"NameList":{
"NameList":[
"*"
]
}
},
"EventType":"SYSTEM",
"GroupId":"338****"
}
]
},
"RequestId":"D0E6D82B-16B5-422A-8136-EE5BDC01E415",
"Success":true,
"Code": "200"
"Total":20
}