Note #

A Note is a comment on an Event, and is used for incident management.

Package : spaceone.api.monitoring.v1

Note #

Note Methods:

Method	Request	Response
create	CreateNoteRequest	NoteInfo
update	UpdateNoteRequest	NoteInfo
delete	NoteRequest	Empty
get	NoteRequest	NoteInfo
list	NoteQuery	NotesInfo
stat	NoteStatQuery	Struct

create #

Creates a new Note. You can create Notes for each Alert to record the information needed to manage the Alerts.

POST /monitoring/v1/note/create

Request Example

CreateNoteRequest

alert_id (string) Required
note (string) Required

{
   "alert_id": "alert-160ce04f6908",
   "note": "This is a description",
}

Response Example

NoteInfo

note_id (string) Required
alert_id (string) Required
note (string) Required
created_by (string) Required
domain_id (string) Required
workspace_id (string) Required
project_id (string) Required
created_at (string) Required

{
   "note_id": "note-df107d31bf20",
   "alert_id": "alert-160ce04f6908",
   "note": "This is a description",
   "created_by": "seolmin@mz.co.kr",
   "project_id": "project-52a423012d5e",
   "domain_id": "domain-58010aa2e451",
   "created_at": "2022-06-29T08:26:14.418Z"
}

update #

Updates a specific Note. You must specify the note_id for Note validation check. If the Note exists, it is updated.

POST /monitoring/v1/note/update

Request Example

UpdateNoteRequest

note_id (string) Required
note (string)

{
   "note_id": "note-df107d31bf20",
   "note": "This is a test",
}

Response Example

NoteInfo

note_id (string) Required
alert_id (string) Required
note (string) Required
created_by (string) Required
domain_id (string) Required
workspace_id (string) Required
project_id (string) Required
created_at (string) Required

{
   "note_id": "note-df107d31bf20",
   "alert_id": "alert-160ce04f6908",
   "note": "This is a description",
   "created_by": "seolmin@mz.co.kr",
   "project_id": "project-52a423012d5e",
   "domain_id": "domain-58010aa2e451",
   "created_at": "2022-06-29T08:26:14.418Z"
}

delete #

Deletes a specific Note. You must specify the note_id of the Note to delete.

POST /monitoring/v1/note/delete

Request Example

NoteRequest

note_id (string) Required

{
   "note_id": "note-0bfac585bf5a",
}

get #

Gets a specific Note. You must specify the note_id and domain_id.

POST /monitoring/v1/note/get

Request Example

NoteRequest

note_id (string) Required

{
   "note_id": "note-0bfac585bf5a",
}

Response Example

NoteInfo

note_id (string) Required
alert_id (string) Required
note (string) Required
created_by (string) Required
domain_id (string) Required
workspace_id (string) Required
project_id (string) Required
created_at (string) Required

{
   "note_id": "note-df107d31bf20",
   "alert_id": "alert-160ce04f6908",
   "note": "This is a description",
   "created_by": "seolmin@mz.co.kr",
   "project_id": "project-52a423012d5e",
   "domain_id": "domain-58010aa2e451",
   "created_at": "2022-06-29T08:26:14.418Z"
}

list #

Gets a list of all Notes. You can use a query to get a filtered list of Notes.

POST /monitoring/v1/note/list

Request Example

NoteQuery

query (Query)
note_id (string)
alert_id (string)
created_by (string)
workspace_id (string)
project_id (string)

{
   "query": {},
   "domain_id": "domain-58010aa2e451"
}

Response Example

NotesInfo

results (NoteInfo) Repeated Required
total_count (int32) Required

{
   "results": [
       {
           "note_id": "note-0597bd748be0",
           "alert_id": "alert-fbfd78e43df8",
           "note": "http://spaceone.org",
           "created_by": "hykang@mz.co.kr",
           "project_id": "project-52a423012d5e",
           "domain_id": "domain-58010aa2e451",
           "created_at": "2022-06-23T09:58:23.838Z"
       },
       {
           "note_id": "note-0bfac585bf5a",
           "alert_id": "alert-fbfd78e43df8",
           "note": "test",
           "created_by": "hykang@mz.co.kr",
           "project_id": "project-52a423012d5e",
           "domain_id": "domain-58010aa2e451",
           "created_at": "2022-06-23T09:52:42.251Z"
       }
   ],
   "total_count": 2
}

stat #

POST /monitoring/v1/note/stat

Message #

CreateNoteRequest #

alert_id (string) Required
note (string) Required

NoteInfo #

note_id (string) Required
alert_id (string) Required
note (string) Required
created_by (string) Required
domain_id (string) Required
workspace_id (string) Required
project_id (string) Required
created_at (string) Required

NoteQuery #

query (Query)
note_id (string)
alert_id (string)
created_by (string)
workspace_id (string)
project_id (string)

NoteRequest #

note_id (string) Required

NoteStatQuery #

query (StatisticsQuery) Required

NotesInfo #

results (NoteInfo) Repeated Required
total_count (int32) Required

UpdateNoteRequest #

note_id (string) Required
note (string)