文档

ListIntegration - 查看集成列表详情

更新时间:

查看集成列表详情。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
arms:ListIntegrationList
  • 全部资源
    *

请求参数

名称类型必填描述示例值
IntegrationNamestring

告警集成名称。

云监控集成
IntegrationProductTypestring

集成产品类型:

  • CLOUD_MONITOR:云监控
  • LOG_SERVICE:日志服务
CLOUD_MONITOR
Pagelong

查询的页数。

1
Sizelong

每页展示的告警集成数。

10
IsDetailboolean

是否展示集成详情:

  • true
  • false
true

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

34ED024E-9E31-434A-9E4E-D9D15C3****
PageInfoobject

分页信息。

Totallong

查询到的告警集成总数。

1
Sizelong

每页展示数量。

10
Pagelong

查询的页数。

1
Integrationsarray<object>

告警集成信息。

object
IntegrationIdlong

集成 ID。

1234
IntegrationNamestring

集成名称。

云监控集成
IntegrationProductTypestring

集成产品类型:

  • CLOUD_MONITOR:云监控
  • LOG_SERVICE:日志服务
CLOUD_MONITOR
ApiEndpointstring

集成地址。

https://alerts.aliyuncs.com/api/v1/integrations/custom/ymQBN******
ShortTokenstring

集成 Token。

ymQBN******
Stateboolean

告警集成是否启用:

  • true
  • false
true
Livenessstring

告警集成活跃度。

ready
CreateTimestring

告警集成创建时间。

2022-06-18
IntegrationDetailobject

集成详情对象信息。

Descriptionstring

告警集成描述信息。

测试
DuplicateKeystring

去重的字段。

LABEL.alertname::LABEL.severity
AutoRecoverboolean

告警事件是否自动恢复:

  • true(默认)
  • false
true
RecoverTimelong

告警事件自动恢复时间,默认时间为 300 秒。

300
Statarray

最近 1 小时总数及异常数。

long

最近 1 小时总数及异常数。

[0,0]
FieldRedefineRulesarray<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.aliyun.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.aliyun.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" } ]
ExtendedFieldRedefineRulesarray<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" } ]
InitiativeRecoverFieldstring

告警事件恢复字段。系统收到恢复事件后会根据恢复事件中的字段查询告警事件进行恢复。

说明 仅日志服务支持设置此参数。
$.status
InitiativeRecoverValuestring

告警事件恢复字段值。系统收到恢复事件后会根据恢复事件中的字段查询告警事件进行恢复。

说明 仅日志服务支持设置此参数。
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.aliyun.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.aliyun.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"
        }
      }
    ]
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2022-08-11OpenAPI 返回结构发生变更查看变更详情