編集¶
POST /api/v1/incidents/{incident_uuid}/modify
概要¶
ルートパラメータ¶
| パラメータ名 | タイプ | 必須 | 説明 |
|---|---|---|---|
| incident_uuid | string | Y | インシデントUUID 空を許可: False |
Body リクエストパラメータ¶
| パラメータ名 | タイプ | 必須 | 説明 |
|---|---|---|---|
| name | string | インシデント名 例: name 空を許可: False 最大長: 256 |
|
| description | string | インシデント説明 空を許可: True 例: description |
|
| level | string | インシデントレベルに対応するUUID 空を許可: False 例: system_level_0 |
|
| assigner | array | 担当者に対応するUUIDリスト 空を許可: False 例: ['acnt_xxxx32'] |
|
| incidentsStatus | string | インシデントステータス 空を許可: False 例: working 選択可能値: ['open', 'working', 'resolved', 'closed'] |
|
| 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 | N | インシデント名 |
| description | string | N | インシデント説明 |
| level | string | N | インシデントレベルに対応するUUID |
| assigner | array | N | 担当者に対応するUUIDリスト |
| incidentsStatus | string | N | インシデントステータス |
| resourceURL | string | N | ソースURL。詳細表示時に該当URLへ遷移できます |
| tags | array | N | タグ名リスト |
| dimensionTag | json | N | カスタムディメンションタグ、デフォルトは{} |
| attachmentUUIDs | array | N | 添付ファイルUUIDリスト |
| extend | json | N | 追加拡張情報 |
拡張フィールド extend の説明
| パラメータ名 | タイプ | 必須 | パラメータ説明 |
|---|---|---|---|
| linkList | array | N | インシデントリンクを追加 |
extend フィールドの例:
リクエスト例¶
curl 'https://openapi.guance.com/api/v1/issue/issue_xxxx32/modify' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{"incidentsStatus":"working"}'\
--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": "working",
"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"
}