查看集成列表详情。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| IntegrationName |
string |
否 |
告警集成名称。 |
云监控集成 |
| 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 |
集成名称。 |
云监控集成 |
| 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 |
告警事件恢复字段。系统收到恢复事件后会根据恢复事件中的字段查询告警事件进行恢复。 说明
仅日志服务支持设置此参数。 |
$.status |
| InitiativeRecoverValue |
string |
告警事件恢复字段值。系统收到恢复事件后会根据恢复事件中的字段查询告警事件进行恢复。 说明
仅日志服务支持设置此参数。 |
ok |
示例
正常返回示例
JSON格式
{
"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"
}
}
]
}
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。