跳转至

新建



POST /api/v1/incidents/add

概述

Body 请求参数

参数名 类型 必选 说明
name string Y 故障名称
例子: name
允许为空: False
最大长度: 256
description string 故障描述
允许为空: True
例子: description
level string Y 故障等级对应的uuid
允许为空: False
例子: system_level_0
resourceURL string 资源URL
允许为空: False
例子: http://xxxxxx
tags array 标签名称列表
允许为空: False
例子: ['aaa', 'bbb']
dimensionTag json 维度标签
允许为空: False
例子: {'host': '127.0.0.1'}
attachmentUUIDs array 附件uuid列表
允许为空: False
例子: ['attachment_xxxx']
extend json 额外拓展信息
允许为空: False
例子: {}

参数补充说明

基本参数说明

参数名 参数类型 是否必填 参数说明
name string Y 故障名称
description string N 故障描述
level string Y 故障等级对应的uuid
resourceURL string N 来源URL,详情展示时可以跳转到对应的URL
tags array N 标签名称列表
dimensionTag json N 自定义维度标签,默认传{}
attachmentUUIDs array N 附件uuid列表
extend json N 额外拓展信息

扩展字段 extend 说明

参数名 参数类型 是否必填 参数说明
linkList array N 添加链接

extend 字段示例:

{
    "linkList": [
        {
            "name": "测试",
            "link": "https://xxxx",
        }
    ]
}

请求例子

curl 'https://openapi.guance.com/api/v1/incidents/add' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{"name":"test3","description":"描述","level":"system_level_0","tags":["test"]}'\
--compressed

响应

{
    "code": 200,
    "content": {
        "assigner": [],
        "createAt": 1768981791,
        "creator": "acnt_xxxx",
        "cumulativeTime": 0,
        "deleteAt": -1,
        "description": "描述",
        "dimensionTag": {},
        "dtAppId": "",
        "dtAppName": "",
        "dtEnv": "",
        "dtHost": "",
        "dtPodName": "",
        "dtResource": "",
        "dtService": "",
        "dtUrl": "",
        "eventCount": 0,
        "eventUpdateAt": 0,
        "extend": {},
        "id": null,
        "incidentsStatus": "open",
        "level": "system_level_0",
        "name": "test3",
        "resourceCategory": "",
        "resourceContent": {},
        "resourceIdentity": "",
        "resourceType": "",
        "resourceUUID": "",
        "resourceUrl": "",
        "source": "external",
        "status": 0,
        "statusChangeTime": 1768981791,
        "statusTime": {
            "open": 1768981791
        },
        "tagInfo": [
            {
                "id": "tag_xxx",
                "name": "test",
                "uuid": "tag_xxxx"
            }
        ],
        "updateAt": -1,
        "updator": "",
        "uuid": "incident_xxxx",
        "workspaceUUID": "wksp_xxx"
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "xxxxx"
} 

文档评价

文档内容是否对您有帮助? ×