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	google.protobuf.Empty
get	GetNoteRequest	NoteInfo
list	NoteQuery	NotesInfo
stat	NoteStatQuery	google.protobuf.Struct

create

POST /monitoring/v1/notes

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

Type	Message
Request	CreateNoteRequest
Response	NoteInfo

Request Example

{
    "alert_id": "alert-160ce04f6908",
    "note": "This is a description",
    "domain_id": "domain-58010aa2e451"
}

Response Example

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

update

PUT /monitoring/v1/note/{note_id}

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

Type	Message
Request	UpdateNoteRequest
Response	NoteInfo

Request Example

{
    "note_id": "note-df107d31bf20",
    "note": "This is a test",
    "domain_id": "domain-58010aa2e451"
}

Response Example

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

delete

DELETE /monitoring/v1/note/{note_id}

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

Type	Message
Request	NoteRequest
Response	google.protobuf.Empty

Request Example

{
    "note_id": "note-0bfac585bf5a",
    "domain_id": "domain-58010aa2e451"
}

get

GET /monitoring/v1/note/{note_id}

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

Type	Message
Request	GetNoteRequest
Response	NoteInfo

Request Example

{
    "note_id": "note-0bfac585bf5a",
    "domain_id": "domain-58010aa2e451"
}

Response Example

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

list

GET /monitoring/v1/notes

POST /monitoring/v1/notes/search

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

Type	Message
Request	NoteQuery
Response	NotesInfo

Request Example

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

Response Example

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

stat

POST /monitoring/v1/notes/stat

Type	Message
Request	NoteStatQuery
Response	google.protobuf.Struct

Message

CreateNoteRequest

Field	Type	Required	Description
alert_id	string	✔
note	string	✔
domain_id	string	✔

GetNoteRequest

Field	Type	Required	Description
note_id	string	✔
domain_id	string	✔
only	list of string	✘

NoteInfo

Field	Type	Description
note_id	string
alert_id	string
note	string
created_by	string
project_id	string
domain_id	string
created_at	string

NoteQuery

Field	Type	Required	Description
query	spaceone.api.core.v1.Query	✘
note_id	string	✘
alert_id	string	✘
created_by	string	✘
project_id	string	✘
domain_id	string	✘

NoteRequest

Field	Type	Required	Description
note_id	string	✔
domain_id	string	✔

NoteStatQuery

Field	Type	Required	Description
query	spaceone.api.core.v1.StatisticsQuery	✔
domain_id	string	✔

NotesInfo

Field	Type	Description
results	list of NoteInfo
total_count	int32

UpdateNoteRequest

Field	Type	Required	Description
note_id	string	✔
note	string	✘
domain_id	string	✔