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

Return to the regular view of this page.

ServiceWatch

1: CLIs

1.1: CreateCustomLogEvents

1.1.1: 1.1

1.2: CreateCustomLogStream

1.2.1: 1.1

1.3: CreateCustomMetricMetas

1.3.1: 1.1

1.4: CreateCustomMetrics

1.4.1: 1.1

1.5: CreateDashboard

1.5.1: 1.1
1.5.2: 1.0

1.6: DeleteBulkDashboards

1.6.1: 1.1
1.6.2: 1.0

1.7: DownloadMetricDataImage

1.7.1: 1.1
1.7.2: 1.0

1.8: ListDashboards

1.8.1: 1.1
1.8.2: 1.0

1.9: ListMetricData

1.9.1: 1.1
1.9.2: 1.0

1.10: ListMetricInfos

1.10.1: 1.1
1.10.2: 1.0

1.11: SetDashboard

1.11.1: 1.1
1.11.2: 1.0

1.12: ShowAgentDownloadLink

1.12.1: 1.1

1.13: ShowDashboard

1.13.1: 1.1
1.13.2: 1.0

Overview

Provides a Command-line Interface (CLI) that supports programmatic use of IaaS/PaaS products provided by SCP.

This guide provides a brief description of ServiceWatch service and how to call CLI.

Version

Version	Status	Supported Until
1.0	SUPPORTED	20260630
1.1	CURRENT	-

1 - CLIs

1.1 - CreateCustomLogEvents

1.1.1 - 1.1

scpcli servicewatch logeventcustom create
--resourcelogs <value>

Description

Create custom log events

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
resourcelogs required	array	Resource Logs	`'{"resource": {"attributes": [{"key": "log_stream_value", "value": {"stringValue": "a1e2f3045678901a2b3c4d5e6f7a8b81"}}, {"key": "log_group_value", "value": {"stringValue": "b1e2f3045678901a2b3c4d5e6f7a8b81"}}, {"key": "account_id", "value": {"stringValue": "c1e2f3045678901a2b3c4d5e6f7a8b81"}}]}, "scopeLogs": [{"logRecords": [{"body": {"stringValue": "level=info otlp test log"}, "timeUnixNano": "1762336464000000000"}]}]}'`

Responses

Name	Description	Example
status	Status	success

1.2 - CreateCustomLogStream

1.2.1 - 1.1

scpcli servicewatch logstreamcustom create
--log_stream_name <value>
--log_group_name <value>

Description

Create a custom log stream

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
log_stream_name required	string	Log stream name	`testls01`
log_group_name required	string	Log group name	`testlg01`

Responses

Name	Description	Example
account_id	Account ID	1bcf39b344ac41cbaf0466ff0d2bebad
log_group_value	Log group value	fa6169af200b4d5db229aff384b2a028
log_stream_value	Log stream value	551513c5182b45beb22eadb634cdccfb
requests_per_second	Export log requests per second	500

1.3 - CreateCustomMetricMetas

1.3.1 - 1.1

scpcli servicewatch metriccustommeta create
--namespace <value>
--metricmetas <value>

Description

Create Custom Metric Metas

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
namespace required	string	Namespace	`MyCustom/filestorage`
metricmetas required	array		`'{"descriptionEn": "filestorage volume total byte", "descriptionKo": "\ud30c\uc77c\uc2a4\ud1a0\ub9ac\uc9c0 \ucd1d \ubc14\uc774\ud2b8 \uc218", "dimensions": [["image_id"]], "metricName": "Custom_filestorage_volume_total_byte", "storageResolution": 60, "unit": "Bytes"}'`

Responses

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

1.4 - CreateCustomMetrics

1.4.1 - 1.1

scpcli servicewatch metriccustom create
--resource_metrics <value>

Description

Create Custom Metrics. The request body of this API can receive data in either camelCase or snake_case.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
resource_metrics required	array	The resourceMetrics field holds a set of all metric data associated with a specific resource	'{"resource": {"attributes": [{"key": "", "value": {"array_value": "", "bool_value": "", "byte_value": "", "double_value": "", "int_value": "", "kvlist_value": "", "string_value": ""}}]}, "scope_metrics": [{"metrics": [{"description": "The total number of bytes read successfully.", "gauge": {"data_points": [{"as_double": 0.75, "as_int": 10, "attributes": [{"key": "", "value": {"array_value": "", "bool_value": "", "byte_value": "", "double_value": "", "int_value": "", "kvlist_value": "", "string_value": ""}}], "start_time_unix_nano": "1753776789854000000", "time_unix_nano": "1753776789854000000"}]}, "name": "node_disk_read_bytes_total", "sum": {"aggregation_temporality": "2", "data_points": [{"as_double": 0.75, "as_int": 10, "attributes": [{"key": "", "value": {"array_value": "", "bool_value": "", "byte_value": "", "double_value": "", "int_value": "", "kvlist_value": "", "string_value": ""}}], "start_time_unix_nano": "1753776789854000000", "time_unix_nano": "1753776789854000000"}], "is_monotonic": true}, "unit": "Bytes"}], "scope": {"name": "ServiceWatch-Agent", "version": "1.0.0"}}]}'

Responses

Name	Description	Example

1.5 - CreateDashboard

1.5.1 - 1.1

scpcli servicewatch dashboard create
--name <value>
[--widgets <value>]

Description

Create dashboard

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
name required	string	Dashboard's name	`New-Monitoring-Dashboard`
widgets optional	array	List of widgets included in the dashboard	```’{“height”: 1, “order”: 1, “properties”: {“metrics”: [{“color”: “#ff7f0e”, “dimensions”: [{“key”: “InstanceId”, “value”: “10bf5d24-0f20-4066-bb0b-de2b1d6ff502”}], “display_name”: “EC2-Prod-CPU”, “individual_items”: [{“key”: “BucketId”, “value”: “b-1234567890abcdef0”}], “name”: “CPUUtilization”, “namespace_name”: “Virtual Server”, “period”: 300, “statistic_type”: “AVG”}], “period”: 300, “stacked”: false, “statistic_type”: “AVG”, “title”: “Virtual Server

Responses

Name	Description	Example
id	Widget’s unique ID	75da70a1a4fb486ab0282cf90693ec3c
dashboard_id	Dashboard’s unique ID	b48e730a70e74f6aa3d2555000b5c22b
height	Widget’s height	1
order	Widget’s order in the dashboard	1
properties	Widget’s detailed properties
type	Widget type	metric
width	Widget’s width	1

1.5.2 - 1.0

scpcli servicewatch dashboard create
--name <value>
[--widgets <value>]

Description

Create dashboard

State ACTIVE (SUPPORTED)

Version	Supported Until
1.0	20260630

Parameters

Name	Type	Description	Example
name required	string	Dashboard's name	`New-Monitoring-Dashboard`
widgets optional	array	List of widgets included in the dashboard	```’{“height”: 1, “order”: 1, “properties”: {“metrics”: [{“color”: “#ff7f0e”, “dimensions”: [{“key”: “InstanceId”, “value”: “10bf5d24-0f20-4066-bb0b-de2b1d6ff502”}], “display_name”: “EC2-Prod-CPU”, “individual_items”: [{“key”: “BucketId”, “value”: “b-1234567890abcdef0”}], “name”: “CPUUtilization”, “namespace_name”: “Virtual Server”, “period”: 300, “statistic_type”: “AVG”}], “period”: 300, “stacked”: false, “statistic_type”: “AVG”, “title”: “Virtual Server

Responses

Name	Description	Example
id	Widget’s unique ID	75da70a1a4fb486ab0282cf90693ec3c
dashboard_id	Dashboard’s unique ID	b48e730a70e74f6aa3d2555000b5c22b
height	Widget’s height	1
order	Widget’s order in the dashboard	1
properties	Widget’s detailed properties
type	Widget type	metric
width	Widget’s width	1

1.6 - DeleteBulkDashboards

1.6.1 - 1.1

scpcli servicewatch dashboard delete
--dashboard_ids <value>

Description

Delete bulk dashboards

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
dashboard_ids required	array	List of dashboard IDs	`b48e730a70e74f6aa3d2555000b5c22b`

1.6.2 - 1.0

scpcli servicewatch dashboard delete
--dashboard_ids <value>

Description

Delete bulk dashboards

State ACTIVE (SUPPORTED)

Version	Supported Until
1.0	20260630

Parameters

Name	Type	Description	Example
dashboard_ids required	array	List of dashboard IDs	`b48e730a70e74f6aa3d2555000b5c22b`

1.7 - DownloadMetricDataImage

1.7.1 - 1.1

scpcli servicewatch metricdataimage list
--statistic_type <value>
--start <value>
--period <value>
--metrics <value>
--end <value>
[--height <value>]
[--timezone <value>]
[--title <value>]
[--width <value>]

Description

Download metric data image

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
statistic_type required	string	Metric Statistics Type	`AVG`
start required	integer	Metric Start Time - Unix Timestamp	`1640995200`
period required	integer	Statistic Period	`300`
metrics required	array		```’{“color”: “#0000ff”, “dimensions”: [{“key”: “VolumeID”, “value”: “45fbde15-cdd2-4891-be31-4a9de75fccda”}], “display_name”: “Virtual Server
end required	integer	Metric End Time - Unix Timestamp	`1640995440`
height optional	integer	Chart Image Height(pixels)	`400`
timezone optional	string	Timezone	`UTC`
title optional	string	Chart Title	`Virtual Server Metric Chart`
width optional	integer	Chart Image Width(pixels)	`600`

Responses

Name	Description	Example

1.7.2 - 1.0

scpcli servicewatch metricdataimage list
--statistic_type <value>
--start <value>
--period <value>
--metrics <value>
--end <value>
[--height <value>]
[--timezone <value>]
[--title <value>]
[--width <value>]

Description

Download metric data image

State ACTIVE (SUPPORTED)

Version	Supported Until
1.0	20260630

Parameters

Name	Type	Description	Example
statistic_type required	string	Metric Statistics Type	`AVG`
start required	integer	Metric Start Time - Unix Timestamp	`1640995200`
period required	integer	Statistic Period	`300`
metrics required	array		```’{“color”: “#0000ff”, “dimensions”: [{“key”: “VolumeID”, “value”: “45fbde15-cdd2-4891-be31-4a9de75fccda”}], “display_name”: “Virtual Server
end required	integer	Metric End Time - Unix Timestamp	`1640995440`
height optional	integer	Chart Image Height(pixels)	`400`
timezone optional	string	Timezone	`UTC`
title optional	string	Chart Title	`Virtual Server Metric Chart`
width optional	integer	Chart Image Width(pixels)	`600`

Responses

Name	Description	Example

1.8 - ListDashboards

1.8.1 - 1.1

scpcli servicewatch dashboard list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--name_like <value>]
[--favorite_enabled <value>]

Description

Get list of dashboards

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`name:asc or modified_at:desc`
name optional	string	Dashboard's name	`MyProd`
name_like optional	string	Wildcard Search for Dashboard Names	`MyProd`
favorite_enabled optional	boolean	Whether it is a favorite dashboard	`True`

Responses

Name	Description	Example
id	Dashboard’s unique ID	b48e730a70e74f6aa3d2555000b5c22b
created_at	Created date time
favorite_enabled	Whether it is a favorite dashboard	True
modified_at	Modified date time
name	Dashboard’s name	Production-Web-Servers
type	Dashboard type	Custom

1.8.2 - 1.0

scpcli servicewatch dashboard list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--name_like <value>]
[--favorite_enabled <value>]

Description

Get list of dashboards

State ACTIVE (SUPPORTED)

Version	Supported Until
1.0	20260630

Parameters

Name	Type	Description	Example
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`name:asc or modified_at:desc`
name optional	string	Dashboard's name	`MyProd`
name_like optional	string	Wildcard Search for Dashboard Names	`MyProd`
favorite_enabled optional	boolean	Whether it is a favorite dashboard	`True`

Responses

Name	Description	Example
id	Dashboard’s unique ID	b48e730a70e74f6aa3d2555000b5c22b
created_at	Created date time
favorite_enabled	Whether it is a favorite dashboard	True
modified_at	Modified date time
name	Dashboard’s name	Production-Web-Servers
type	Dashboard type	Custom

1.9 - ListMetricData

1.9.1 - 1.1

scpcli servicewatch metricdata list
--statistic_type <value>
--start <value>
--period <value>
--metrics <value>
--end <value>

Description

Get metric data list

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
statistic_type required	string	Metric Statistics Type	`AVG`
start required	integer	Metric Start Time - Unix Timestamp	`1640995200`
period required	integer	Statistic Period	`300`
metrics required	array		```’{“dimensions”: [{“key”: “VolumeID”, “value”: “45fbde15-cdd2-4891-be31-4a9de75fccda”}], “display_name”: “Virtual Server
end required	integer	Metric End Time - Unix Timestamp	`1640995440`

Responses

Name	Description	Example
display_name	Metric Display Name	Virtual Server
status
values	List of Metric Series Values	[[1640995200, “45.5”]]

1.9.2 - 1.0

scpcli servicewatch metricdata list
--statistic_type <value>
--start <value>
--period <value>
--metrics <value>
--end <value>

Description

Get metric data list

State ACTIVE (SUPPORTED)

Version	Supported Until
1.0	20260630

Parameters

Name	Type	Description	Example
statistic_type required	string	Metric Statistics Type	`AVG`
start required	integer	Metric Start Time - Unix Timestamp	`1640995200`
period required	integer	Statistic Period	`300`
metrics required	array		```’{“dimensions”: [{“key”: “VolumeID”, “value”: “45fbde15-cdd2-4891-be31-4a9de75fccda”}], “display_name”: “Virtual Server
end required	integer	Metric End Time - Unix Timestamp	`1640995440`

Responses

Name	Description	Example
display_name	Metric Display Name	Virtual Server
status
values	List of Metric Series Values	[[1640995200, “45.5”]]

1.10 - ListMetricInfos

1.10.1 - 1.1

scpcli servicewatch metricinfo list
[--metric_name <value>]
[--namespaces <value>]
[--resource_id <value>]
[--resource_name <value>]
[--tags <value>]

Description

Get metric list

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
metric_name optional	string	Metric Name	`CPU Usage/Core[Basic]`
namespaces optional	array	List of Namespace	`'{"dimensions": "[[\"resource_id\"]]", "name": "Virtual Server"}'`
resource_id optional	string	Resource ID	`10bf5d24-0f20-4066-bb0b-de2b1d6ff502`
resource_name optional	string	Resource Name	`VirtualServer01`
tags optional	array	List of Tags	`'{"key": "key01", "value": "value01"}'`

Responses

Name	Description	Example
id	Namespace ID	d583a229-9766-4eb8-96c4-ec389902ba3d
dimensions
name	Namespace	Virtual Server
service_name

1.10.2 - 1.0

scpcli servicewatch metricinfo list
[--metric_name <value>]
[--namespaces <value>]
[--resource_id <value>]
[--resource_name <value>]
[--tags <value>]

Description

Get metric list

State ACTIVE (SUPPORTED)

Version	Supported Until
1.0	20260630

Parameters

Name	Type	Description	Example
metric_name optional	string	Metric Name	`CPU Usage/Core[Basic]`
namespaces optional	array	List of Namespace	`'{"dimensions": "[\"resource_id\"]", "name": "Virtual Server"}'`
resource_id optional	string	Resource ID	`10bf5d24-0f20-4066-bb0b-de2b1d6ff502`
resource_name optional	string	Resource Name	`VirtualServer01`
tags optional	array	List of Tags	`'{"key": "key01", "value": "value01"}'`

Responses

Name	Description	Example
id	Namespace ID	d583a229-9766-4eb8-96c4-ec389902ba3d
dimensions
name	Namespace	Virtual Server
service_name

1.11 - SetDashboard

1.11.1 - 1.1

scpcli servicewatch dashboard set
--dashboard_id <value>
[--name <value>]
[--widgets <value>]

Description

Set dashboard

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
dashboard_id required	string	Dashboard's unique ID	`b48e730a70e74f6aa3d2555000b5c22b`
name optional	string	Dashboard's name	`Renamed-Dashboard`
widgets optional	array	List of widgets included in the dashboard	```’{“height”: 1, “order”: 1, “properties”: {“metrics”: [{“color”: “#ff7f0e”, “dimensions”: [{“key”: “InstanceId”, “value”: “10bf5d24-0f20-4066-bb0b-de2b1d6ff502”}], “display_name”: “EC2-Prod-CPU”, “individual_items”: [{“key”: “BucketId”, “value”: “b-1234567890abcdef0”}], “name”: “CPUUtilization”, “namespace_name”: “Virtual Server”, “period”: 300, “statistic_type”: “AVG”}], “period”: 300, “stacked”: false, “statistic_type”: “AVG”, “title”: “Virtual Server

1.11.2 - 1.0

scpcli servicewatch dashboard set
--dashboard_id <value>
[--name <value>]
[--widgets <value>]

Description

Set dashboard

State ACTIVE (SUPPORTED)

Version	Supported Until
1.0	20260630

Parameters

Name	Type	Description	Example
dashboard_id required	string	Dashboard's unique ID	`b48e730a70e74f6aa3d2555000b5c22b`
name optional	string	Dashboard's name	`Renamed-Dashboard`
widgets optional	array	List of widgets included in the dashboard	```’{“height”: 1, “order”: 1, “properties”: {“metrics”: [{“color”: “#ff7f0e”, “dimensions”: [{“key”: “InstanceId”, “value”: “10bf5d24-0f20-4066-bb0b-de2b1d6ff502”}], “display_name”: “EC2-Prod-CPU”, “individual_items”: [{“key”: “BucketId”, “value”: “b-1234567890abcdef0”}], “name”: “CPUUtilization”, “namespace_name”: “Virtual Server”, “period”: 300, “statistic_type”: “AVG”}], “period”: 300, “stacked”: false, “statistic_type”: “AVG”, “title”: “Virtual Server

1.12 - ShowAgentDownloadLink

1.12.1 - 1.1

scpcli servicewatch show agent download link

Description

Show link to agent download

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Responses

Name	Description	Example
download_link	URL to download agent	download_link = ‘https://object-store.private.{region}.{environment}.samsungsdscloud.com/account:swt-agent/1.0/ServiceWatch_Agent.zip’

1.13 - ShowDashboard

1.13.1 - 1.1

scpcli servicewatch dashboard show
--dashboard_id <value>

Description

Show dashboard

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
dashboard_id required	string	Dashboard's unique ID	`b48e730a70e74f6aa3d2555000b5c22b`

Responses

Name	Description	Example
id	Widget’s unique ID	75da70a1a4fb486ab0282cf90693ec3c
dashboard_id	Dashboard’s unique ID	b48e730a70e74f6aa3d2555000b5c22b
height	Widget’s height	1
order	Widget’s order in the dashboard	1
properties	Widget’s detailed properties
type	Widget type	metric
width	Widget’s width	1

1.13.2 - 1.0

scpcli servicewatch dashboard show
--dashboard_id <value>

Description

Show dashboard

State ACTIVE (SUPPORTED)

Version	Supported Until
1.0	20260630

Parameters

Name	Type	Description	Example
dashboard_id required	string	Dashboard's unique ID	`b48e730a70e74f6aa3d2555000b5c22b`

Responses

Name	Description	Example
id	Widget’s unique ID	75da70a1a4fb486ab0282cf90693ec3c
dashboard_id	Dashboard’s unique ID	b48e730a70e74f6aa3d2555000b5c22b
height	Widget’s height	1
order	Widget’s order in the dashboard	1
properties	Widget’s detailed properties
type	Widget type	metric
width	Widget’s width	1