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

{{< tabs " create " >}}

{{< tab "Request Example" >}}

CreateNoteRequest

• alert_id (string) Required

• note (string) Required

{{< highlight json >}} { "alert_id": "alert-160ce04f6908", "note": "This is a description", } {{< /highlight >}} {{< /tab >}}

{{< tab "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

{{< highlight json >}} { "note_id": "note-df107d31bf20", "alert_id": "alert-160ce04f6908", "note": "This is a description", "created_by": "[e-mail]", "project_id": "project-52a423012d5e", "domain_id": "domain-58010aa2e451", "created_at": "2022-06-29T08:26:14.418Z" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

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

{{< tabs " update " >}}

{{< tab "Request Example" >}}

UpdateNoteRequest

• note_id (string) Required

• note (string)

{{< highlight json >}} { "note_id": "note-df107d31bf20", "note": "This is a test", } {{< /highlight >}} {{< /tab >}}

{{< tab "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

{{< highlight json >}} { "note_id": "note-df107d31bf20", "alert_id": "alert-160ce04f6908", "note": "This is a description", "created_by": "[e-mail]", "project_id": "project-52a423012d5e", "domain_id": "domain-58010aa2e451", "created_at": "2022-06-29T08:26:14.418Z" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

delete

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

POST /monitoring/v1/note/delete

{{< tabs " delete " >}}

{{< tab "Request Example" >}}

NoteRequest

• note_id (string) Required

{{< highlight json >}} { "note_id": "note-0bfac585bf5a", } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

get

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

POST /monitoring/v1/note/get

{{< tabs " get " >}}

{{< tab "Request Example" >}}

NoteRequest

• note_id (string) Required

{{< highlight json >}} { "note_id": "note-0bfac585bf5a", } {{< /highlight >}} {{< /tab >}}

{{< tab "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

{{< highlight json >}} { "note_id": "note-df107d31bf20", "alert_id": "alert-160ce04f6908", "note": "This is a description", "created_by": "[e-mail]", "project_id": "project-52a423012d5e", "domain_id": "domain-58010aa2e451", "created_at": "2022-06-29T08:26:14.418Z" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

list

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

POST /monitoring/v1/note/list

{{< tabs " list " >}}

{{< tab "Request Example" >}}

NoteQuery

• query (Query)

• note_id (string)

• alert_id (string)

• created_by (string)

• workspace_id (string)

• project_id (string)

{{< highlight json >}} { "query": {}, "domain_id": "domain-58010aa2e451" } {{< /highlight >}} {{< /tab >}}

{{< tab "Response Example" >}}

NotesInfo

• results (NoteInfo) Repeated Required

• total_count (int32) Required

{{< highlight json >}} { "results": [ { "note_id": "note-0597bd748be0", "alert_id": "alert-fbfd78e43df8", "note": "http://spaceone.org", "created_by": "[e-mail]", "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": "[e-mail]", "project_id": "project-52a423012d5e", "domain_id": "domain-58010aa2e451", "created_at": "2022-06-23T09:52:42.251Z" } ], "total_count": 2 } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

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)