This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Models

1 - AgentDownloadLinkResponse

NameDescriptionSchemaDefault
download_link
required
URL to download agent
Example : https://object-store.private.{region}.{environment}.samsungsdscloud.com/account:swt-agent/latest/ServiceWatch_Agent.zip
string

2 - AlertActivatedSetRequest

NameDescriptionSchemaDefault
activated_yn
required
Whether the Alert is activated or not
Example : Y
enum (N, Y)

3 - AlertActivatedSetResponse

NameDescriptionSchemaDefault
activated_yn
required
Whether the Alert is activated or not
Example : Y
enum (N, Y)
id
required
Alert ID
Example : 3234bd0f12fa4d0b97ab9feff6c09b8e
string
modified_at
required
Modified date time
Example : 2026-06-24T10:14:52.734074
string (date-time)

4 - AlertCreateRequest

NameDescriptionSchemaDefault
description
optional
Alert Description
Example : Description for Alert Test
any of [string, null]
dimension
optional
Dimension
any of [DimensionDTO, null]
dimensions
optional
List of Dimensions
any of [array[DimensionDTO], null]
evaluation_count
optional
Evaluation Count for the Alert Condition
Example : 3
integer1
individual_items
optional
List of Individual Items
any of [array[MetricIndividualItemDto], null]
level
required
Alert Level - HIGH, MIDDLE, LOW
Example : HIGH
enum (HIGH, MIDDLE, LOW)
lower_bound
optional
Lower bound for the Alert range operator
Example : 80.0
any of [object, null]
metric_id
required
Metric ID
Example : f13aab3b88c341b2bc73f8925a0e8cc5
string
missing_data_option
optional
Missing Data Option - MISSING, BREACHING, NOT_BREACHING, IGNORE
Example : BREACHING
any of [enum (MISSING, BREACHING, NOT_BREACHING, IGNORE), null]IGNORE
name
required
Alert Name
Example : Alert Test
Minimum length : 3
Maximum length : 100
string
namespace_id
required
Namespace ID
Example : 1d9d05af5c624f2cb80a45f2c911e2f4
string
operator
required
Operator - EQ, NOT_EQ, GT, GTE, LT, LTE, RANGE
Example : RANGE
enum (GTE, GT, LTE, LT, EQ, NOT_EQ, RANGE)
period
required
Period (seconds)
Example : 300
integer
recipient_ids
optional
List of User IDs
Example : ['1234da92-634a-4f8c-932e-9d650599ab1b', '1234da92-634a-4f8c-932e-9d650599ab1a', '1234da92-634a-4f8c-932e-9d650599ab1c']
any of [array[string], null]
statistic
required
Statistic - SUM, AVG, MAX, MIN
Example : AVG
enum (AVG, SUM, MAX, MIN, CNT)
tags
optional
List of Tags
any of [array[TagDTO], null]
threshold
optional
Threshold for the Alert Condition (except fro RANGE operator)
Example : 80.0
any of [object, null]
upper_bound
optional
Upper bound for the Alert range operator
Example : 90.0
any of [object, null]
violation_count
optional
Violation Count for the Alert Condition
Example : 2
integer1

5 - AlertCreateResponse

NameDescriptionSchemaDefault
created_at
required
Created date time
Example :
string (date-time)
created_by
required
Creator ID
Example : f4b8a4c4017f4f8d8399f0c02582ae47
string
id
required
Alert ID
Example : 3234bd0f12fa4d0b97ab9feff6c09b8e
string

6 - AlertDeleteRequest

NameDescriptionSchemaDefault
ids
required
List of Alert IDs
Example : ['3234bd0f12fa4d0b97ab9feff6c09b8e']
array[string]

7 - AlertDeleteResponse

NameDescriptionSchemaDefault
ids
required
List of Alert IDs
Example : ['3234bd0f12fa4d0b97ab9feff6c09b8e']
array[string]

8 - AlertDescriptionSetRequest

NameDescriptionSchemaDefault
description
optional
Alert Description
Example : Description for Alert Test
Maximum length : 1000
string

9 - AlertDescriptionSetResponse

NameDescriptionSchemaDefault
description
required
Alert Description
Example : Description for Alert Test
any of [string, null]
id
required
Alert ID
Example : 3234bd0f12fa4d0b97ab9feff6c09b8e
string
modified_at
required
Modified date time
Example : 2026-06-24T10:14:52.733269
string (date-time)

10 - AlertDetailResponse

NameDescriptionSchemaDefault
activated_yn
required
Whether the Alert is activated or not
Example : Y
enum (N, Y)
created_at
required
Created date time
Example :
string (date-time)
created_by
required
Creator ID
Example : f4b8a4c4017f4f8d8399f0c02582ae47
string
description
required
Alert Description
Example : Description for Alert Test
any of [string, null]
dimension
required
Dimension
DimensionDTO
dimensions
required
List of Dimensions
array[DimensionDTO]
evaluation_count
required
Evaluation Count for the Alert Condition
Example : 3
integer
evaluation_time_window
required
Evaluation Time Window (period * evaluation_count)
Example : 900
integer
individual_items
required
List of Individual Items
any of [array[MetricIndividualItemDto], null]
last_policy_updated_at
required
Last Alert Policy Updated Date Time
Example :
string (date-time)
level
required
Alert Level - HIGH, MIDDLE, LOW
Example : HIGH
enum (HIGH, MIDDLE, LOW)
lower_bound
required
Lower bound for the Alert range operator
Example : 80.0
any of [object, null]
metric_id
required
Metric ID
Example : f13aab3b88c341b2bc73f8925a0e8cc5
string
metric_name
optional
Metric Name
Example : CPU Usage
string
metric_unit
optional
Metric Unit. Allowed Units: SECONDS, MICROSECONDS, MILLISECONDS, BYTES, KILOBYTES, MEGABYTES, GIGABYTES, TERABYTES, BITS, KILOBITS, MEGABITS, GIGABITS, TERABITS, PERCENT, COUNT, BYTES_PER_SECOND, KILOBYTES_PER_SECOND, MEGABYTES_PER_SECOND, GIGABYTES_PER_SECOND, TERABYTES_PER_SECOND, BITS_PER_SECOND, KILOBITS_PER_SECOND, MEGABITS_PER_SECOND, GIGABITS_PER_SECOND, TERABITS_PER_SECOND, COUNT_PER_SECOND, COUNT_PER_MINUTE, NONE
Example : BYTE
string
missing_data_option
required
Missing Data Option - MISSING, BREACHING, NOT_BREACHING, IGNORE
Example : BREACHING
enum (MISSING, BREACHING, NOT_BREACHING, IGNORE)
modified_at
required
Modified date time
Example :
string (date-time)
modified_by
required
Modifier ID
Example : f4b8a4c4017f4f8d8399f0c02582ae47
string
name
required
Alert Name
Example : Alert Test
string
namespace_id
required
Namespace ID
Example : 1d9d05af5c624f2cb80a45f2c911e2f4
string
namespace_name
optional
Namespace Name
Example : Virtual Server
string
operator
required
Operator - EQ, NOT_EQ, GT, GTE, LT, LTE, RANGE
Example : RANGE
enum (GTE, GT, LTE, LT, EQ, NOT_EQ, RANGE)
period
required
Period (seconds)
Example : 300
integer
srn
required
SDS cloud Resource Name of the Alert
Example : srn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::scp-servicewatch:alert/0ad6da92-634a-4f8c-932e-9d650599ab1e
string
state
required
Alert State - NORMAL, ALERT, INSUFFICIENT_DATA
Example : NORMAL
enum (INSUFFICIENT_DATA, NORMAL, ALERT)
statistic
required
Statistic - SUM, AVG, MAX, MIN
Example : AVG
enum (AVG, SUM, MAX, MIN, CNT)
threshold
required
Threshold for the Alert Condition (except fro RANGE operator)
Example : 80.0
any of [object, null]
type
required
Alert Type
Example : METRIC_ALERT
enum (METRIC_ALERT, SERVICE_ALERT, COMPOSITE_ALERT)
upper_bound
required
Upper bound for the Alert range operator
Example : 90.0
any of [object, null]
violation_count
required
Violation Count for the Alert Condition
Example : 2
integer

11 - AlertDetailResponseV1Dot3

NameDescriptionSchemaDefault
activated_yn
required
Whether the Alert is activated or not
Example : Y
enum (N, Y)
created_at
required
Created date time
Example :
string (date-time)
created_by
required
Creator ID
Example : f4b8a4c4017f4f8d8399f0c02582ae47
string
description
required
Alert Description
Example : Description for Alert Test
any of [string, null]
dimension
required
Dimension
DimensionDTO
dimensions
required
List of Dimensions
array[DimensionDTO]
evaluation_count
required
Evaluation Count for the Alert Condition
Example : 3
integer
evaluation_time_window
required
Evaluation Time Window (period * evaluation_count)
Example : 900
integer
individual_items
required
List of Individual Items
any of [array[MetricIndividualItemDto], null]
last_policy_updated_at
required
Last Alert Policy Updated Date Time
Example :
string (date-time)
level
required
Alert Level - HIGH, MIDDLE, LOW
Example : HIGH
enum (HIGH, MIDDLE, LOW)
lower_bound
required
Lower bound for the Alert range operator
Example : 80.0
any of [object, null]
metric_id
required
Metric ID
Example : f13aab3b88c341b2bc73f8925a0e8cc5
string
metric_name
optional
Metric Name
Example : CPU Usage
string
metric_unit
optional
Metric Unit. Allowed Units: SECONDS, MICROSECONDS, MILLISECONDS, BYTES, KILOBYTES, MEGABYTES, GIGABYTES, TERABYTES, BITS, KILOBITS, MEGABITS, GIGABITS, TERABITS, PERCENT, COUNT, BYTES_PER_SECOND, KILOBYTES_PER_SECOND, MEGABYTES_PER_SECOND, GIGABYTES_PER_SECOND, TERABYTES_PER_SECOND, BITS_PER_SECOND, KILOBITS_PER_SECOND, MEGABITS_PER_SECOND, GIGABITS_PER_SECOND, TERABITS_PER_SECOND, COUNT_PER_SECOND, COUNT_PER_MINUTE, NONE
Example : BYTE
string
missing_data_option
required
Missing Data Option - MISSING, BREACHING, NOT_BREACHING, IGNORE
Example : BREACHING
enum (MISSING, BREACHING, NOT_BREACHING, IGNORE)
modified_at
required
Modified date time
Example :
string (date-time)
modified_by
required
Modifier ID
Example : f4b8a4c4017f4f8d8399f0c02582ae47
string
name
required
Alert Name
Example : Alert Test
string
namespace_id
required
Namespace ID
Example : 1d9d05af5c624f2cb80a45f2c911e2f4
string
namespace_name
optional
Namespace Name
Example : Virtual Server
string
operator
required
Operator - EQ, NOT_EQ, GT, GTE, LT, LTE, RANGE
Example : RANGE
enum (GTE, GT, LTE, LT, EQ, NOT_EQ, RANGE)
period
required
Period (seconds)
Example : 300
integer
srn
required
SDS cloud Resource Name of the Alert
Example : srn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::scp-servicewatch:alert/0ad6da92-634a-4f8c-932e-9d650599ab1e
string
state
required
Alert State - NORMAL, ALERT, INSUFFICIENT_DATA
Example : NORMAL
enum (INSUFFICIENT_DATA, NORMAL, ALERT)
statistic
required
Statistic - SUM, AVG, MAX, MIN
Example : AVG
enum (AVG, SUM, MAX, MIN, CNT)
threshold
required
Threshold for the Alert Condition (except fro RANGE operator)
Example : 80.0
any of [object, null]
timestamp
required
Timestamp
Example : 2025-08-15T11:04:00.000+0000
any of [string (date-time), null]
type
required
Alert Type
Example : METRIC_ALERT
enum (METRIC_ALERT, SERVICE_ALERT, COMPOSITE_ALERT)
upper_bound
required
Upper bound for the Alert range operator
Example : 90.0
any of [object, null]
violation_count
required
Violation Count for the Alert Condition
Example : 2
integer

12 - AlertLevelCountsByServiceDTOV1Dot4

NameDescriptionSchemaDefault
HIGH
required
Count of HIGH Level
Example : 10
integer
LOW
required
Count of LOW Level
Example : 64
integer
MIDDLE
required
Count of MIDDLE Level
Example : 6
integer
dashboard_id
required
Dashboard’s unique ID
Example : 06565dbb67544154b1eabe81658a2e83
string
favorite_enabled
optional
Favorite Enabled
Example : True
boolean
namespace_id
required
Namespace ID
Example : 1d9d05af5c624f2cb80a45f2c911e2f4
string
namespace_name
required
Namespace Name
Example : Virtual Server
string
service_code
required
Service code
Example : virtualserver
string
service_menu_name
required
Service menu name
Example : Virtual Server
string

13 - AlertLevelCountsByServiceResponseV1Dot4

NameDescriptionSchemaDefault
level_counts
required
List of Level Counts
array[AlertLevelCountsByServiceDTOV1Dot4]

14 - AlertNotificationRecipientDTO

NameDescriptionSchemaDefault
activated_yn
optional

Example : N
enum (N, Y)N
alert_id
required

Example :
string
created_at
required

Example :
string (date-time)
created_by
required

Example :
string
id
required

Example :
string
last_login_at
required

Example :
string (date-time)
modified_at
required

Example :
string (date-time)
modified_by
required

Example :
string
user_created_at
required

Example :
string (date-time)
user_id
required

Example :
string
user_name
required

Example :
string

15 - AlertNotificationsPageResponse

NameDescriptionSchemaDefault
alert_notifications
required

array[AlertNotificationRecipientDTO]
count
required
count
Example : 20
integer
page
required
page
Example : 0
integer
size
required
size
Example : 20
integer
sort
optional
sort
Example : ['created_at:asc']
any of [array[string], null]

16 - AlertNotificationsSetRequest

NameDescriptionSchemaDefault
user_ids
required
List of User IDs
Example : ['1234da92-634a-4f8c-932e-9d650599ab1b', '1234da92-634a-4f8c-932e-9d650599ab1a', '1234da92-634a-4f8c-932e-9d650599ab1c']
array[string]

17 - AlertNotificationsSetResponse

NameDescriptionSchemaDefault
user_ids
required
List of User IDs
Example : ['1234da92-634a-4f8c-932e-9d650599ab1b', '1234da92-634a-4f8c-932e-9d650599ab1a', '1234da92-634a-4f8c-932e-9d650599ab1c']
array[string]

18 - AlertPropertiesDTO

NameDescriptionSchemaDefault
metrics
required
List of metrics included in the widget
array[MetricAlertsDTO]
period
optional
Query period (seconds)
Example : 300
any of [integer, null]
stacked
required
Whether the graph is stacked
Example : False
boolean
statistic_type
optional
Statistical function
Example : AVG
any of [string, null]
title
required
Widget title
Example : Virtual Server | CPU Utilization
string
view
required
View type
Example : line
string

19 - AlertSetRequest

NameDescriptionSchemaDefault
dimension
optional
Dimension
any of [DimensionDTO, null]
dimensions
optional
List of Dimensions
any of [array[DimensionDTO], null]
evaluation_count
optional
Evaluation Count for the Alert Condition
Example : 3
integer1
individual_items
optional
List of Individual Items
any of [array[MetricIndividualItemDto], null]
level
required
Alert Level - HIGH, MIDDLE, LOW
Example : HIGH
enum (HIGH, MIDDLE, LOW)
lower_bound
optional
Lower bound for the Alert range operator
Example : 80.0
any of [object, null]
metric_id
required
Metric ID
Example : f13aab3b88c341b2bc73f8925a0e8cc5
string
missing_data_option
optional
Missing Data Option - MISSING, BREACHING, NOT_BREACHING, IGNORE
Example : BREACHING
any of [enum (MISSING, BREACHING, NOT_BREACHING, IGNORE), null]IGNORE
namespace_id
required
Namespace ID
Example : 1d9d05af5c624f2cb80a45f2c911e2f4
string
operator
required
Operator - EQ, NOT_EQ, GT, GTE, LT, LTE, RANGE
Example : RANGE
enum (GTE, GT, LTE, LT, EQ, NOT_EQ, RANGE)
period
required
Period (seconds)
Example : 300
integer
statistic
required
Statistic - SUM, AVG, MAX, MIN
Example : AVG
enum (AVG, SUM, MAX, MIN, CNT)
threshold
optional
Threshold for the Alert Condition (except fro RANGE operator)
Example : 80.0
any of [object, null]
upper_bound
optional
Upper bound for the Alert range operator
Example : 90.0
any of [object, null]
violation_count
optional
Violation Count for the Alert Condition
Example : 2
integer1

20 - AlertSetResponse

NameDescriptionSchemaDefault
dimension
required
Dimension
DimensionDTO
dimensions
required
List of Dimensions
Example : [{'key': 'resource_id', 'value': '291c3d2396cb4fd2b532db8903e0408a'}]
array[DimensionDTO]
id
required
Alert ID
Example : 3234bd0f12fa4d0b97ab9feff6c09b8e
string
individual_items
required
List of Individual Items
any of [array[MetricIndividualItemDto], null]
level
required
Alert Level - HIGH, MIDDLE, LOW
Example : HIGH
enum (HIGH, MIDDLE, LOW)
lower_bound
optional
Lower bound for the Alert range operator
Example : 80.0
any of [object, null]
metric_id
required
Metric ID
Example : f13aab3b88c341b2bc73f8925a0e8cc5
string
missing_data_option
optional
Missing Data Option - MISSING, BREACHING, NOT_BREACHING, IGNORE
Example : BREACHING
enum (MISSING, BREACHING, NOT_BREACHING, IGNORE)IGNORE
modified_at
required
Modified date time
Example : 2026-06-24T10:14:52.735162
string (date-time)
namespace_id
required
Namespace ID
Example : 1d9d05af5c624f2cb80a45f2c911e2f4
string
operator
required
Operator - EQ, NOT_EQ, GT, GTE, LT, LTE, RANGE
Example : RANGE
enum (GTE, GT, LTE, LT, EQ, NOT_EQ, RANGE)
period
required
Period (seconds)
Example : 300
integer
statistic
required
Statistic - SUM, AVG, MAX, MIN
Example : AVG
enum (AVG, SUM, MAX, MIN, CNT)
threshold
optional
Threshold for the Alert Condition (except fro RANGE operator)
Example : 80.0
any of [object, null]
upper_bound
optional
Upper bound for the Alert range operator
Example : 90.0
any of [object, null]

21 - AlertSetResponseV1Dot3

NameDescriptionSchemaDefault
dimension
required
Dimension
DimensionDTO
dimensions
required
List of Dimensions
Example : [{'key': 'resource_id', 'value': '291c3d2396cb4fd2b532db8903e0408a'}]
array[DimensionDTO]
evaluation_count
optional
Evaluation Count for the Alert Condition
Example : 3
any of [integer, null]
id
required
Alert ID
Example : 3234bd0f12fa4d0b97ab9feff6c09b8e
string
individual_items
required
List of Individual Items
any of [array[MetricIndividualItemDto], null]
level
required
Alert Level - HIGH, MIDDLE, LOW
Example : HIGH
enum (HIGH, MIDDLE, LOW)
lower_bound
optional
Lower bound for the Alert range operator
Example : 80.0
any of [object, null]
metric_id
required
Metric ID
Example : f13aab3b88c341b2bc73f8925a0e8cc5
string
missing_data_option
optional
Missing Data Option - MISSING, BREACHING, NOT_BREACHING, IGNORE
Example : BREACHING
enum (MISSING, BREACHING, NOT_BREACHING, IGNORE)IGNORE
modified_at
required
Modified date time
Example : 2026-06-24T10:14:52.735162
string (date-time)
namespace_id
required
Namespace ID
Example : 1d9d05af5c624f2cb80a45f2c911e2f4
string
operator
required
Operator - EQ, NOT_EQ, GT, GTE, LT, LTE, RANGE
Example : RANGE
enum (GTE, GT, LTE, LT, EQ, NOT_EQ, RANGE)
period
required
Period (seconds)
Example : 300
integer
statistic
required
Statistic - SUM, AVG, MAX, MIN
Example : AVG
enum (AVG, SUM, MAX, MIN, CNT)
threshold
optional
Threshold for the Alert Condition (except fro RANGE operator)
Example : 80.0
any of [object, null]
upper_bound
optional
Upper bound for the Alert range operator
Example : 90.0
any of [object, null]
violation_count
optional
Violation Count for the Alert Condition
Example : 2
any of [integer, null]

22 - AlertSimpleDTO

NameDescriptionSchemaDefault
activated_yn
required
Whether the Alert is activated or not
Example : Y
enum (N, Y)
evaluation_time_window
required
Evaluation Time Window (period * evaluation_count)
Example : 900
integer
id
required
Alert ID
Example : 3234bd0f12fa4d0b97ab9feff6c09b8e
string
last_policy_updated_at
required
Last Alert Policy Updated Date Time
Example : 2026-06-24T10:14:52.700924
string (date-time)
level
required
Alert Level - HIGH, MIDDLE, LOW
Example : HIGH
enum (HIGH, MIDDLE, LOW)
lower_bound
required
Lower bound for the Alert range operator
Example : 80.0
any of [object, null]
metric_name
optional
Metric Name
Example : CPU Usage
any of [string, null]
metric_unit
optional
Metric Unit. Allowed Units: SECONDS, MICROSECONDS, MILLISECONDS, BYTES, KILOBYTES, MEGABYTES, GIGABYTES, TERABYTES, BITS, KILOBITS, MEGABITS, GIGABITS, TERABITS, PERCENT, COUNT, BYTES_PER_SECOND, KILOBYTES_PER_SECOND, MEGABYTES_PER_SECOND, GIGABYTES_PER_SECOND, TERABYTES_PER_SECOND, BITS_PER_SECOND, KILOBITS_PER_SECOND, MEGABITS_PER_SECOND, GIGABITS_PER_SECOND, TERABITS_PER_SECOND, COUNT_PER_SECOND, COUNT_PER_MINUTE, NONE
Example : BYTE
any of [string, null]
name
required
Alert Name
Example : Alert Test
string
namespace_name
optional
Namespace Name
Example : Virtual Server
any of [string, null]
operator
required
Operator - EQ, NOT_EQ, GT, GTE, LT, LTE, RANGE
Example : RANGE
enum (GTE, GT, LTE, LT, EQ, NOT_EQ, RANGE)
state
required
Alert State - NORMAL, ALERT, INSUFFICIENT_DATA
Example : NORMAL
enum (INSUFFICIENT_DATA, NORMAL, ALERT)
statistic
required
Statistic - SUM, AVG, MAX, MIN
Example : AVG
enum (AVG, SUM, MAX, MIN, CNT)
threshold
required
Threshold for the Alert Condition (except fro RANGE operator)
Example : 80.0
any of [object, null]
type
required
Alert Type
Example : METRIC_ALERT
enum (METRIC_ALERT, SERVICE_ALERT, COMPOSITE_ALERT)
upper_bound
required
Upper bound for the Alert range operator
Example : 90.0
any of [object, null]

23 - AlertsListResponse

NameDescriptionSchemaDefault
alerts
required
List of Alerts
array[AlertSimpleDTO]
count
required
count
Example : 20
integer
page
required
page
Example : 0
integer
size
required
size
Example : 20
integer
sort
optional
sort
Example : ['created_at:asc']
any of [array[string], null]

24 - AlertsObjectDTO

NameDescriptionSchemaDefault
summary
required
Alert summary
AlertSummaryDTO
widgets
optional
List of widgets containing alert information
any of [array[DashboardAlertWidgetDTO], null]

25 - AlertSummaryDTO

NameDescriptionSchemaDefault
high
required
Number of high-severity alarms
Example : 1
integer
low
required
Number of low-severity alarms
Example : 0
integer
medium
required
Number of medium-severity alarms
Example : 3
integer

26 - CustomLogEventsCreateRequest

NameDescriptionSchemaDefault
resourceLogs
required
Resource Logs
array[ResourceLogDTO]

27 - DashboardAlertWidgetDTO

NameDescriptionSchemaDefault
properties
required
Widget’s detailed properties
AlertPropertiesDTO

28 - DashboardBulkDeleteRequest

NameDescriptionSchemaDefault
dashboard_ids
required
List of dashboard IDs
Example : ['b48e730a70e74f6aa3d2555000b5c22b', 'c48e730a70e74f6aa3d2555000b5c22b']
array[string]

29 - DashboardBulkDeleteResponse

NameDescriptionSchemaDefault
dashboard_names
required
List of dashboard’s name
Example : ['dash-abc', 'dash-def']
array[string]

30 - DashboardCreationRequest

NameDescriptionSchemaDefault
name
required
Dashboard’s name
Example : New-Monitoring-Dashboard
string
widgets
optional
List of widgets included in the dashboard
any of [array[WidgetDTO], null]

31 - DashboardDetailResponse

NameDescriptionSchemaDefault
alerts
optional
Alert information related to the dashboard
any of [AlertsObjectDTO, null]
created_at
required
Created date time
Example :
string (date-time)
created_by
required
Creator ID
Example : user-xxxxxxxx
string
favorite_enabled
required
Whether it is a favorite dashboard
Example : True
boolean
id
required
Dashboard’s unique ID
Example : b48e730a70e74f6aa3d2555000b5c22b
string
modified_at
optional
Modified date time
Example :
any of [string (date-time), null]
modified_by
optional
Modifier ID
Example : user-yyyyyyyy
any of [string, null]
name
required
Dashboard’s name
Example : Production-Web-Servers
string
product_name
required
Associated resource type
Example : ServiceWatch
string
resource_id
required
Associated resource ID
Example : c8e41e595ad040a8abe57e2ffc109113
string
resource_name
required
Associated resource name
Example : Production-Web-Servers
string
resource_type
required
Associated resource type
Example : dashboard
string
share_type
required
Sharing type
Example : Private
string
srn
required
Service resource name (SRN)
Example : srn:vs:kr-central-1:123456789012:instance/c8e41e595ad040a8abe57e2ffc109113
string
type
required
Dashboard type
Example : Custom
string
widgets
optional
List of widgets included in the dashboard
any of [array[WidgetDetailDTO], null]

32 - DashboardDetailResponseV1Dot1

NameDescriptionSchemaDefault
alerts
optional
Alert information related to the dashboard
any of [AlertsObjectDTO, null]
created_at
required
Created date time
Example :
string (date-time)
created_by
required
Creator ID
Example : user-xxxxxxxx
string
favorite_enabled
required
Whether it is a favorite dashboard
Example : True
boolean
id
required
Dashboard’s unique ID
Example : b48e730a70e74f6aa3d2555000b5c22b
string
modified_at
optional
Modified date time
Example :
any of [string (date-time), null]
modified_by
optional
Modifier ID
Example : user-yyyyyyyy
any of [string, null]
name
required
Dashboard’s name
Example : Production-Web-Servers
string
product_name
required
Associated resource type
Example : ServiceWatch
string
resource_id
required
Associated resource ID
Example : c8e41e595ad040a8abe57e2ffc109113
string
resource_name
required
Associated resource name
Example : Production-Web-Servers
string
resource_type
required
Associated resource type
Example : dashboard
string
service_code
optional
Associated service code
Example : virtualserver
any of [string, null]
share_type
required
Sharing type
Example : Private
string
srn
required
Service resource name (SRN)
Example : srn:vs:kr-central-1:123456789012:instance/c8e41e595ad040a8abe57e2ffc109113
string
type
required
Dashboard type
Example : Custom
string
widgets
optional
List of widgets included in the dashboard
any of [array[WidgetDetailDtoV1Dot1], null]

33 - DashboardDetailResponseV1Dot4

NameDescriptionSchemaDefault
alerts
optional
Alert information related to the dashboard
any of [AlertsObjectDTO, null]
created_at
required
Created date time
Example :
string (date-time)
created_by
required
Creator ID
Example : user-xxxxxxxx
string
favorite_enabled
required
Whether it is a favorite dashboard
Example : True
boolean
id
required
Dashboard’s unique ID
Example : b48e730a70e74f6aa3d2555000b5c22b
string
modified_at
optional
Modified date time
Example :
any of [string (date-time), null]
modified_by
optional
Modifier ID
Example : user-yyyyyyyy
any of [string, null]
name
required
Dashboard’s name
Example : Production-Web-Servers
string
namespace_code
optional
Associated namespace code
Example : virtualserver
any of [string, null]
product_name
required
Associated resource type
Example : ServiceWatch
string
resource_id
required
Associated resource ID
Example : c8e41e595ad040a8abe57e2ffc109113
string
resource_name
required
Associated resource name
Example : Production-Web-Servers
string
resource_type
required
Associated resource type
Example : dashboard
string
service_code
optional
Associated service code
Example : virtualserver
any of [string, null]
share_type
required
Sharing type
Example : Private
string
srn
required
Service resource name (SRN)
Example : srn:vs:kr-central-1:123456789012:instance/c8e41e595ad040a8abe57e2ffc109113
string
type
required
Dashboard type
Example : Custom
string
widgets
optional
List of widgets included in the dashboard
any of [array[WidgetDetailDtoV1Dot1], null]

34 - DashboardDTO

NameDescriptionSchemaDefault
created_at
required
Created date time
Example :
string (date-time)
favorite_enabled
required
Whether it is a favorite dashboard
Example : True
boolean
id
required
Dashboard’s unique ID
Example : b48e730a70e74f6aa3d2555000b5c22b
string
modified_at
required
Modified date time
Example :
string (date-time)
name
required
Dashboard’s name
Example : Production-Web-Servers
string
namespace_code
optional
Associated namespace code
Example : virtualserver
any of [string, null]
service_code
optional
Associated service code
Example : virtualserver
any of [string, null]
type
required
Dashboard type
Example : Custom
string

35 - DashboardPageResponse

NameDescriptionSchemaDefault
count
required
count
Example : 20
integer
dashboards
required
List of dashboards
array[DashboardDTO]
page
required
page
Example : 0
integer
size
required
size
Example : 20
integer
sort
optional
sort
Example : ['created_at:asc']
any of [array[string], null]

36 - DashboardPageResponseV1Dot4

NameDescriptionSchemaDefault
count
required
count
Example : 20
integer
dashboards
required
List of dashboards
array[DashboardDTO]
namespace_code
optional
Associated namespace code
Example : virtualserver
any of [string, null]
page
required
page
Example : 0
integer
size
required
size
Example : 20
integer
sort
optional
sort
Example : ['created_at:asc']
any of [array[string], null]

37 - DashboardUpdateRequest

NameDescriptionSchemaDefault
name
optional
Dashboard’s name
Example : Renamed-Dashboard
any of [string, null]
widgets
optional
List of widgets included in the dashboard
any of [array[WidgetDTO], null]

38 - DimensionDTO

NameDescriptionSchemaDefault
key
required
Dimension Key
Example : resource_id
Pattern : ^[a-zA-Z][a-zA-Z0-9_]{2,127}$
string
value
required
Dimension Value
Example : 10bf5d24-0f20-4066-bb0b-de2b1d6ff502
string

39 - EventRuleCreateRequest

NameDescriptionSchemaDefault
description
optional
Event rule description
Example : Event rule 1 description
any of [string, null]
event_ids
optional
List of Event IDs
Example : ['014cb88ca2a9420e840d5c9ac16cac89', '28520cbbc8c54a3f86f513a9695e6481', '29f97b569020491ca63d37e27b2c7fec', '3339ebd5839e41c982a81803431f6932', '3fb112a5708f44549878c7de7159922d']
any of [array[string], null]
name
required
Event rule name
Example : Event rule 1
string
recipient_ids
optional
Notification recipient IDs
Example : ['947c6a8559434505b28a5e21fff463d0', 'aa57f19630b347f0b294f189acd098a7', 'bc086de26abc4ea2b3e1322b14c013f3', '4af4507824924a7a9988a7bd3bd09bb7', 'c0e4f5d4b0cf4dc5b8f6f915602949d5']
any of [array[string], null]
resource_type_id
optional
Resource type ID
Example : 596bf16709e84e27b7df397bf59b877c
any of [string, null]
service_id
required
Service ID
Example : 2778de83d7e247609445bbd570a4eba9
string
srn_list
optional
List of SDS cloud Resource Names
Example : ['srn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::servicewatch:event-rule/a58c8645928043a6868277c7d7fef11a', 'srn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::servicewatch:event-rule/1fd94ff609dd40b3a873b306432059df', 'srn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::servicewatch:event-rule/a23783834c7c4fd29b015632811b9a76', 'srn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::servicewatch:event-rule/704c0b21e1be44ba82a552d751d282d2', 'srn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::servicewatch:event-rule/63b5ea57e1254dfaa934cd76aaf3aade']
any of [array[string], null]
tags
optional
List of Tags
Example : [{'key': 'key01', 'value': 'value01'}, {'key': 'key02', 'value': 'value02'}]
any of [array[ResourceTag], null]

40 - EventRuleDTO

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : 1bcf39b344ac41cbaf0466ff0d2bebad
string
active_yn
required
Whether the Event rule is active
Example : Y
enum (N, Y)
created_at
required
Created date time
Example :
string (date-time)
created_by
required
Creator ID
Example : f4b8a4c4017f4f8d8399f0c02582ae47
string
description
required
Event rule description
Example : Event rule 1 description
any of [string, null]
id
required
Event rule ID
Example : b73f95c698f540dab18860f72fafd03f
string
modified_at
required
Modified date time
Example :
string (date-time)
modified_by
required
Modifier ID
Example : f4b8a4c4017f4f8d8399f0c02582ae47
string
name
required
Event rule name
Example : Event rule 1
string
resource_type_id
required
Resource type ID
Example : 596bf16709e84e27b7df397bf59b877c
any of [string, null]
service_id
required
Service ID
Example : 2778de83d7e247609445bbd570a4eba9
string

41 - EventRulesDeleteRequest

NameDescriptionSchemaDefault
ids
required
List of Event rule IDs
Example : ['66d77b4e32d04558b2382b1d14765d86', '3abcf524eb3d4457b39ef90eab2c9e48', 'ec67101ca2364ca28ad1e69b8084492d', 'f0620e8eb6a843aaaa2714494dfb7dbb', '0ecc082aa1e3485bba95419c47e0b741']
array[string]

42 - EventRulesDeleteResponse

NameDescriptionSchemaDefault
ids
required
List of Event rule IDs
Example : ['66d77b4e32d04558b2382b1d14765d86', '3abcf524eb3d4457b39ef90eab2c9e48', 'ec67101ca2364ca28ad1e69b8084492d', 'f0620e8eb6a843aaaa2714494dfb7dbb', '0ecc082aa1e3485bba95419c47e0b741']
array[string]

43 - EventRuleSetRequest

NameDescriptionSchemaDefault
active_yn
optional
Whether the Event rule is active
Example : Y
any of [enum (N, Y), null]
description
optional
Event rule description
Example : Event rule 1 description
any of [string, null]
event_ids
optional
List of Event IDs
Example : ['014cb88ca2a9420e840d5c9ac16cac89', '28520cbbc8c54a3f86f513a9695e6481', '29f97b569020491ca63d37e27b2c7fec', '3339ebd5839e41c982a81803431f6932', '3fb112a5708f44549878c7de7159922d']
any of [array[string], null]
none_attributes
optional
List of attributes to assign to None
Example : ['description', 'resource_type_id', 'event_ids', 'srn_list', 'recipient_ids']
any of [array[string], null]
recipient_ids
optional
Notification recipient IDs
Example : ['947c6a8559434505b28a5e21fff463d0', 'aa57f19630b347f0b294f189acd098a7', 'bc086de26abc4ea2b3e1322b14c013f3', '4af4507824924a7a9988a7bd3bd09bb7', 'c0e4f5d4b0cf4dc5b8f6f915602949d5']
any of [array[string], null]
resource_type_id
optional
Resource type ID
Example : 596bf16709e84e27b7df397bf59b877c
any of [string, null]
service_id
required
Service ID
Example : 2778de83d7e247609445bbd570a4eba9
string
srn_list
optional
List of SDS cloud Resource Names
Example : ['srn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::servicewatch:event-rule/a58c8645928043a6868277c7d7fef11a', 'srn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::servicewatch:event-rule/1fd94ff609dd40b3a873b306432059df', 'srn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::servicewatch:event-rule/a23783834c7c4fd29b015632811b9a76', 'srn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::servicewatch:event-rule/704c0b21e1be44ba82a552d751d282d2', 'srn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::servicewatch:event-rule/63b5ea57e1254dfaa934cd76aaf3aade']
any of [array[string], null]

44 - EventRuleShowResponse

NameDescriptionSchemaDefault
event_rule
required
Event rule
EventRuleDTO

45 - IndividualItemDTO

NameDescriptionSchemaDefault
key
required
Individual item’s key
Example : bucket_id
string
value
required
Individual item’s value
Example : 6870d9989ec3496c932de11b409ed9cc
object

46 - LogAttributeDTO

NameDescriptionSchemaDefault
key
required
Key
Example :
string
value
required
Value
LogValueDTO

47 - LogEventsCreateResponse

NameDescriptionSchemaDefault
status
required
Status
Example : success
string

48 - LogGroupCreateRequest

NameDescriptionSchemaDefault
name
required
Log group name
Example : testlg01
string
retention_period
required
Log group retention period
Example : 365
integer
tags
optional
List of Tags
Example : [{'key': 'key01', 'value': 'value01'}, {'key': 'key02', 'value': 'value02'}]
any of [array[ResourceTag], null]

49 - LogGroupDTO

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : 1bcf39b344ac41cbaf0466ff0d2bebad
string
created_at
required
Created date time
Example :
string (date-time)
created_by
required
Creator ID
Example : f4b8a4c4017f4f8d8399f0c02582ae47
string
id
required
Log group ID
Example : bce52822147744b4afe0187164caa2e8
string
modified_at
required
Modified date time
Example :
string (date-time)
modified_by
required
Modifier ID
Example : f4b8a4c4017f4f8d8399f0c02582ae47
string
name
required
Log group name
Example : testlg01
string
retention_period
required
Log group retention period
Example : 365
integer
retention_period_name
required
Log group retention period name
Example : 1 year
string
status
required
Log group status
Example : ACTIVE
enum (ACTIVE, DELETING, DELETED)

50 - LogGroupExportTaskCreateRequest

NameDescriptionSchemaDefault
bucket_name
required
Log group export task bucket name
Example :
string
end_at
required
End datetime
Example :
any of [string (date-time), null]
log_group_id
required
Log group ID
Example :
string
log_stream_ids
required
List of Log stream IDs
array[string]
start_at
required
Start datetime
Example :
any of [string (date-time), null]

51 - LogGroupExportTaskDTO

NameDescriptionSchemaDefault
account_id
required
Account ID
Example :
string
bucket_name
required
Log group export task bucket name
Example :
string
bucket_path
optional
Bucket Path
Example :
any of [string, null]
completed_at
optional
Log group export task completed date time
Example :
any of [string (date-time), null]
created_at
required
Created date time
Example :
string (date-time)
created_by
required
Creator ID
Example : f4b8a4c4017f4f8d8399f0c02582ae47
string
deleted_yn
required
Delete YN
Example :
string
end_at
required
End datetime
Example :
any of [string (date-time), null]
id
required
Log group export task ID
Example :
string
log_group_id
required
Log group ID
Example :
string
log_group_name
optional
Log group name
Example :
any of [string, null]
start_at
required
Start datetime
Example :
any of [string (date-time), null]
state
required
Log group export task status
Example : PENDING
enum (PENDING, IN_PROGRESS, FILE_TRANSFERRING, SUCCESS, FAILED, CANCELING, CANCELED)

52 - LogGroupExportTaskShowResponse

NameDescriptionSchemaDefault
log_group_export
required
Log group export task
LogGroupExportTaskDTO

53 - LogGroupLogStreamCreateRequest

NameDescriptionSchemaDefault
name
required
Log stream name
Example : testls01
string

54 - LogGroupLogStreamsDeleteRequest

NameDescriptionSchemaDefault
ids
required
List of Log stream IDs
Example : ['b0fc99a46a2c44b8b22739b130853dd8', '36dc853661144df687c4c7f158db5553', '3f611f40e9f841acbd62639b2779e35e', '5bd44e218eeb4f6190048a85599ade44', '188842fa2f13484ba6c9e210b817c780']
array[string]

55 - LogGroupPageResponse

NameDescriptionSchemaDefault
count
required
count
Example : 20
integer
log_groups
required
List of Log groups
array[LogGroupDTO]
page
required
page
Example : 0
integer
size
required
size
Example : 20
integer
sort
optional
sort
Example : ['created_at:asc']
any of [array[string], null]

56 - LogGroupsDeleteRequest

NameDescriptionSchemaDefault
ids
required
List of Log group IDs
Example : ['602b39cb1d6b4b7fb0f18de43a4c689c', 'bce52822147744b4afe0187164caa2e8', '953978a05b5d4ab8b2fc80bb5d0b8b6e', '3eeb8030bfca4e729b8332f6004628a4', '4a11695ad4b34539b4cee12db2a14aa9']
array[string]

57 - LogGroupsDeleteResponse

NameDescriptionSchemaDefault
ids
required
List of Log group IDs
Example : ['602b39cb1d6b4b7fb0f18de43a4c689c', 'bce52822147744b4afe0187164caa2e8', '953978a05b5d4ab8b2fc80bb5d0b8b6e', '3eeb8030bfca4e729b8332f6004628a4', '4a11695ad4b34539b4cee12db2a14aa9']
array[string]

58 - LogGroupSetRequest

NameDescriptionSchemaDefault
retention_period
required
Log group retention period
Example : 365
integer

59 - LogGroupShowResponse

NameDescriptionSchemaDefault
log_group
required
Log group
LogGroupDTO

60 - LogGroupsLogStreamsCollectCustomRequest

NameDescriptionSchemaDefault
log_group_name
required
Log group name
Example : testlg01
string
log_stream_name
required
Log stream name
Example : testls01
string

61 - LogGroupsLogStreamsCollectCustomResponse

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : 1bcf39b344ac41cbaf0466ff0d2bebad
string
log_group_value
required
Log group value
Example : fa6169af200b4d5db229aff384b2a028
string
log_stream_value
required
Log stream value
Example : 551513c5182b45beb22eadb634cdccfb
string
requests_per_second
required
Export log requests per second
Example : 500
integer

62 - LogRecordDTO

NameDescriptionSchemaDefault
body
required
Body
LogValueDTO
timeUnixNano
required
Unix nano time
Example : 1762336464000000000
integer

63 - LogResourceDTO

NameDescriptionSchemaDefault
attributes
required
Attributes
Example : [{'key': 'log_stream_value', 'value': {'stringValue': 'a1e2f3045678901a2b3c4d5e6f7a8b81'}}, {'key': 'log_group_value', 'value': {'stringValue': 'b1e2f3045678901a2b3c4d5e6f7a8b81'}}, {'key': 'account_id', 'value': {'stringValue': 'c1e2f3045678901a2b3c4d5e6f7a8b81'}}]
array[LogAttributeDTO]

64 - LogStreamDTO

NameDescriptionSchemaDefault
collect_yn
required
Whether to collect logs or not
Example : Y
enum (N, Y)
created_at
required
Created date time
Example :
string (date-time)
created_by
required
Creator ID
Example : f4b8a4c4017f4f8d8399f0c02582ae47
string
id
required
Log stream ID
Example : b0fc99a46a2c44b8b22739b130853dd8
string
log_group_id
required
Log group ID
Example : bce52822147744b4afe0187164caa2e8
string
modified_at
required
Modified date time
Example :
string (date-time)
modified_by
required
Modifier ID
Example : f4b8a4c4017f4f8d8399f0c02582ae47
string
name
required
Log stream name
Example : testls01
string

65 - LogStreamShowResponse

NameDescriptionSchemaDefault
log_stream
required
Log stream
LogStreamDTO

66 - LogValueDTO

NameDescriptionSchemaDefault
stringValue
required
String Value: account_id, log_group_value, log_stream_value
Example : level=info otlp test log
string

67 - MetricAlert

NameDescriptionSchemaDefault
id
required

Example :
string
name
required

Example :
string

68 - MetricAlertDto

NameDescriptionSchemaDefault
id
required
Alert ID
Example : 3234bd0f12fa4d0b97ab9feff6c09b8e
string
name
required
Alert Name
Example : Alert Test
string

69 - MetricAlertsDTO

NameDescriptionSchemaDefault
alerts
optional
List of Alerts
any of [array[MetricAlert], null]
color
required
Metric line color
Example : #ff7f0e
string
dimensions
required
List of Dimensions
array[DimensionDTO]
display_name
required
Display name (label) of the metric
Example : EC2-Prod-CPU
string
individual_items
optional
List of Individual Items
Example : [{'key': 'BucketId', 'value': 'b-1234567890abcdef0'}]
any of [array[IndividualItemDTO], null]
name
required
Metric Name
Example : CPUUtilization
string
namespace_name
required
Namespace
Example : Virtual Server
string
period
required
Query period (seconds)
Example : 300
integer
statistic_type
required
Statistical function
Example : AVG
string

70 - MetricCustomMetaRequest

NameDescriptionSchemaDefault
metricMetas
required

array[MetricMetaDto]
namespace
required
Namespace
Example : MyCustom/filestorage
string

71 - MetricCustomMetaResponse

NameDescriptionSchemaDefault
account_id
required
Account ID of Metrics
Example : d79a5194b1a44a858969eb94754d3ba1
string
max_data_points
optional

Example :
integer
unit_logs
required

array[UnitLogDto]

72 - MetricCustomRequest

NameDescriptionSchemaDefault
resource_metrics
required
The resourceMetrics field holds a set of all metric data associated with a specific resource
array[OtlpResourceMetricDto]

73 - MetricDataImageDto

NameDescriptionSchemaDefault
color
optional
Color
Example : #0000ff
any of [string, null]
dimensions
required
List of Dimensions
array[MetricLabelDto]
display_name
optional
Metric Display Name
Example : Virtual Server | VirtualServer001 | CPU Usage/Core[Basic]
any of [string, null]
individual_items
optional
List of Individual Items
any of [array[MetricLabelDto], null]
name
required
Metric Name
Example : CPU Usage
string
namespace_name
required
Namespace
Example : Virtual Server
string
period
optional
Statistic Period
Example : 300
any of [integer, null]
statistic_type
optional
Metric Statistics Type
Example : AVG
any of [enum (AVG, SUM, MAX, MIN, CNT), null]

74 - MetricDataImageDtoV1Dot1

NameDescriptionSchemaDefault
color
optional
Color
Example : #0000ff
any of [string, null]
dimensions
required
List of Dimensions
array[MetricLabelDto]
display_name
optional
Metric Display Name
Example : Virtual Server | VirtualServer001 | CPU Usage/Core[Basic]
any of [string, null]
name
required
Metric Name
Example : CPU Usage
string
namespace_name
required
Namespace
Example : Virtual Server
string
period
optional
Statistic Period
Example : 300
any of [integer, null]
statistic_type
optional
Metric Statistics Type
Example : AVG
any of [enum (AVG, SUM, MAX, MIN, CNT), null]

75 - MetricDataImageRequest

NameDescriptionSchemaDefault
end
required
Metric End Time - Unix Timestamp
Example : 1640995440
Maximum : 4102444800
integer
height
optional
Chart Image Height(pixels)
Example : 400
any of [integer, null]500
metrics
required

array[MetricDataImageDto]
period
required
Statistic Period
Example : 300
integer
start
required
Metric Start Time - Unix Timestamp
Example : 1640995200
Maximum : 4102444800
integer
statistic_type
required
Metric Statistics Type
Example : AVG
enum (AVG, SUM, MAX, MIN, CNT)
timezone
optional
Timezone
Example : UTC
any of [string, null]UTC
title
optional
Chart Title
Example : Virtual Server Metric Chart
any of [string, null]
width
optional
Chart Image Width(pixels)
Example : 600
any of [integer, null]1400

76 - MetricDataImageRequestV1Dot1

NameDescriptionSchemaDefault
end
required
Metric End Time - Unix Timestamp
Example : 1640995440
Maximum : 4102444800
integer
height
optional
Chart Image Height(pixels)
Example : 400
any of [integer, null]500
metrics
required

array[MetricDataImageDtoV1Dot1]
period
required
Statistic Period
Example : 300
integer
start
required
Metric Start Time - Unix Timestamp
Example : 1640995200
Maximum : 4102444800
integer
statistic_type
required
Metric Statistics Type
Example : AVG
enum (AVG, SUM, MAX, MIN, CNT)
timezone
optional
Timezone
Example : UTC
any of [string, null]UTC
title
optional
Chart Title
Example : Virtual Server Metric Chart
any of [string, null]
width
optional
Chart Image Width(pixels)
Example : 600
any of [integer, null]1400

77 - MetricDataRequest

NameDescriptionSchemaDefault
end
required
Metric End Time - Unix Timestamp
Example : 1640995440
Maximum : 4102444800
integer
metrics
required

array[MetricDetailDto]
period
required
Statistic Period
Example : 300
integer
start
required
Metric Start Time - Unix Timestamp
Example : 1640995200
Maximum : 4102444800
integer
statistic_type
required
Metric Statistics Type
Example : AVG
enum (AVG, SUM, MAX, MIN, CNT)

78 - MetricDataRequestV1Dot1

NameDescriptionSchemaDefault
end
required
Metric End Time - Unix Timestamp
Example : 1640995440
Maximum : 4102444800
integer
metrics
required

array[MetricDetailDtoV1Dot1]
period
required
Statistic Period
Example : 300
integer
start
required
Metric Start Time - Unix Timestamp
Example : 1640995200
Maximum : 4102444800
integer
statistic_type
required
Metric Statistics Type
Example : AVG
enum (AVG, SUM, MAX, MIN, CNT)

79 - MetricDataResponse

NameDescriptionSchemaDefault
metrics
required

array[MetricDataResponseDto]

80 - MetricDataResponseDto

NameDescriptionSchemaDefault
display_name
required
Metric Display Name
Example : Virtual Server | VirtualServer001 | CPU Usage/Core[Basic]
string
status
required

Example :
string
values
required
List of Metric Series Values
Example : [[1640995200, "45.5"]]
array[array[any of [integer, string]]]

81 - MetricDetailDto

NameDescriptionSchemaDefault
dimensions
required
List of Dimensions
array[MetricLabelDto]
display_name
optional
Metric Display Name
Example : Virtual Server | VirtualServer001 | CPU Usage/Core[Basic]
any of [string, null]
individual_items
optional
List of Individual Items
any of [array[MetricLabelDto], null]
name
required
Metric Name
Example : CPU Usage
string
namespace_name
required
Namespace
Example : Virtual Server
string
period
optional
Statistic Period
Example : 300
any of [integer, null]
statistic_type
optional
Metric Statistics Type
Example : AVG
any of [enum (AVG, SUM, MAX, MIN, CNT), null]

82 - MetricDetailDtoV1Dot1

NameDescriptionSchemaDefault
dimensions
required
List of Dimensions
array[MetricLabelDto]
display_name
optional
Metric Display Name
Example : Virtual Server | VirtualServer001 | CPU Usage/Core[Basic]
any of [string, null]
name
required
Metric Name
Example : CPU Usage
string
namespace_name
required
Namespace
Example : Virtual Server
string
period
optional
Statistic Period
Example : 300
any of [integer, null]
statistic_type
optional
Metric Statistics Type
Example : AVG
any of [enum (AVG, SUM, MAX, MIN, CNT), null]

83 - MetricDimensionDto

NameDescriptionSchemaDefault
columns
required

array[MetricsMetricColumnDto]
key
required
Dimension Key
Example : resource_id
string
metrics
required

array[MetricListDto]

84 - MetricDimensionDtoV1Dot1

NameDescriptionSchemaDefault
columns
required

array[MetricsMetricColumnDto]
keys
required
Dimension Key
Example : resource_id
array[string]
metrics
required

array[MetricListDtoV1Dot1]

85 - MetricDTO

NameDescriptionSchemaDefault
color
required
Metric line color
Example : #ff7f0e
string
dimensions
required
List of Dimensions
array[DimensionDTO]
display_name
required
Display name (label) of the metric
Example : EC2-Prod-CPU
string
individual_items
optional
List of Individual Items
Example : [{'key': 'BucketId', 'value': 'b-1234567890abcdef0'}]
any of [array[IndividualItemDTO], null]
name
required
Metric Name
Example : CPUUtilization
string
namespace_name
required
Namespace
Example : Virtual Server
string
period
required
Query period (seconds)
Example : 300
integer
statistic_type
required
Statistical function
Example : AVG
string

86 - MetricDtoV1Dot1

NameDescriptionSchemaDefault
color
required
Metric line color
Example : #ff7f0e
string
dimensions
required
List of Dimensions
array[DimensionDTO]
display_name
required
Display name (label) of the metric
Example : EC2-Prod-CPU
string
name
required
Metric Name
Example : CPUUtilization
string
namespace_name
required
Namespace
Example : Virtual Server
string
period
required
Query period (seconds)
Example : 300
integer
statistic_type
required
Statistical function
Example : AVG
string

87 - MetricIndividualItemDto

NameDescriptionSchemaDefault
key
required
Individual Item Key
Example : VolumeID
string
value
required
Individual Item Value
Example : 45fbde15-cdd2-4891-be31-4a9de75fccda
string

88 - MetricLabelDto

NameDescriptionSchemaDefault
key
required
Key
Example : VolumeID
string
value
required
Value
Example : 45fbde15-cdd2-4891-be31-4a9de75fccda
string

89 - MetricLabelNameDto

NameDescriptionSchemaDefault
key
required
Key
Example : VolumeID
string
value
required
Value
Example : 45fbde15-cdd2-4891-be31-4a9de75fccda
any of [string, null]

90 - MetricListDto

NameDescriptionSchemaDefault
alerts
required
List of Alerts
any of [array[MetricAlertDto], null]
default_collection_interval
required
Metric’s Default Collection Interval
Example : 5m
enum (NONE, 1s, 1m, 5m)
detailed_collection_interval
required
Metric’s Detailed Collection Interval
Example : 1m
enum (NONE, 1s, 1m, 5m)
dimensions
required
List of Dimensions
array[MetricLabelDto]
id
required
Metric ID
Example : f13aab3b88c341b2bc73f8925a0e8cc5
string
individual_items
optional
List of Dimensions
any of [array[MetricLabelDto], null]
name
required
Metric Name
Example : CPU Usage
string
named_dimensions
required
List of Dimensions
any of [array[MetricLabelNameDto], null]
namespace_id
required
Namespace ID
Example : 1d9d05af5c624f2cb80a45f2c911e2f4
string
namespace_name
required
Namespace
Example : Virtual Server
string
primary
required
Primary Metric
Example : True
boolean
recommended_stat_types
required
List of Recommended Metric Statistics
Example : ["AVG", "MAX"]
array[string]
tags
required
List of Tags
any of [array[TagDTO], null]
unit
required
Metric Unit. Allowed Units: SECONDS, MICROSECONDS, MILLISECONDS, BYTES, KILOBYTES, MEGABYTES, GIGABYTES, TERABYTES, BITS, KILOBITS, MEGABITS, GIGABITS, TERABITS, PERCENT, COUNT, BYTES_PER_SECOND, KILOBYTES_PER_SECOND, MEGABYTES_PER_SECOND, GIGABYTES_PER_SECOND, TERABYTES_PER_SECOND, BITS_PER_SECOND, KILOBITS_PER_SECOND, MEGABITS_PER_SECOND, GIGABITS_PER_SECOND, TERABITS_PER_SECOND, COUNT_PER_SECOND, COUNT_PER_MINUTE, NONE
Example : BYTE
string

91 - MetricListDtoV1Dot1

NameDescriptionSchemaDefault
alerts
required
List of Alerts
any of [array[MetricAlertDto], null]
default_collection_interval
required
Metric’s Default Collection Interval
Example : 5m
enum (NONE, 1s, 1m, 5m)
detailed_collection_interval
required
Metric’s Detailed Collection Interval
Example : 1m
enum (NONE, 1s, 1m, 5m)
dimensions
required
List of Dimensions
array[MetricLabelDto]
id
required
Metric ID
Example : f13aab3b88c341b2bc73f8925a0e8cc5
string
name
required
Metric Name
Example : CPU Usage
string
named_dimensions
required
List of Dimensions
any of [array[MetricLabelNameDto], null]
namespace_id
required
Namespace ID
Example : 1d9d05af5c624f2cb80a45f2c911e2f4
string
namespace_name
required
Namespace
Example : Virtual Server
string
primary
required
Primary Metric
Example : True
boolean
recommended_stat_types
required
List of Recommended Metric Statistics
Example : ["AVG", "MAX"]
array[string]
tags
required
List of Tags
any of [array[TagDTO], null]
unit
required
Metric Unit. Allowed Units: SECONDS, MICROSECONDS, MILLISECONDS, BYTES, KILOBYTES, MEGABYTES, GIGABYTES, TERABYTES, BITS, KILOBITS, MEGABITS, GIGABITS, TERABITS, PERCENT, COUNT, BYTES_PER_SECOND, KILOBYTES_PER_SECOND, MEGABYTES_PER_SECOND, GIGABYTES_PER_SECOND, TERABYTES_PER_SECOND, BITS_PER_SECOND, KILOBITS_PER_SECOND, MEGABITS_PER_SECOND, GIGABITS_PER_SECOND, TERABITS_PER_SECOND, COUNT_PER_SECOND, COUNT_PER_MINUTE, NONE
Example : BYTE
string

92 - MetricMetaDto

NameDescriptionSchemaDefault
descriptionEn
required
Description of Metrics in English
Example : filestorage volume total byte
any of [string, null]
descriptionKo
required
Description of Metrics in Korean
Example : 파일스토리지 총 바이트 수
any of [string, null]
dimensions
required
List of Dimension Keys
Example : [['image_id']]
array[array[string]]
metricName
required
Metric Name
Example : Custom_filestorage_volume_total_byte
string
storageResolution
optional
Storage Resolution
Example : 60
any of [integer, null]
unit
required
Metric Unit. Allowed Units: SECONDS, MICROSECONDS, MILLISECONDS, BYTES, KILOBYTES, MEGABYTES, GIGABYTES, TERABYTES, BITS, KILOBITS, MEGABITS, GIGABITS, TERABITS, PERCENT, COUNT, BYTES_PER_SECOND, KILOBYTES_PER_SECOND, MEGABYTES_PER_SECOND, GIGABYTES_PER_SECOND, TERABYTES_PER_SECOND, BITS_PER_SECOND, KILOBITS_PER_SECOND, MEGABITS_PER_SECOND, GIGABITS_PER_SECOND, TERABITS_PER_SECOND, COUNT_PER_SECOND, COUNT_PER_MINUTE, NONE
Example : Bytes
any of [string, null]

93 - MetricNamespaceDto

NameDescriptionSchemaDefault
dimensions
required

array[MetricDimensionDto]
id
required
Namespace ID
Example : 1d9d05af5c624f2cb80a45f2c911e2f4
string
name
required
Namespace
Example : Virtual Server
string
service_name
required

Example :
string

94 - MetricNamespaceDtoV1Dot1

NameDescriptionSchemaDefault
dimensions
required

array[MetricDimensionDtoV1Dot1]
id
required
Namespace ID
Example : 1d9d05af5c624f2cb80a45f2c911e2f4
string
name
required
Namespace
Example : Virtual Server
string
service_name
required

Example :
string

95 - MetricSearchRequest

NameDescriptionSchemaDefault
metric_name
optional
Metric Name
Example : CPU Usage
any of [string, null]
namespaces
optional
List of Namespace
any of [array[SearchOptionNamespaceDto], null]
resource_id
optional
Resource ID
Example : 10bf5d24-0f20-4066-bb0b-de2b1d6ff502
any of [string, null]
resource_name
optional
Resource Name
Example : VirtualServer01
any of [string, null]
tags
optional
List of Tags
any of [array[TagDTO], null]

96 - MetricSearchRequestV1Dot1

NameDescriptionSchemaDefault
metric_name
optional
Metric Name
Example : CPU Usage
any of [string, null]
namespaces
optional
List of Namespace
any of [array[SearchOptionNamespaceDtoV1Dot1], null]
resource_id
optional
Resource ID
Example : 10bf5d24-0f20-4066-bb0b-de2b1d6ff502
any of [string, null]
resource_name
optional
Resource Name
Example : VirtualServer01
any of [string, null]
tags
optional
List of Tags
any of [array[TagDTO], null]

97 - MetricsMetricColumnDto

NameDescriptionSchemaDefault
key
required
Column Key
Example : name
string
name_en
required
Column Name
Example : 지표명
string
name_ko
required
Column Name
Example : 지표명
string

98 - MetricsResponse

NameDescriptionSchemaDefault
count
required
Count
Example : 1
integer
namespaces
required

array[MetricNamespaceDto]

99 - MetricsResponseV1Dot1

NameDescriptionSchemaDefault
count
required
Count
Example : 1
integer
namespaces
required

array[MetricNamespaceDtoV1Dot1]

100 - NamespaceDto

NameDescriptionSchemaDefault
created_at
required
Created date time
Example :
string (date-time)
created_by
required
Creator ID
Example : f4b8a4c4017f4f8d8399f0c02582ae47
string
description
required
Description of Namespace
Example : 이것은 Virtual Server에 대한 설명입니다.
string
id
required
Namespace ID
Example : 1d9d05af5c624f2cb80a45f2c911e2f4
string
modified_at
required
Modified date time
Example :
string (date-time)
modified_by
required
Modifier ID
Example : f4b8a4c4017f4f8d8399f0c02582ae47
string
name
required
Namespace Name
Example : Virtual Server
string
region_id
required
Region Name
Example : kr-west1
string
service_id
required
Service ID
Example :
string

101 - NamespaceListByAlertsResponse

NameDescriptionSchemaDefault
count
required
Count
Example : 1
integer
namespaces
required

array[NamespaceDto]

102 - OtlpAttributeDto

NameDescriptionSchemaDefault
key
required
Key value of an Attribute. Generally, Resource Attributes are configured to signify the entity or environment from which the metric data was collected. Data Point Attributes represent the name of the label.
Example :
string
value
required
Value of Attribute. There are fields that correspond to multiple types, and only a single value may be sent. If more than one value is provided, only one will be accepted and the additional values will be dropped
OtlpAttributeValueDto

103 - OtlpAttributeValueDto

NameDescriptionSchemaDefault
array_value
optional
Array-typed Value of Attribute
Example :
any of [array[object], null]
bool_value
optional
Bool-typed Value of Attribute
Example :
any of [boolean, null]
byte_value
optional
Byte-typed Value of Attribute
Example :
any of [string (binary), null]
double_value
optional
Double-typed Value of Attribute
Example :
any of [object, null]
int_value
optional
Int-typed Value of Attribute
Example :
any of [integer, null]
kvlist_value
optional
Key-Value List-typed Value of Attribute
Example :
any of [object, null]
string_value
optional
String-typed Value of Attribute
Example :
any of [string, null]

104 - OtlpGaugeDto

NameDescriptionSchemaDefault
data_points
required
The dataPoints field contains a list of the actual observed values for a specific metric, where each value has a timestamp and a metric value. The value of a data point must be represented as either asInt or asDouble, and only a single value may be sent. If more than one value is provided, only one will be accepted and the additional values will be dropped
array[OtlpNumberDataPointDto]

105 - OtlpMetricDto

NameDescriptionSchemaDefault
description
optional
Description of Metric
Example : The total number of bytes read successfully.
any of [string, null]
gauge
optional
The gauge field is a metric type that represents a single value at a specific point in time, used for measuring fluctuating values like current memory usage or CPU temperature. either sum or gauge must be specified.
any of [OtlpGaugeDto, null]
name
required
Name of Metric
Example : node_disk_read_bytes_total
string
sum
optional
The sum field is a metric type that represents a cumulative value over time, used for measuring quantities that only increase, like the number of requests or bytes sent. either sum or gauge must be specified.
any of [OtlpSumDto, null]
unit
optional
Unit of Metric
Example : Bytes
any of [string, null]

106 - OtlpNumberDataPointDto

NameDescriptionSchemaDefault
as_double
optional
Double-typed value of the metric
Example : 0.75
any of [object, null]
as_int
optional
Int-typed value of the metric
Example : 10
any of [integer, null]
attributes
required
Labels of Metric
array[OtlpAttributeDto]
start_time_unix_nano
optional
Unix timestamp, expressed in nanoseconds, for the moment when the metric data began being measured (only used for sum, not for gauge)
Example : 1753776789854000000
any of [string, null]
time_unix_nano
required
Unix timestamp, expressed in nanoseconds, for the moment when the metric data was measured or when the measurement ended
Example : 1753776789854000000
integer

107 - OtlpResourceDto

NameDescriptionSchemaDefault
attributes
required
Resource attributes of Metric
array[OtlpAttributeDto]

108 - OtlpResourceMetricDto

NameDescriptionSchemaDefault
resource
required
The resource field holds attributes that describe the entity or environment from which the metric data originated
OtlpResourceDto
scope_metrics
required
The scopeMetrics field holds a set of all metric data associated with a specific instrumentation library/scope
array[OtlpScopeMetricDto]

109 - OtlpScopeDto

NameDescriptionSchemaDefault
name
required
Name of the Collector that collected the metric
Example : ServiceWatch-Agent
string
version
optional
Version of the Collector that collected the metric
Example : 1.0.0
any of [string, null]

110 - OtlpScopeMetricDto

NameDescriptionSchemaDefault
metrics
required
The metrics field contains a list of the actual metric data generated by the scope, where each item represents a single metric. The metric type can only be gauge or sum, and you must send exactly one value. If more than one value is provided, only one will be accepted and the additional values will be dropped
array[OtlpMetricDto]
scope
required
The scope field identifies the instrumentation library or scope that generated the metrics, typically including its name and version
OtlpScopeDto

111 - OtlpSumDto

NameDescriptionSchemaDefault
aggregation_temporality
required
Aggregation Temporality defines the time window over which metric measurements are aggregated, specifying if the reported value is the cumulative sum (2) or the incremental change (1, Delta) since the last report or unspecified (0).
Example : 2
integer
data_points
required
The dataPoints field contains a list of the actual observed values for a specific metric, where each value has a timestamp and a metric value. The value of a data point must be represented as either asInt or asDouble, and only a single value may be sent. If more than one value is provided, only one will be accepted and the additional values will be dropped
array[OtlpNumberDataPointDto]
is_monotonic
required
Whether the value is monotonic
Example : True
boolean

112 - PropertiesDTO

NameDescriptionSchemaDefault
metrics
required
List of metrics included in the widget
array[MetricDTO]
period
optional
Query period (seconds)
Example : 300
any of [integer, null]
stacked
required
Whether the graph is stacked
Example : False
boolean
statistic_type
optional
Statistical function
Example : AVG
any of [string, null]
title
required
Widget title
Example : Virtual Server | CPU Utilization
string
view
required
View type
Example : line
string

113 - PropertiesDtoV1Dot1

NameDescriptionSchemaDefault
metrics
required
List of metrics included in the widget
array[MetricDtoV1Dot1]
period
optional
Query period (seconds)
Example : 300
any of [integer, null]
stacked
required
Whether the graph is stacked
Example : False
boolean
statistic_type
optional
Statistical function
Example : AVG
any of [string, null]
title
required
Widget title
Example : Virtual Server | CPU Utilization
string
view
required
View type
Example : line
string

114 - ResourceLogDTO

NameDescriptionSchemaDefault
resource
required
Resource
LogResourceDTO
scopeLogs
required
Scope Log
array[ScopeLogDTO]

115 - ResourceTag

NameDescriptionSchemaDefault
key
required

Example :
string
value
required

Example :
string

116 - ScopeLogDTO

NameDescriptionSchemaDefault
logRecords
required
Log Records
array[LogRecordDTO]

117 - SearchOptionNamespaceDto

NameDescriptionSchemaDefault
dimensions
required
List of Dimensions
Example : ["resource_id"]
array[string]
name
required
Namespace
Example : Virtual Server
string

118 - SearchOptionNamespaceDtoV1Dot1

NameDescriptionSchemaDefault
dimensions
required
List of Dimensions
Example : [["resource_id"]]
array[array[string]]
name
required
Namespace
Example : Virtual Server
string

119 - TagDTO

NameDescriptionSchemaDefault
key
required
Tag Key
Example : key01
string
value
required
Tag Value
Example : value01
string

120 - UnitLogDto

NameDescriptionSchemaDefault
code
required
RESPONSE STATUS CODE of Metric
Example : Success
string
message
required
Message about Updated Unit Info
Example : [libvirt_domain_info_virtual_cpus] unit is updated from Count to Bytes
string

121 - WidgetDetailDTO

NameDescriptionSchemaDefault
dashboard_id
required
Dashboard’s unique ID
Example : b48e730a70e74f6aa3d2555000b5c22b
string
height
required
Widget’s height
Example : 1
integer
id
required
Widget’s unique ID
Example : 75da70a1a4fb486ab0282cf90693ec3c
string
order
required
Widget’s order in the dashboard
Example : 1
integer
properties
required
Widget’s detailed properties
PropertiesDTO
type
required
Widget type
Example : metric
string
width
required
Widget’s width
Example : 1
integer

122 - WidgetDetailDtoV1Dot1

NameDescriptionSchemaDefault
dashboard_id
required
Dashboard’s unique ID
Example : b48e730a70e74f6aa3d2555000b5c22b
string
height
required
Widget’s height
Example : 1
integer
id
required
Widget’s unique ID
Example : 75da70a1a4fb486ab0282cf90693ec3c
string
order
required
Widget’s order in the dashboard
Example : 1
integer
properties
required
Widget’s detailed properties
PropertiesDtoV1Dot1
type
required
Widget type
Example : metric
string
width
required
Widget’s width
Example : 1
integer

123 - WidgetDTO

NameDescriptionSchemaDefault
height
required
Widget’s height
Example : 1
integer
order
required
Widget’s order in the dashboard
Example : 1
integer
properties
required
Widget’s detailed properties
PropertiesDTO
type
required
Widget type
Example : metric
string
width
required
Widget’s width
Example : 1
integer