查看整合列表詳情。
調試
您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| IntegrationName |
string |
否 |
警示整合名稱。 |
CloudMonitor整合 |
| IntegrationProductType |
string |
是 |
整合產品類型：
|
CLOUD_MONITOR |
| Page |
integer |
是 |
查詢的頁數。 |
1 |
| Size |
integer |
是 |
每頁展示的警示整合數。 |
10 |
| IsDetail |
boolean |
否 |
是否展示整合詳情：
|
true |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
Schema of Response |
||
| 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 |
整合名稱。 |
CloudMonitor整合 |
| IntegrationProductType |
string |
整合產品類型：
|
CLOUD_MONITOR |
| ApiEndpoint |
string |
整合地址。 |
https://alerts.aliyuncs.com/api/v1/integrations/custom/ymQBN****** |
| ShortToken |
string |
整合 Token。 |
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 |
事件映射，將源欄位對應到目標欄位。 固定欄位對應，建立整合時預設產生的固定映射。 |
[ { "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 |
事件映射，將源欄位對應到目標欄位，拓展欄位增加映射。 |
[ { "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 |
樣本
正常返回樣本
JSON格式
{
"RequestId": "34ED024E-9E31-434A-9E4E-D9D15C3****",
"PageInfo": {
"Total": 1,
"Size": 10,
"Page": 1,
"Integrations": [
{
"IntegrationId": 1234,
"IntegrationName": "CloudMonitor整合",
"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"
}
}
]
}
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。