SpaceONE APIs
Latest Version
Latest Version
  • README
  • Board
    • V1
      • Board
      • Post
  • Config
    • V1
      • Domain Config
      • User Config
  • Core
    • V1
      • Handler
      • Query
      • Server Info
  • Cost Analysis
    • Plugin
      • Cost
      • Data Source
      • Job
    • V1
      • Budget
      • Budget Usage
      • Cost
      • Cost Query Set
      • Custom Widget
      • Data Source
      • Data Source Rule
      • Exchange Rate
      • Job
      • Job Task
      • Public Dashboard
      • Schedule
      • User Dashboard
  • Identity
    • Plugin
      • Auth
    • V1
      • Api Key
      • Authorization
      • Domain
      • Domain Owner
      • Endpoint
      • Policy
      • Project
      • Project Group
      • Provider
      • Role
      • Role Binding
      • Service Account
      • Token
      • User
  • Inventory
    • Plugin
      • Collector
    • V1
      • Change History
      • Cloud Service
      • Cloud Service Type
      • Collector
      • Job
      • Job Task
      • Note
      • Region
      • Resource Group
      • Server
  • Monitoring
    • Plugin
      • Data Source
      • Event
      • Log
      • Metric
      • Webhook
    • V1
      • Alert
      • Data Source
      • Escalation Policy
      • Event
      • Event Rule
      • Log
      • Maintenance Window
      • Metric
      • Note
      • Project Alert Config
      • Webhook
  • Notification
    • Plugin
      • Notification
      • Protocol
    • V1
      • Notification
      • Notification Usage
      • Project Channel
      • Protocol
      • Quota
      • User Channel
  • Plugin
    • V1
      • Plugin
      • Supervisor
  • Repository
    • V1
      • Plugin
      • Policy
      • Repository
      • Schema
  • Sample
    • V1
      • Helloworld
  • Secret
    • V1
      • Secret
      • Secret Group
  • Statistics
    • Plugin
      • Storage
    • V1
      • History
      • Resource
      • Schedule
      • Storage
Powered by GitBook
On this page
  • Note
  • create
  • update
  • delete
  • get
  • list
  • stat
  • Message
  • CreateNoteRequest
  • GetNoteRequest
  • NoteInfo
  • NoteQuery
  • NoteRequest
  • NoteStatQuery
  • NotesInfo
  • UpdateNoteRequest

Was this helpful?

  1. Monitoring
  2. V1

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

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

Response

{
    "alert_id": "alert-160ce04f6908",
    "note": "This is a description",
    "domain_id": "domain-58010aa2e451"
}
{
    "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

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

Response

{
    "note_id": "note-df107d31bf20",
    "note": "This is a test",
    "domain_id": "domain-58010aa2e451"
}
{
    "note_id": "note-df107d31bf20",
    "alert_id": "alert-160ce04f6908",
    "note": "This is a test",
    "created_by": "seolmin@mz.co.kr",
    "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

Response

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

Response

{
    "note_id": "note-0bfac585bf5a",
    "domain_id": "domain-58010aa2e451"
}
{
    "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"
}

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

Response

{
    "query": {},
    "domain_id": "domain-58010aa2e451"
}
{
    "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/notes/stat

Type
Message

Request

Response

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

✘

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

✔

domain_id

string

✔

NotesInfo

Field
Type
Description

results

total_count

UpdateNoteRequest

Field
Type
Required
Description

note_id

string

✔

note

string

✘

domain_id

string

✔

PreviousMetricNextProject Alert Config

Last updated 2 years ago

Was this helpful?

google.protobuf.Empty
google.protobuf.Struct
google.protobuf.Empty
google.protobuf.Struct
spaceone.api.core.v1.Query
spaceone.api.core.v1.StatisticsQuery
int32
create
CreateNoteRequest
NoteInfo
update
UpdateNoteRequest
NoteInfo
delete
NoteRequest
get
GetNoteRequest
NoteInfo
list
NoteQuery
NotesInfo
stat
NoteStatQuery
CreateNoteRequest
NoteInfo
UpdateNoteRequest
NoteInfo
NoteRequest
GetNoteRequest
NoteInfo
NoteQuery
NotesInfo
NoteStatQuery
list of NoteInfo