コンテンツにスキップ

インシデントを作成¶

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"
}