Mengkueri detail daftar integrasi.
Coba sekarang
Test
RAM authorization
Parameter permintaan
|
Parameter |
Type |
Required |
Description |
Example |
| IntegrationName |
string |
No |
Nama integrasi alert. |
云监控集成 |
| IntegrationProductType |
string |
Yes |
Tipe produk integrasi. Nilai valid:
|
CLOUD_MONITOR |
| Page |
integer |
Yes |
Nomor halaman kueri. |
1 |
| Size |
integer |
Yes |
Jumlah integrasi alert yang ditampilkan pada setiap halaman. |
10 |
| IsDetail |
boolean |
No |
Apakah akan menampilkan detail integrasi. Nilai valid:
|
true |
Elemen respons
|
Element |
Type |
Description |
Example |
|
object |
Skema Tanggapan. |
||
| RequestId |
string |
ID permintaan. |
34ED024E-9E31-434A-9E4E-D9D15C3**** |
| PageInfo |
object |
Informasi paginasi. |
|
| Total |
integer |
Jumlah total integrasi alert yang dikembalikan. |
1 |
| Size |
integer |
Jumlah entri yang ditampilkan pada setiap halaman. |
10 |
| Page |
integer |
Nomor halaman kueri. |
1 |
| Integrations |
array<object> |
Informasi integrasi alert. |
|
|
array<object> |
|||
| IntegrationId |
integer |
The ID of the alert integration. |
1234 |
| IntegrationName |
string |
The name of the alert integration. |
云监控集成 |
| IntegrationProductType |
string |
The type of the alert integration. Valid values:
|
CLOUD_MONITOR |
| ApiEndpoint |
string |
The endpoint of the alert integration. |
https://alerts.aliyuncs.com/api/v1/integrations/custom/ymQBN****** |
| ShortToken |
string |
The authentication token of the alert integration. |
ymQBN****** |
| State |
boolean |
Indicates whether the alert integration was enabled. Valid values:
|
true |
| Liveness |
string |
The activity of the alert integration |
ready |
| CreateTime |
string |
The time when the alert integration was created. |
2022-06-18 |
| IntegrationDetail |
object |
The information about the alert events. |
|
| Description |
string |
The description of the alert integration. |
测试 |
| DuplicateKey |
string |
The fields whose values are deduplicated. |
LABEL.alertname::LABEL.severity |
| AutoRecover |
boolean |
Indicates whether alert events are automatically cleared. Valid values:
|
true |
| RecoverTime |
integer |
The time when alert events are automatically cleared. Unit: seconds. Default value: 300. |
300 |
| Stat |
array |
The total number of alert events and the number of abnormal alert events in the last hour. |
|
|
integer |
The total number of alert events and the number of abnormal alert events in the last hour. |
[0,0] |
|
| FieldRedefineRules |
array<object> |
The predefined mapped fields of the alert source. |
|
|
object |
The predefined mapped fields are mapped to the fields of ARMS alerts. The predefined mapped fields were generated when the alert integration was created. |
[ { "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> |
The extended mapped fields of the alert source. |
|
|
object |
The extended mapped fields are mapped to the fields of ARMS alerts. |
[ { "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 |
The field for clearing alert events. The system queries alert events based on the field of alert clearing events and clears the alert events. Catatan
Only the Log Service alert integration supports the parameter. |
$.status |
| InitiativeRecoverValue |
string |
The value of the field for clearing alert events. The system queries alert events based on the field of alert clearing events and clears the alert events. Catatan
Only the Log Service alert integration supports the parameter. |
ok |
Contoh
Respons sukses
JSONformat
{
"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"
}
}
]
}
}Kode kesalahan
Lihat Error Codes untuk daftar lengkap.
Catatan rilis
Lihat Release Notes untuk daftar lengkap.