アラート統合のリストを表示します。
今すぐお試しください
テスト
RAM 認証
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| IntegrationName |
string |
任意 |
アラート統合の名前。 |
云监控集成 |
| IntegrationProductType |
string |
必須 |
アラート統合のタイプ。有効な値：
|
CLOUD_MONITOR |
| Page |
integer |
必須 |
返すページ番号。 |
1 |
| Size |
integer |
必須 |
各ページで返すアラート統合の数。 |
10 |
| IsDetail |
boolean |
任意 |
各アラート統合の詳細を表示するかどうかを指定します。
|
true |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
応答のスキーマ |
||
| RequestId |
string |
リクエスト ID。 |
34ED024E-9E31-434A-9E4E-D9D15C3**** |
| PageInfo |
object |
ページネーション情報。 |
|
| Total |
integer |
アラート統合の総数。 |
1 |
| Size |
integer |
ページごとに返されるアラート統合の数。 |
10 |
| Page |
integer |
返されたページのページ番号。 |
1 |
| Integrations |
array<object> |
各アラート統合に関する情報。 |
|
|
array<object> |
|||
| IntegrationId |
integer |
アラート統合の ID。 |
1234 |
| IntegrationName |
string |
アラート統合の名前。 |
云监控集成 |
| IntegrationProductType |
string |
アラート統合のタイプ。有効な値：
|
CLOUD_MONITOR |
| ApiEndpoint |
string |
アラート統合のエンドポイント。 |
https://alerts.aliyuncs.com/api/v1/integrations/custom/ymQBN****** |
| ShortToken |
string |
アラート統合の認証トークン。 |
ymQBN****** |
| State |
boolean |
アラート統合が有効化されているかどうかを示します。有効な値：
|
true |
| Liveness |
string |
アラート統合のアクティビティ。 |
ready |
| CreateTime |
string |
アラート統合が作成された時間。 |
2022-06-18 |
| IntegrationDetail |
object |
アラートイベントに関する情報。 |
|
| Description |
string |
アラート統合の説明。 |
测试 |
| DuplicateKey |
string |
値が重複排除されるフィールド。 |
LABEL.alertname::LABEL.severity |
| AutoRecover |
boolean |
アラートイベントが自動的にクリアされるかどうかを示します。有効な値：
|
true |
| RecoverTime |
integer |
アラートイベントが自動的にクリアされる時間。単位：秒。デフォルト値：300。 |
300 |
| Stat |
array |
過去 1 時間のアラートイベントの総数と異常なアラートイベントの数。 |
|
|
integer |
過去 1 時間のアラートイベントの総数と異常なアラートイベントの数。 |
[0,0] |
|
| FieldRedefineRules |
array<object> |
アラートソースの事前定義されたマッピングフィールド。 |
|
|
object |
事前定義されたマッピングフィールドは、ARMS のアラートフィールドにマッピングされます。これらのフィールドは、アラート統合の作成時に生成されます。 |
[ { "redefineType":"EXTRACT", "matchExpression":null, "fieldName":"alertname", "expression":null, "mappingRuleList":[ ], "name":"告警名称", "integrationId":1234, "jsonPath":"$.alertName", "id":10001, "fieldType":"LABEL" }, { "redefineType":"MAP", "matchExpression":null, "fieldName":"severity", "expression":null, "mappingRuleList":[ { "mappingValue":"critical", "mappingName":"P1", "mappingType":"MAP", "originValue":"CRITICAL" }, { "mappingValue":"error", "mappingName":"P2", "mappingType":"MAP", "originValue":"WARN" }, { "mappingValue":"warning", "mappingName":"P3", "mappingType":"MAP", "originValue":"INFO" } ], "name":"告警等级", "integrationId":1234, "jsonPath":"$.triggerLevel", "id":10002, "fieldType":"LABEL" }, { "redefineType":"EXTRACT", "matchExpression":null, "fieldName":"message", "expression":"{{$labels.namespace}} / {{$labels.dimensions}} 发生 {{ $labels.alertname }}, 当前值 {{$value}}。", "mappingRuleList":[ ], "name":"告警描述", "integrationId":1234, "jsonPath":null, "id":10003, "fieldType":"ANNOTATION" }, { "redefineType":"EXTRACT", "matchExpression":null, "fieldName":"value", "expression":null, "mappingRuleList":[ ], "name":"告警样本值", "integrationId":1234, "jsonPath":"$.curValue", "id":10004, "fieldType":"ANNOTATION" }, { "redefineType":"EXTRACT", "matchExpression":null, "fieldName":"source", "expression":null, "mappingRuleList":[ ], "name":"来源", "integrationId":1234, "jsonPath":null, "id":10007, "fieldType":"LABEL" }, { "redefineType":"ADD", "matchExpression":null, "fieldName":"generatorUrl", "expression":"https://cloudmonitor.console.alibabacloud.com/index.htm#/alarmInfo/name={{$labels.ruleId}}&searchValue=&searchType=name&searchProduct=/history/all/searchKey:{{$labels.ruleId}},startTime:{{sub $startsAt 300000}},endTime:{{$endsAt}}", "mappingRuleList":[ ], "name":"事件地址", "integrationId":1234, "jsonPath":"https://cloudmonitor.console.alibabacloud.com/index.htm#/alarmInfo/name={{$labels.ruleId}}&searchValue=&searchType=name&searchProduct=/history/all/searchKey:{{$labels.ruleId}},startTime:{{sub $startsAt 300000}},endTime:{{$endsAt}}", "id":10012, "fieldType":"GENERATE_URL" } ] |
|
| ExtendedFieldRedefineRules |
array<object> |
アラートソースの拡張マッピングフィールド。 |
|
|
object |
拡張マッピングフィールドは、ARMS のアラートフィールドにマッピングされます。 |
[ { "redefineType":"EXTRACT", "matchExpression":null, "fieldName":"dimensions", "expression":null, "mappingRuleList":[ ], "name":"dimensions", "integrationId":1234, "jsonPath":"$.dimensions", "id":10013, "fieldType":"LABEL" }, { "redefineType":"EXTRACT", "matchExpression":null, "fieldName":"expression", "expression":null, "mappingRuleList":[ ], "name":"expression", "integrationId":1234, "jsonPath":"$.expression", "id":10014, "fieldType":"LABEL" } ] |
|
| InitiativeRecoverField |
string |
アラートイベントをクリアするためのフィールドです。システムは、アラートクリアイベントのこのフィールドに基づいてアラートイベントをクエリし、クリアします。 説明
Log Service アラート統合のみがこのパラメーターをサポートします。 |
$.status |
| InitiativeRecoverValue |
string |
アラートイベントをクリアするためのフィールドの値です。システムは、アラートクリアイベントのこのフィールドに基づいてアラートイベントをクエリし、クリアします。 説明
Log Service アラート統合のみがこのパラメーターをサポートします。 |
ok |
例
成功レスポンス
JSONJSON
{
"RequestId": "34ED024E-9E31-434A-9E4E-D9D15C3****",
"PageInfo": {
"Total": 1,
"Size": 10,
"Page": 1,
"Integrations": [
{
"IntegrationId": 1234,
"IntegrationName": "云监控集成",
"IntegrationProductType": "CLOUD_MONITOR",
"ApiEndpoint": "https://alerts.aliyuncs.com/api/v1/integrations/custom/ymQBN******",
"ShortToken": "ymQBN******",
"State": true,
"Liveness": "ready",
"CreateTime": "2022-06-18",
"IntegrationDetail": {
"Description": "测试",
"DuplicateKey": "LABEL.alertname::LABEL.severity",
"AutoRecover": true,
"RecoverTime": 300,
"Stat": [
0
],
"FieldRedefineRules": [
[
{
"redefineType": "EXTRACT",
"matchExpression": null,
"fieldName": "alertname",
"expression": null,
"mappingRuleList": [],
"name": "告警名称",
"integrationId": 1234,
"jsonPath": "$.alertName",
"id": 10001,
"fieldType": "LABEL"
},
{
"redefineType": "MAP",
"matchExpression": null,
"fieldName": "severity",
"expression": null,
"mappingRuleList": [
{
"mappingValue": "critical",
"mappingName": "P1",
"mappingType": "MAP",
"originValue": "CRITICAL"
},
{
"mappingValue": "error",
"mappingName": "P2",
"mappingType": "MAP",
"originValue": "WARN"
},
{
"mappingValue": "warning",
"mappingName": "P3",
"mappingType": "MAP",
"originValue": "INFO"
}
],
"name": "告警等级",
"integrationId": 1234,
"jsonPath": "$.triggerLevel",
"id": 10002,
"fieldType": "LABEL"
},
{
"redefineType": "EXTRACT",
"matchExpression": null,
"fieldName": "message",
"expression": "{{$labels.namespace}} / {{$labels.dimensions}} 发生 {{ $labels.alertname }}, 当前值 {{$value}}。",
"mappingRuleList": [],
"name": "告警描述",
"integrationId": 1234,
"jsonPath": null,
"id": 10003,
"fieldType": "ANNOTATION"
},
{
"redefineType": "EXTRACT",
"matchExpression": null,
"fieldName": "value",
"expression": null,
"mappingRuleList": [],
"name": "告警样本值",
"integrationId": 1234,
"jsonPath": "$.curValue",
"id": 10004,
"fieldType": "ANNOTATION"
},
{
"redefineType": "EXTRACT",
"matchExpression": null,
"fieldName": "source",
"expression": null,
"mappingRuleList": [],
"name": "来源",
"integrationId": 1234,
"jsonPath": null,
"id": 10007,
"fieldType": "LABEL"
},
{
"redefineType": "ADD",
"matchExpression": null,
"fieldName": "generatorUrl",
"expression": "https://cloudmonitor.console.alibabacloud.com/index.htm#/alarmInfo/name={{$labels.ruleId}}&searchValue=&searchType=name&searchProduct=/history/all/searchKey:{{$labels.ruleId}},startTime:{{sub $startsAt 300000}},endTime:{{$endsAt}}",
"mappingRuleList": [],
"name": "事件地址",
"integrationId": 1234,
"jsonPath": "https://cloudmonitor.console.alibabacloud.com/index.htm#/alarmInfo/name={{$labels.ruleId}}&searchValue=&searchType=name&searchProduct=/history/all/searchKey:{{$labels.ruleId}},startTime:{{sub $startsAt 300000}},endTime:{{$endsAt}}",
"id": 10012,
"fieldType": "GENERATE_URL"
}
]
],
"ExtendedFieldRedefineRules": [
[
{
"redefineType": "EXTRACT",
"matchExpression": null,
"fieldName": "dimensions",
"expression": null,
"mappingRuleList": [],
"name": "dimensions",
"integrationId": 1234,
"jsonPath": "$.dimensions",
"id": 10013,
"fieldType": "LABEL"
},
{
"redefineType": "EXTRACT",
"matchExpression": null,
"fieldName": "expression",
"expression": null,
"mappingRuleList": [],
"name": "expression",
"integrationId": 1234,
"jsonPath": "$.expression",
"id": 10014,
"fieldType": "LABEL"
}
]
],
"InitiativeRecoverField": "$.status",
"InitiativeRecoverValue": "ok"
}
}
]
}
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。