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

Return to the regular view of this page.

CLIs

1 - CreateAlert

1.1 - 1.4

scp-cli servicewatch alert create
--value <value>
--key <value>
--statistic <value>
--period <value>
--operator <value>
--namespace_id <value>
--name <value>
--metric_id <value>
--level <value>
[--description <value>]
[--dimensions <value>]
[--evaluation_count <value>]
[--individual_items <value>]
[--lower_bound <value>]
[--missing_data_option <value>]
[--recipient_ids <value>]
[--tags <value>]
[--threshold <value>]
[--upper_bound <value>]
[--violation_count <value>]

Description

Create an Alert

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
value
required
stringDimension Value10bf5d24-0f20-4066-bb0b-de2b1d6ff502
key
required
stringDimension Keyresource_id
statistic
required
stringStatistic - SUM, AVG, MAX, MINAVG
period
required
integerPeriod (seconds)300
operator
required
stringOperator - EQ, NOT_EQ, GT, GTE, LT, LTE, RANGERANGE
namespace_id
required
stringNamespace ID1d9d05af5c624f2cb80a45f2c911e2f4
name
required
stringAlert NameAlert Test
metric_id
required
stringMetric IDf13aab3b88c341b2bc73f8925a0e8cc5
level
required
stringAlert Level - HIGH, MIDDLE, LOWHIGH
description
optional
stringAlert DescriptionDescription for Alert Test
dimensions
optional
arrayList of Dimensions'{"key": "resource_id", "value": "10bf5d24-0f20-4066-bb0b-de2b1d6ff502"}'
evaluation_count
optional
integerEvaluation Count for the Alert Condition3
individual_items
optional
arrayList of Individual Items'{"key": "VolumeID", "value": "45fbde15-cdd2-4891-be31-4a9de75fccda"}'
lower_bound
optional
numberLower bound for the Alert range operator80.0
missing_data_option
optional
****Missing Data Option - MISSING, BREACHING, NOT_BREACHING, IGNOREBREACHING
recipient_ids
optional
arrayList of User IDs1234da92-634a-4f8c-932e-9d650599ab1b
tags
optional
arrayList of Tags'{"key": "key01", "value": "value01"}'
threshold
optional
numberThreshold for the Alert Condition (except fro RANGE operator)80.0
upper_bound
optional
numberUpper bound for the Alert range operator90.0
violation_count
optional
integerViolation Count for the Alert Condition2

Responses

NameDescriptionExample
idAlert ID3234bd0f12fa4d0b97ab9feff6c09b8e
created_atCreated date time
created_byCreator IDf4b8a4c4017f4f8d8399f0c02582ae47

1.2 - 1.3

scp-cli servicewatch alert create
--value <value>
--key <value>
--statistic <value>
--period <value>
--operator <value>
--namespace_id <value>
--name <value>
--metric_id <value>
--level <value>
[--description <value>]
[--dimensions <value>]
[--evaluation_count <value>]
[--individual_items <value>]
[--lower_bound <value>]
[--missing_data_option <value>]
[--recipient_ids <value>]
[--tags <value>]
[--threshold <value>]
[--upper_bound <value>]
[--violation_count <value>]

Description

Create an Alert

State ACTIVE (SUPPORTED)

VersionNot Before
1.320270131

Parameters

NameTypeDescriptionExample
value
required
stringDimension Value10bf5d24-0f20-4066-bb0b-de2b1d6ff502
key
required
stringDimension Keyresource_id
statistic
required
stringStatistic - SUM, AVG, MAX, MINAVG
period
required
integerPeriod (seconds)300
operator
required
stringOperator - EQ, NOT_EQ, GT, GTE, LT, LTE, RANGERANGE
namespace_id
required
stringNamespace ID1d9d05af5c624f2cb80a45f2c911e2f4
name
required
stringAlert NameAlert Test
metric_id
required
stringMetric IDf13aab3b88c341b2bc73f8925a0e8cc5
level
required
stringAlert Level - HIGH, MIDDLE, LOWHIGH
description
optional
stringAlert DescriptionDescription for Alert Test
dimensions
optional
arrayList of Dimensions'{"key": "resource_id", "value": "10bf5d24-0f20-4066-bb0b-de2b1d6ff502"}'
evaluation_count
optional
integerEvaluation Count for the Alert Condition3
individual_items
optional
arrayList of Individual Items'{"key": "VolumeID", "value": "45fbde15-cdd2-4891-be31-4a9de75fccda"}'
lower_bound
optional
numberLower bound for the Alert range operator80.0
missing_data_option
optional
****Missing Data Option - MISSING, BREACHING, NOT_BREACHING, IGNOREBREACHING
recipient_ids
optional
arrayList of User IDs1234da92-634a-4f8c-932e-9d650599ab1b
tags
optional
arrayList of Tags'{"key": "key01", "value": "value01"}'
threshold
optional
numberThreshold for the Alert Condition (except fro RANGE operator)80.0
upper_bound
optional
numberUpper bound for the Alert range operator90.0
violation_count
optional
integerViolation Count for the Alert Condition2

Responses

NameDescriptionExample
idAlert ID3234bd0f12fa4d0b97ab9feff6c09b8e
created_atCreated date time
created_byCreator IDf4b8a4c4017f4f8d8399f0c02582ae47

1.3 - 1.2

scp-cli servicewatch alert create
--value <value>
--key <value>
--statistic <value>
--period <value>
--operator <value>
--namespace_id <value>
--name <value>
--metric_id <value>
--level <value>
[--description <value>]
[--dimensions <value>]
[--evaluation_count <value>]
[--individual_items <value>]
[--lower_bound <value>]
[--missing_data_option <value>]
[--recipient_ids <value>]
[--tags <value>]
[--threshold <value>]
[--upper_bound <value>]
[--violation_count <value>]

Description

Create an Alert

State ACTIVE (SUPPORTED)

VersionNot Before
1.220261130

Parameters

NameTypeDescriptionExample
value
required
stringDimension Value10bf5d24-0f20-4066-bb0b-de2b1d6ff502
key
required
stringDimension Keyresource_id
statistic
required
stringStatistic - SUM, AVG, MAX, MINAVG
period
required
integerPeriod (seconds)300
operator
required
stringOperator - EQ, NOT_EQ, GT, GTE, LT, LTE, RANGERANGE
namespace_id
required
stringNamespace ID1d9d05af5c624f2cb80a45f2c911e2f4
name
required
stringAlert NameAlert Test
metric_id
required
stringMetric IDf13aab3b88c341b2bc73f8925a0e8cc5
level
required
stringAlert Level - HIGH, MIDDLE, LOWHIGH
description
optional
stringAlert DescriptionDescription for Alert Test
dimensions
optional
arrayList of Dimensions'{"key": "resource_id", "value": "10bf5d24-0f20-4066-bb0b-de2b1d6ff502"}'
evaluation_count
optional
integerEvaluation Count for the Alert Condition3
individual_items
optional
arrayList of Individual Items'{"key": "VolumeID", "value": "45fbde15-cdd2-4891-be31-4a9de75fccda"}'
lower_bound
optional
numberLower bound for the Alert range operator80.0
missing_data_option
optional
****Missing Data Option - MISSING, BREACHING, NOT_BREACHING, IGNOREBREACHING
recipient_ids
optional
arrayList of User IDs1234da92-634a-4f8c-932e-9d650599ab1b
tags
optional
arrayList of Tags'{"key": "key01", "value": "value01"}'
threshold
optional
numberThreshold for the Alert Condition (except fro RANGE operator)80.0
upper_bound
optional
numberUpper bound for the Alert range operator90.0
violation_count
optional
integerViolation Count for the Alert Condition2

Responses

NameDescriptionExample
idAlert ID3234bd0f12fa4d0b97ab9feff6c09b8e
created_atCreated date time
created_byCreator IDf4b8a4c4017f4f8d8399f0c02582ae47

2 - CreateCustomLogEvents

2.1 - 1.4

scp-cli servicewatch logeventcustom create
--resourcelogs <value>

Description

Create Custom log events

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
resourcelogs
required
arrayResource 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

NameDescriptionExample
statusStatussuccess

2.2 - 1.3

scp-cli servicewatch logeventcustom create
--resourcelogs <value>

Description

Create Custom log events

State ACTIVE (SUPPORTED)

VersionNot Before
1.320270131

Parameters

NameTypeDescriptionExample
resourcelogs
required
arrayResource 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

NameDescriptionExample
statusStatussuccess

2.3 - 1.2

scp-cli servicewatch logeventcustom create
--resourcelogs <value>

Description

Create Custom log events

State ACTIVE (SUPPORTED)

VersionNot Before
1.220261130

Parameters

NameTypeDescriptionExample
resourcelogs
required
arrayResource 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

NameDescriptionExample
statusStatussuccess

2.4 - 1.1

scp-cli servicewatch logeventcustom create
--resourcelogs <value>

Description

Create Custom log events

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260831

Parameters

NameTypeDescriptionExample
resourcelogs
required
arrayResource 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

NameDescriptionExample
statusStatussuccess

3 - CreateCustomLogStream

3.1 - 1.4

scp-cli servicewatch logstreamcustom create
--log_stream_name <value>
--log_group_name <value>

Description

Create a custom log stream

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
log_stream_name
required
stringLog stream nametestls01
log_group_name
required
stringLog group nametestlg01

Responses

NameDescriptionExample
account_idAccount ID1bcf39b344ac41cbaf0466ff0d2bebad
log_group_valueLog group valuefa6169af200b4d5db229aff384b2a028
log_stream_valueLog stream value551513c5182b45beb22eadb634cdccfb
requests_per_secondExport log requests per second500

3.2 - 1.3

scp-cli servicewatch logstreamcustom create
--log_stream_name <value>
--log_group_name <value>

Description

Create a custom log stream

State ACTIVE (SUPPORTED)

VersionNot Before
1.320270131

Parameters

NameTypeDescriptionExample
log_stream_name
required
stringLog stream nametestls01
log_group_name
required
stringLog group nametestlg01

Responses

NameDescriptionExample
account_idAccount ID1bcf39b344ac41cbaf0466ff0d2bebad
log_group_valueLog group valuefa6169af200b4d5db229aff384b2a028
log_stream_valueLog stream value551513c5182b45beb22eadb634cdccfb
requests_per_secondExport log requests per second500

3.3 - 1.2

scp-cli servicewatch logstreamcustom create
--log_stream_name <value>
--log_group_name <value>

Description

Create a custom log stream

State ACTIVE (SUPPORTED)

VersionNot Before
1.220261130

Parameters

NameTypeDescriptionExample
log_stream_name
required
stringLog stream nametestls01
log_group_name
required
stringLog group nametestlg01

Responses

NameDescriptionExample
account_idAccount ID1bcf39b344ac41cbaf0466ff0d2bebad
log_group_valueLog group valuefa6169af200b4d5db229aff384b2a028
log_stream_valueLog stream value551513c5182b45beb22eadb634cdccfb
requests_per_secondExport log requests per second500

3.4 - 1.1

scp-cli servicewatch logstreamcustom create
--log_stream_name <value>
--log_group_name <value>

Description

Create a custom log stream

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260831

Parameters

NameTypeDescriptionExample
log_stream_name
required
stringLog stream nametestls01
log_group_name
required
stringLog group nametestlg01

Responses

NameDescriptionExample
account_idAccount ID1bcf39b344ac41cbaf0466ff0d2bebad
log_group_valueLog group valuefa6169af200b4d5db229aff384b2a028
log_stream_valueLog stream value551513c5182b45beb22eadb634cdccfb
requests_per_secondExport log requests per second500

4 - CreateCustomMetricMetas

4.1 - 1.4

scp-cli servicewatch metriccustommeta create
--namespace <value>
--metricmetas <value>

Description

Create Custom Metric Metas

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
namespace
required
stringNamespaceMyCustom/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

NameDescriptionExample
account_idAccount ID of Metricsd79a5194b1a44a858969eb94754d3ba1
max_data_points
unit_logs[]

4.2 - 1.3

scp-cli servicewatch metriccustommeta create
--namespace <value>
--metricmetas <value>

Description

Create Custom Metric Metas

State ACTIVE (SUPPORTED)

VersionNot Before
1.320270131

Parameters

NameTypeDescriptionExample
namespace
required
stringNamespaceMyCustom/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

NameDescriptionExample
account_idAccount ID of Metricsd79a5194b1a44a858969eb94754d3ba1
max_data_points
unit_logs[]

4.3 - 1.2

scp-cli servicewatch metriccustommeta create
--namespace <value>
--metricmetas <value>

Description

Create Custom Metric Metas

State ACTIVE (SUPPORTED)

VersionNot Before
1.220261130

Parameters

NameTypeDescriptionExample
namespace
required
stringNamespaceMyCustom/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

NameDescriptionExample
account_idAccount ID of Metricsd79a5194b1a44a858969eb94754d3ba1
max_data_points
unit_logs[]

4.4 - 1.1

scp-cli servicewatch metriccustommeta create
--namespace <value>
--metricmetas <value>

Description

Create Custom Metric Metas

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260831

Parameters

NameTypeDescriptionExample
namespace
required
stringNamespaceMyCustom/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

NameDescriptionExample
account_idAccount ID of Metricsd79a5194b1a44a858969eb94754d3ba1
max_data_points
unit_logs[]

5 - CreateCustomMetrics

5.1 - 1.4

scp-cli 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)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
resource_metrics
required
arrayThe 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

NameDescriptionExample

5.2 - 1.3

scp-cli 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 (SUPPORTED)

VersionNot Before
1.320270131

Parameters

NameTypeDescriptionExample
resource_metrics
required
arrayThe 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

NameDescriptionExample

5.3 - 1.2

scp-cli 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 (SUPPORTED)

VersionNot Before
1.220261130

Parameters

NameTypeDescriptionExample
resource_metrics
required
arrayThe 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

NameDescriptionExample

5.4 - 1.1

scp-cli 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 (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260831

Parameters

NameTypeDescriptionExample
resource_metrics
required
arrayThe 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

NameDescriptionExample

6 - CreateDashboard

6.1 - 1.4

scp-cli servicewatch dashboard create
--name <value>
[--widgets <value>]

Description

Create dashboard

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
name
required
stringDashboard's nameNew-Monitoring-Dashboard
widgets
optional
arrayList of widgets included in the dashboard```’{“height”: 1, “order”: 1, “properties”: {“metrics”: [{“color”: “#ff7f0e”, “dimensions”: [{“key”: “resource_id”, “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

NameDescriptionExample
idDashboard’s unique IDb48e730a70e74f6aa3d2555000b5c22b
alertsAlert information related to the dashboard{}
created_atCreated date time
created_byCreator IDuser-xxxxxxxx
favorite_enabledWhether it is a favorite dashboardTrue
modified_atModified date time
modified_byModifier IDuser-yyyyyyyy
nameDashboard’s nameProduction-Web-Servers
product_nameAssociated resource typeServiceWatch
resource_idAssociated resource IDc8e41e595ad040a8abe57e2ffc109113
resource_nameAssociated resource nameProduction-Web-Servers
resource_typeAssociated resource typedashboard
service_codeAssociated service codevirtualserver
share_typeSharing typePrivate
srnService resource name (SRN)srn:vs:kr-central-1:123456789012:instance/c8e41e595ad040a8abe57e2ffc109113
typeDashboard typeCustom
widgetsList of widgets included in the dashboard[]

6.2 - 1.3

scp-cli servicewatch dashboard create
--name <value>
[--widgets <value>]

Description

Create dashboard

State ACTIVE (SUPPORTED)

VersionNot Before
1.320270131

Parameters

NameTypeDescriptionExample
name
required
stringDashboard's nameNew-Monitoring-Dashboard
widgets
optional
arrayList of widgets included in the dashboard```’{“height”: 1, “order”: 1, “properties”: {“metrics”: [{“color”: “#ff7f0e”, “dimensions”: [{“key”: “resource_id”, “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

NameDescriptionExample
idDashboard’s unique IDb48e730a70e74f6aa3d2555000b5c22b
alertsAlert information related to the dashboard{}
created_atCreated date time
created_byCreator IDuser-xxxxxxxx
favorite_enabledWhether it is a favorite dashboardTrue
modified_atModified date time
modified_byModifier IDuser-yyyyyyyy
nameDashboard’s nameProduction-Web-Servers
product_nameAssociated resource typeServiceWatch
resource_idAssociated resource IDc8e41e595ad040a8abe57e2ffc109113
resource_nameAssociated resource nameProduction-Web-Servers
resource_typeAssociated resource typedashboard
service_codeAssociated service codevirtualserver
share_typeSharing typePrivate
srnService resource name (SRN)srn:vs:kr-central-1:123456789012:instance/c8e41e595ad040a8abe57e2ffc109113
typeDashboard typeCustom
widgetsList of widgets included in the dashboard[]

6.3 - 1.2

scp-cli servicewatch dashboard create
--name <value>
[--widgets <value>]

Description

Create dashboard

State ACTIVE (SUPPORTED)

VersionNot Before
1.220261130

Parameters

NameTypeDescriptionExample
name
required
stringDashboard's nameNew-Monitoring-Dashboard
widgets
optional
arrayList of widgets included in the dashboard```’{“height”: 1, “order”: 1, “properties”: {“metrics”: [{“color”: “#ff7f0e”, “dimensions”: [{“key”: “resource_id”, “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

NameDescriptionExample
idDashboard’s unique IDb48e730a70e74f6aa3d2555000b5c22b
alertsAlert information related to the dashboard{}
created_atCreated date time
created_byCreator IDuser-xxxxxxxx
favorite_enabledWhether it is a favorite dashboardTrue
modified_atModified date time
modified_byModifier IDuser-yyyyyyyy
nameDashboard’s nameProduction-Web-Servers
product_nameAssociated resource typeServiceWatch
resource_idAssociated resource IDc8e41e595ad040a8abe57e2ffc109113
resource_nameAssociated resource nameProduction-Web-Servers
resource_typeAssociated resource typedashboard
service_codeAssociated service codevirtualserver
share_typeSharing typePrivate
srnService resource name (SRN)srn:vs:kr-central-1:123456789012:instance/c8e41e595ad040a8abe57e2ffc109113
typeDashboard typeCustom
widgetsList of widgets included in the dashboard[]

6.4 - 1.1

scp-cli servicewatch dashboard create
--name <value>
[--widgets <value>]

Description

Create dashboard

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260831

Parameters

NameTypeDescriptionExample
name
required
stringDashboard's nameNew-Monitoring-Dashboard
widgets
optional
arrayList of widgets included in the dashboard```’{“height”: 1, “order”: 1, “properties”: {“metrics”: [{“color”: “#ff7f0e”, “dimensions”: [{“key”: “resource_id”, “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

NameDescriptionExample
idDashboard’s unique IDb48e730a70e74f6aa3d2555000b5c22b
alertsAlert information related to the dashboard{}
created_atCreated date time
created_byCreator IDuser-xxxxxxxx
favorite_enabledWhether it is a favorite dashboardTrue
modified_atModified date time
modified_byModifier IDuser-yyyyyyyy
nameDashboard’s nameProduction-Web-Servers
product_nameAssociated resource typeServiceWatch
resource_idAssociated resource IDc8e41e595ad040a8abe57e2ffc109113
resource_nameAssociated resource nameProduction-Web-Servers
resource_typeAssociated resource typedashboard
service_codeAssociated service codevirtualserver
share_typeSharing typePrivate
srnService resource name (SRN)srn:vs:kr-central-1:123456789012:instance/c8e41e595ad040a8abe57e2ffc109113
typeDashboard typeCustom
widgetsList of widgets included in the dashboard[]

6.5 - 1.0

scp-cli servicewatch dashboard create
--name <value>
[--widgets <value>]

Description

Create dashboard

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260630

Parameters

NameTypeDescriptionExample
name
required
stringDashboard's nameNew-Monitoring-Dashboard
widgets
optional
arrayList of widgets included in the dashboard```’{“height”: 1, “order”: 1, “properties”: {“metrics”: [{“color”: “#ff7f0e”, “dimensions”: [{“key”: “resource_id”, “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

NameDescriptionExample
idDashboard’s unique IDb48e730a70e74f6aa3d2555000b5c22b
alertsAlert information related to the dashboard{}
created_atCreated date time
created_byCreator IDuser-xxxxxxxx
favorite_enabledWhether it is a favorite dashboardTrue
modified_atModified date time
modified_byModifier IDuser-yyyyyyyy
nameDashboard’s nameProduction-Web-Servers
product_nameAssociated resource typeServiceWatch
resource_idAssociated resource IDc8e41e595ad040a8abe57e2ffc109113
resource_nameAssociated resource nameProduction-Web-Servers
resource_typeAssociated resource typedashboard
share_typeSharing typePrivate
srnService resource name (SRN)srn:vs:kr-central-1:123456789012:instance/c8e41e595ad040a8abe57e2ffc109113
typeDashboard typeCustom
widgetsList of widgets included in the dashboard[]

7 - CreateEventRule

7.1 - 1.4

scp-cli servicewatch eventrule create
--service_id <value>
--name <value>
[--description <value>]
[--event_ids <value>]
[--recipient_ids <value>]
[--resource_type_id <value>]
[--srn_list <value>]
[--tags <value>]

Description

Create an Event rule.

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
service_id
required
stringService ID2778de83d7e247609445bbd570a4eba9
name
required
stringEvent rule nameEvent rule 1
description
optional
stringEvent rule descriptionEvent rule 1 description
event_ids
optional
arrayList of Event IDs014cb88ca2a9420e840d5c9ac16cac89
recipient_ids
optional
arrayNotification recipient IDs947c6a8559434505b28a5e21fff463d0
resource_type_id
optional
stringResource type ID596bf16709e84e27b7df397bf59b877c
srn_list
optional
arrayList of SDS cloud Resource Namessrn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::servicewatch:event-rule/a58c8645928043a6868277c7d7fef11a
tags
optional
arrayList of Tags'{"key": "", "value": ""}'

Responses

NameDescriptionExample
event_ruleEvent rule

7.2 - 1.3

scp-cli servicewatch eventrule create
--service_id <value>
--name <value>
[--description <value>]
[--event_ids <value>]
[--recipient_ids <value>]
[--resource_type_id <value>]
[--srn_list <value>]
[--tags <value>]

Description

Create an Event rule.

State ACTIVE (SUPPORTED)

VersionNot Before
1.320270131

Parameters

NameTypeDescriptionExample
service_id
required
stringService ID2778de83d7e247609445bbd570a4eba9
name
required
stringEvent rule nameEvent rule 1
description
optional
stringEvent rule descriptionEvent rule 1 description
event_ids
optional
arrayList of Event IDs014cb88ca2a9420e840d5c9ac16cac89
recipient_ids
optional
arrayNotification recipient IDs947c6a8559434505b28a5e21fff463d0
resource_type_id
optional
stringResource type ID596bf16709e84e27b7df397bf59b877c
srn_list
optional
arrayList of SDS cloud Resource Namessrn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::servicewatch:event-rule/a58c8645928043a6868277c7d7fef11a
tags
optional
arrayList of Tags'{"key": "", "value": ""}'

Responses

NameDescriptionExample
event_ruleEvent rule

7.3 - 1.2

scp-cli servicewatch eventrule create
--service_id <value>
--name <value>
[--description <value>]
[--event_ids <value>]
[--recipient_ids <value>]
[--resource_type_id <value>]
[--srn_list <value>]
[--tags <value>]

Description

Create an Event rule.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220261130

Parameters

NameTypeDescriptionExample
service_id
required
stringService ID2778de83d7e247609445bbd570a4eba9
name
required
stringEvent rule nameEvent rule 1
description
optional
stringEvent rule descriptionEvent rule 1 description
event_ids
optional
arrayList of Event IDs014cb88ca2a9420e840d5c9ac16cac89
recipient_ids
optional
arrayNotification recipient IDs947c6a8559434505b28a5e21fff463d0
resource_type_id
optional
stringResource type ID596bf16709e84e27b7df397bf59b877c
srn_list
optional
arrayList of SDS cloud Resource Namessrn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::servicewatch:event-rule/a58c8645928043a6868277c7d7fef11a
tags
optional
arrayList of Tags'{"key": "", "value": ""}'

Responses

NameDescriptionExample
event_ruleEvent rule

7.4 - 1.1

scp-cli servicewatch eventrule create
--service_id <value>
--name <value>
[--description <value>]
[--event_ids <value>]
[--recipient_ids <value>]
[--resource_type_id <value>]
[--srn_list <value>]
[--tags <value>]

Description

Create an Event rule.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260831

Parameters

NameTypeDescriptionExample
service_id
required
stringService ID2778de83d7e247609445bbd570a4eba9
name
required
stringEvent rule nameEvent rule 1
description
optional
stringEvent rule descriptionEvent rule 1 description
event_ids
optional
arrayList of Event IDs014cb88ca2a9420e840d5c9ac16cac89
recipient_ids
optional
arrayNotification recipient IDs947c6a8559434505b28a5e21fff463d0
resource_type_id
optional
stringResource type ID596bf16709e84e27b7df397bf59b877c
srn_list
optional
arrayList of SDS cloud Resource Namessrn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::servicewatch:event-rule/a58c8645928043a6868277c7d7fef11a
tags
optional
arrayList of Tags'{"key": "", "value": ""}'

Responses

NameDescriptionExample
event_ruleEvent rule

7.5 - 1.0

scp-cli servicewatch eventrule create
--service_id <value>
--name <value>
[--description <value>]
[--event_ids <value>]
[--recipient_ids <value>]
[--resource_type_id <value>]
[--srn_list <value>]
[--tags <value>]

Description

Create an Event rule.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260630

Parameters

NameTypeDescriptionExample
service_id
required
stringService ID2778de83d7e247609445bbd570a4eba9
name
required
stringEvent rule nameEvent rule 1
description
optional
stringEvent rule descriptionEvent rule 1 description
event_ids
optional
arrayList of Event IDs014cb88ca2a9420e840d5c9ac16cac89
recipient_ids
optional
arrayNotification recipient IDs947c6a8559434505b28a5e21fff463d0
resource_type_id
optional
stringResource type ID596bf16709e84e27b7df397bf59b877c
srn_list
optional
arrayList of SDS cloud Resource Namessrn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::servicewatch:event-rule/a58c8645928043a6868277c7d7fef11a
tags
optional
arrayList of Tags'{"key": "", "value": ""}'

Responses

NameDescriptionExample
event_ruleEvent rule

8 - CreateLogGroup

8.1 - 1.4

scp-cli servicewatch loggroup create
--retention_period <value>
--name <value>
[--tags <value>]

Description

Create a Log group.

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
retention_period
required
integerLog group retention period365
name
required
stringLog group nametestlg01
tags
optional
arrayList of Tags'{"key": "", "value": ""}'

Responses

NameDescriptionExample
log_groupLog group

8.2 - 1.3

scp-cli servicewatch loggroup create
--retention_period <value>
--name <value>
[--tags <value>]

Description

Create a Log group.

State ACTIVE (SUPPORTED)

VersionNot Before
1.320270131

Parameters

NameTypeDescriptionExample
retention_period
required
integerLog group retention period365
name
required
stringLog group nametestlg01
tags
optional
arrayList of Tags'{"key": "", "value": ""}'

Responses

NameDescriptionExample
log_groupLog group

8.3 - 1.2

scp-cli servicewatch loggroup create
--retention_period <value>
--name <value>
[--tags <value>]

Description

Create a Log group.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220261130

Parameters

NameTypeDescriptionExample
retention_period
required
integerLog group retention period365
name
required
stringLog group nametestlg01
tags
optional
arrayList of Tags'{"key": "", "value": ""}'

Responses

NameDescriptionExample
log_groupLog group

8.4 - 1.1

scp-cli servicewatch loggroup create
--retention_period <value>
--name <value>
[--tags <value>]

Description

Create a Log group.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260831

Parameters

NameTypeDescriptionExample
retention_period
required
integerLog group retention period365
name
required
stringLog group nametestlg01
tags
optional
arrayList of Tags'{"key": "", "value": ""}'

Responses

NameDescriptionExample
log_groupLog group

8.5 - 1.0

scp-cli servicewatch loggroup create
--retention_period <value>
--name <value>
[--tags <value>]

Description

Create a Log group.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260630

Parameters

NameTypeDescriptionExample
retention_period
required
integerLog group retention period365
name
required
stringLog group nametestlg01
tags
optional
arrayList of Tags'{"key": "", "value": ""}'

Responses

NameDescriptionExample
log_groupLog group

9 - CreateLogGroupExportTask

9.1 - 1.4

scp-cli servicewatch loggroupexport create
--start_at <value>
--log_stream_ids <value>
--log_group_id <value>
--end_at <value>
--bucket_name <value>

Description

Create a Log group export task.

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
start_at
required
stringStart datetime-
log_stream_ids
required
arrayList of Log stream IDs-
log_group_id
required
stringLog group ID-
end_at
required
stringEnd datetime-
bucket_name
required
stringLog group export task bucket name-

Responses

NameDescriptionExample
log_group_exportLog group export task

10 - CreateLogStream

10.1 - 1.4

scp-cli servicewatch logstream create
--log_group_id <value>
--name <value>

Description

Create a Log group log stream.

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
log_group_id
required
stringLog group IDbce52822147744b4afe0187164caa2e8
name
required
stringLog stream nametestls01

Responses

NameDescriptionExample
log_streamLog stream

10.2 - 1.3

scp-cli servicewatch logstream create
--log_group_id <value>
--name <value>

Description

Create a Log group log stream.

State ACTIVE (SUPPORTED)

VersionNot Before
1.320270131

Parameters

NameTypeDescriptionExample
log_group_id
required
stringLog group IDbce52822147744b4afe0187164caa2e8
name
required
stringLog stream nametestls01

Responses

NameDescriptionExample
log_streamLog stream

10.3 - 1.2

scp-cli servicewatch logstream create
--log_group_id <value>
--name <value>

Description

Create a Log group log stream.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220261130

Parameters

NameTypeDescriptionExample
log_group_id
required
stringLog group IDbce52822147744b4afe0187164caa2e8
name
required
stringLog stream nametestls01

Responses

NameDescriptionExample
log_streamLog stream

10.4 - 1.1

scp-cli servicewatch logstream create
--log_group_id <value>
--name <value>

Description

Create a Log group log stream.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260831

Parameters

NameTypeDescriptionExample
log_group_id
required
stringLog group IDbce52822147744b4afe0187164caa2e8
name
required
stringLog stream nametestls01

Responses

NameDescriptionExample
log_streamLog stream

10.5 - 1.0

scp-cli servicewatch logstream create
--log_group_id <value>
--name <value>

Description

Create a Log group log stream.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260630

Parameters

NameTypeDescriptionExample
log_group_id
required
stringLog group IDbce52822147744b4afe0187164caa2e8
name
required
stringLog stream nametestls01

Responses

NameDescriptionExample
log_streamLog stream

11 - DeleteAlerts

11.1 - 1.4

scp-cli servicewatch alert delete-bulk
--ids <value>

Description

Delete Alerts

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
ids
required
arrayList of Alert IDs3234bd0f12fa4d0b97ab9feff6c09b8e

11.2 - 1.3

scp-cli servicewatch alert delete-bulk
--ids <value>

Description

Delete Alerts

State ACTIVE (SUPPORTED)

VersionNot Before
1.320270131

Parameters

NameTypeDescriptionExample
ids
required
arrayList of Alert IDs3234bd0f12fa4d0b97ab9feff6c09b8e

11.3 - 1.2

scp-cli servicewatch alert delete-bulk
--ids <value>

Description

Delete Alerts

State ACTIVE (SUPPORTED)

VersionNot Before
1.220261130

Parameters

NameTypeDescriptionExample
ids
required
arrayList of Alert IDs3234bd0f12fa4d0b97ab9feff6c09b8e

12 - DeleteBulkDashboards

12.1 - 1.4

scp-cli servicewatch dashboard delete
--dashboard_ids <value>

Description

Delete bulk dashboards

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
dashboard_ids
required
arrayList of dashboard IDsb48e730a70e74f6aa3d2555000b5c22b

12.2 - 1.3

scp-cli servicewatch dashboard delete
--dashboard_ids <value>

Description

Delete bulk dashboards

State ACTIVE (SUPPORTED)

VersionNot Before
1.320270131

Parameters

NameTypeDescriptionExample
dashboard_ids
required
arrayList of dashboard IDsb48e730a70e74f6aa3d2555000b5c22b

12.3 - 1.2

scp-cli servicewatch dashboard delete
--dashboard_ids <value>

Description

Delete bulk dashboards

State ACTIVE (SUPPORTED)

VersionNot Before
1.220261130

Parameters

NameTypeDescriptionExample
dashboard_ids
required
arrayList of dashboard IDsb48e730a70e74f6aa3d2555000b5c22b

12.4 - 1.1

scp-cli servicewatch dashboard delete
--dashboard_ids <value>

Description

Delete bulk dashboards

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260831

Parameters

NameTypeDescriptionExample
dashboard_ids
required
arrayList of dashboard IDsb48e730a70e74f6aa3d2555000b5c22b

12.5 - 1.0

scp-cli servicewatch dashboard delete
--dashboard_ids <value>

Description

Delete bulk dashboards

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260630

Parameters

NameTypeDescriptionExample
dashboard_ids
required
arrayList of dashboard IDsb48e730a70e74f6aa3d2555000b5c22b

13 - DeleteEventRules

13.1 - 1.4

scp-cli servicewatch eventrule delete-bulk
--ids <value>

Description

Delete Event rules.

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
ids
required
arrayList of Event rule IDs66d77b4e32d04558b2382b1d14765d86

13.2 - 1.3

scp-cli servicewatch eventrule delete-bulk
--ids <value>

Description

Delete Event rules.

State ACTIVE (SUPPORTED)

VersionNot Before
1.320270131

Parameters

NameTypeDescriptionExample
ids
required
arrayList of Event rule IDs66d77b4e32d04558b2382b1d14765d86

13.3 - 1.2

scp-cli servicewatch eventrule delete-bulk
--ids <value>

Description

Delete Event rules.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220261130

Parameters

NameTypeDescriptionExample
ids
required
arrayList of Event rule IDs66d77b4e32d04558b2382b1d14765d86

13.4 - 1.1

scp-cli servicewatch eventrule delete-bulk
--ids <value>

Description

Delete Event rules.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260831

Parameters

NameTypeDescriptionExample
ids
required
arrayList of Event rule IDs66d77b4e32d04558b2382b1d14765d86

13.5 - 1.0

scp-cli servicewatch eventrule delete-bulk
--ids <value>

Description

Delete Event rules.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260630

Parameters

NameTypeDescriptionExample
ids
required
arrayList of Event rule IDs66d77b4e32d04558b2382b1d14765d86

14 - DeleteLogGroups

14.1 - 1.4

scp-cli servicewatch loggroup delete-bulk
--ids <value>

Description

Delete Log groups.

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
ids
required
arrayList of Log group IDs602b39cb1d6b4b7fb0f18de43a4c689c

14.2 - 1.3

scp-cli servicewatch loggroup delete-bulk
--ids <value>

Description

Delete Log groups.

State ACTIVE (SUPPORTED)

VersionNot Before
1.320270131

Parameters

NameTypeDescriptionExample
ids
required
arrayList of Log group IDs602b39cb1d6b4b7fb0f18de43a4c689c

14.3 - 1.2

scp-cli servicewatch loggroup delete-bulk
--ids <value>

Description

Delete Log groups.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220261130

Parameters

NameTypeDescriptionExample
ids
required
arrayList of Log group IDs602b39cb1d6b4b7fb0f18de43a4c689c

14.4 - 1.1

scp-cli servicewatch loggroup delete-bulk
--ids <value>

Description

Delete Log groups.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260831

Parameters

NameTypeDescriptionExample
ids
required
arrayList of Log group IDs602b39cb1d6b4b7fb0f18de43a4c689c

14.5 - 1.0

scp-cli servicewatch loggroup delete-bulk
--ids <value>

Description

Delete Log groups.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260630

Parameters

NameTypeDescriptionExample
ids
required
arrayList of Log group IDs602b39cb1d6b4b7fb0f18de43a4c689c

15 - DeleteLogStreams

15.1 - 1.4

scp-cli servicewatch logstream delete-bulk
--log_group_id <value>
--ids <value>

Description

Delete Log group log streams.

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
log_group_id
required
stringLog group IDbce52822147744b4afe0187164caa2e8
ids
required
arrayList of Log stream IDsb0fc99a46a2c44b8b22739b130853dd8

15.2 - 1.3

scp-cli servicewatch logstream delete-bulk
--log_group_id <value>
--ids <value>

Description

Delete Log group log streams.

State ACTIVE (SUPPORTED)

VersionNot Before
1.320270131

Parameters

NameTypeDescriptionExample
log_group_id
required
stringLog group IDbce52822147744b4afe0187164caa2e8
ids
required
arrayList of Log stream IDsb0fc99a46a2c44b8b22739b130853dd8

15.3 - 1.2

scp-cli servicewatch logstream delete-bulk
--log_group_id <value>
--ids <value>

Description

Delete Log group log streams.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220261130

Parameters

NameTypeDescriptionExample
log_group_id
required
stringLog group IDbce52822147744b4afe0187164caa2e8
ids
required
arrayList of Log stream IDsb0fc99a46a2c44b8b22739b130853dd8

15.4 - 1.1

scp-cli servicewatch logstream delete-bulk
--log_group_id <value>
--ids <value>

Description

Delete Log group log streams.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260831

Parameters

NameTypeDescriptionExample
log_group_id
required
stringLog group IDbce52822147744b4afe0187164caa2e8
ids
required
arrayList of Log stream IDsb0fc99a46a2c44b8b22739b130853dd8

15.5 - 1.0

scp-cli servicewatch logstream delete-bulk
--log_group_id <value>
--ids <value>

Description

Delete Log group log streams.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260630

Parameters

NameTypeDescriptionExample
log_group_id
required
stringLog group IDbce52822147744b4afe0187164caa2e8
ids
required
arrayList of Log stream IDsb0fc99a46a2c44b8b22739b130853dd8

16 - DownloadMetricDataImage

16.1 - 1.4

scp-cli 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)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
statistic_type
required
stringMetric Statistics TypeAVG
start
required
integerMetric Start Time - Unix Timestamp1640995200
period
required
integerStatistic Period300
metrics
required
array```’{“color”: “#0000ff”, “dimensions”: [{“key”: “VolumeID”, “value”: “45fbde15-cdd2-4891-be31-4a9de75fccda”}], “display_name”: “Virtual Server
end
required
integerMetric End Time - Unix Timestamp1640995440
height
optional
integerChart Image Height(pixels)400
timezone
optional
stringTimezoneUTC
title
optional
stringChart TitleVirtual Server Metric Chart
width
optional
integerChart Image Width(pixels)600

Responses

NameDescriptionExample

16.2 - 1.3

scp-cli 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)

VersionNot Before
1.320270131

Parameters

NameTypeDescriptionExample
statistic_type
required
stringMetric Statistics TypeAVG
start
required
integerMetric Start Time - Unix Timestamp1640995200
period
required
integerStatistic Period300
metrics
required
array```’{“color”: “#0000ff”, “dimensions”: [{“key”: “VolumeID”, “value”: “45fbde15-cdd2-4891-be31-4a9de75fccda”}], “display_name”: “Virtual Server
end
required
integerMetric End Time - Unix Timestamp1640995440
height
optional
integerChart Image Height(pixels)400
timezone
optional
stringTimezoneUTC
title
optional
stringChart TitleVirtual Server Metric Chart
width
optional
integerChart Image Width(pixels)600

Responses

NameDescriptionExample

16.3 - 1.2

scp-cli 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)

VersionNot Before
1.220261130

Parameters

NameTypeDescriptionExample
statistic_type
required
stringMetric Statistics TypeAVG
start
required
integerMetric Start Time - Unix Timestamp1640995200
period
required
integerStatistic Period300
metrics
required
array```’{“color”: “#0000ff”, “dimensions”: [{“key”: “VolumeID”, “value”: “45fbde15-cdd2-4891-be31-4a9de75fccda”}], “display_name”: “Virtual Server
end
required
integerMetric End Time - Unix Timestamp1640995440
height
optional
integerChart Image Height(pixels)400
timezone
optional
stringTimezoneUTC
title
optional
stringChart TitleVirtual Server Metric Chart
width
optional
integerChart Image Width(pixels)600

Responses

NameDescriptionExample

16.4 - 1.1

scp-cli 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 (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260831

Parameters

NameTypeDescriptionExample
statistic_type
required
stringMetric Statistics TypeAVG
start
required
integerMetric Start Time - Unix Timestamp1640995200
period
required
integerStatistic Period300
metrics
required
array```’{“color”: “#0000ff”, “dimensions”: [{“key”: “VolumeID”, “value”: “45fbde15-cdd2-4891-be31-4a9de75fccda”}], “display_name”: “Virtual Server
end
required
integerMetric End Time - Unix Timestamp1640995440
height
optional
integerChart Image Height(pixels)400
timezone
optional
stringTimezoneUTC
title
optional
stringChart TitleVirtual Server Metric Chart
width
optional
integerChart Image Width(pixels)600

Responses

NameDescriptionExample

16.5 - 1.0

scp-cli 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 (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260630

Parameters

NameTypeDescriptionExample
statistic_type
required
stringMetric Statistics TypeAVG
start
required
integerMetric Start Time - Unix Timestamp1640995200
period
required
integerStatistic Period300
metrics
required
array```’{“color”: “#0000ff”, “dimensions”: [{“key”: “VolumeID”, “value”: “45fbde15-cdd2-4891-be31-4a9de75fccda”}], “display_name”: “Virtual Server
end
required
integerMetric End Time - Unix Timestamp1640995440
height
optional
integerChart Image Height(pixels)400
timezone
optional
stringTimezoneUTC
title
optional
stringChart TitleVirtual Server Metric Chart
width
optional
integerChart Image Width(pixels)600

Responses

NameDescriptionExample

17 - GetListOfAlertNotifications

17.1 - 1.4

scp-cli servicewatch alert-notification list
--id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--user_name <value>]

Description

Get list of Alert notifications

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
id
required
stringAlert ID3234bd0f12fa4d0b97ab9feff6c09b8e
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
user_name
optional
stringUser name홍길동

Responses

NameDescriptionExample
id
activated_yn
alert_id
created_at
created_by
last_login_at
modified_at
modified_by
user_created_at
user_id
user_name

18 - GetListOfAlerts

18.1 - 1.4

scp-cli servicewatch alert list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--activated_yn <value>]
[--states <value>]
[--levels <value>]
[--from_last_policy_updated_at <value>]
[--to_last_policy_updated_at <value>]
[--namespace_ids <value>]
[--namespace_names <value>]
[--type <value>]

Description

Get list of Alerts

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringAlert NameAlert Test
activated_yn
optional
****Whether the Alert is activated or notY
states
optional
stringAlert State - NORMAL, ALERT, INSUFFICIENT_DATANORMAL,ALERT
levels
optional
stringAlert Level - HIGH, MIDDLE, LOWHIGH,MIDDLE
from_last_policy_updated_at
optional
stringAlert Start Last Policy Updated Date Time2026-04-01T00:00:00+09:00
to_last_policy_updated_at
optional
stringAlert End Last Policy Updated Date Time2026-04-30T23:59:59+09:00
namespace_ids
optional
stringComma-separated namespace IDs1d9d05af5c624f2cb80a45f2c911e2f4,6b6c3239f0504e30b067fe9498be1681
namespace_names
optional
stringComma-separated namespace namesVirtual Server,Internet Gateway
type
optional
stringAlert TypeMETRIC_ALERT

Responses

NameDescriptionExample
idAlert ID3234bd0f12fa4d0b97ab9feff6c09b8e
activated_ynWhether the Alert is activated or notY
evaluation_time_windowEvaluation Time Window (period * evaluation_count)900
last_policy_updated_atLast Alert Policy Updated Date Time2026-06-24T10:14:52.700924
levelAlert Level - HIGH, MIDDLE, LOWHIGH
lower_boundLower bound for the Alert range operator80.0
metric_nameMetric NameCPU Usage
metric_unitMetric 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, NONEBYTE
nameAlert NameAlert Test
namespace_nameNamespace NameVirtual Server
operatorOperator - EQ, NOT_EQ, GT, GTE, LT, LTE, RANGERANGE
stateAlert State - NORMAL, ALERT, INSUFFICIENT_DATANORMAL
statisticStatistic - SUM, AVG, MAX, MINAVG
thresholdThreshold for the Alert Condition (except fro RANGE operator)80.0
typeAlert TypeMETRIC_ALERT
upper_boundUpper bound for the Alert range operator90.0

19 - GetListOfNamespacesByAlerts

19.1 - 1.4

scp-cli servicewatch alert-namespace list

Description

Get list of Namespaces by alerts

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Responses

NameDescriptionExample
idNamespace ID1d9d05af5c624f2cb80a45f2c911e2f4
created_atCreated date time
created_byCreator IDf4b8a4c4017f4f8d8399f0c02582ae47
descriptionDescription of Namespace이것은 Virtual Server에 대한 설명입니다.
modified_atModified date time
modified_byModifier IDf4b8a4c4017f4f8d8399f0c02582ae47
nameNamespace NameVirtual Server
region_idRegion Namekr-west1
service_idService ID

20 - ListDashboards

20.1 - 1.4

scp-cli servicewatch dashboard list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--name_like <value>]
[--favorite_enabled <value>]
[--type <value>]
[--service_code <value>]
[--namespace_code <value>]

Description

Get list of dashboards

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortname:asc or modified_at:desc
name
optional
stringDashboard's nameMyProd
name_like
optional
stringWildcard Search for Dashboard NamesMyProd
favorite_enabled
optional
booleanWhether it is a favorite dashboardTrue
type
optional
stringDashboard typeCustom
service_code
optional
stringAssociated service codevirtualserver
namespace_code
optional
stringAssociated namespace codevirtualserver

Responses

NameDescriptionExample
idDashboard’s unique IDb48e730a70e74f6aa3d2555000b5c22b
created_atCreated date time
favorite_enabledWhether it is a favorite dashboardTrue
modified_atModified date time
nameDashboard’s nameProduction-Web-Servers
namespace_codeAssociated namespace codevirtualserver
service_codeAssociated service codevirtualserver
typeDashboard typeCustom

20.2 - 1.3

scp-cli servicewatch dashboard list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--name_like <value>]
[--favorite_enabled <value>]
[--type <value>]
[--service_code <value>]

Description

Get list of dashboards

State ACTIVE (SUPPORTED)

VersionNot Before
1.320270131

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortname:asc or modified_at:desc
name
optional
stringDashboard's nameMyProd
name_like
optional
stringWildcard Search for Dashboard NamesMyProd
favorite_enabled
optional
booleanWhether it is a favorite dashboardTrue
type
optional
stringDashboard typeCustom
service_code
optional
stringAssociated service codevirtualserver

Responses

NameDescriptionExample
idDashboard’s unique IDb48e730a70e74f6aa3d2555000b5c22b
created_atCreated date time
favorite_enabledWhether it is a favorite dashboardTrue
modified_atModified date time
nameDashboard’s nameProduction-Web-Servers
namespace_codeAssociated namespace codevirtualserver
service_codeAssociated service codevirtualserver
typeDashboard typeCustom

20.3 - 1.2

scp-cli servicewatch dashboard list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--name_like <value>]
[--favorite_enabled <value>]
[--type <value>]
[--service_code <value>]

Description

Get list of dashboards

State ACTIVE (SUPPORTED)

VersionNot Before
1.220261130

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortname:asc or modified_at:desc
name
optional
stringDashboard's nameMyProd
name_like
optional
stringWildcard Search for Dashboard NamesMyProd
favorite_enabled
optional
booleanWhether it is a favorite dashboardTrue
type
optional
stringDashboard typeCustom
service_code
optional
stringAssociated service codevirtualserver

Responses

NameDescriptionExample
idDashboard’s unique IDb48e730a70e74f6aa3d2555000b5c22b
created_atCreated date time
favorite_enabledWhether it is a favorite dashboardTrue
modified_atModified date time
nameDashboard’s nameProduction-Web-Servers
namespace_codeAssociated namespace codevirtualserver
service_codeAssociated service codevirtualserver
typeDashboard typeCustom

20.4 - 1.1

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

Description

Get list of dashboards

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260831

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortname:asc or modified_at:desc
name
optional
stringDashboard's nameMyProd
name_like
optional
stringWildcard Search for Dashboard NamesMyProd
favorite_enabled
optional
booleanWhether it is a favorite dashboardTrue

Responses

NameDescriptionExample
idDashboard’s unique IDb48e730a70e74f6aa3d2555000b5c22b
created_atCreated date time
favorite_enabledWhether it is a favorite dashboardTrue
modified_atModified date time
nameDashboard’s nameProduction-Web-Servers
namespace_codeAssociated namespace codevirtualserver
service_codeAssociated service codevirtualserver
typeDashboard typeCustom

20.5 - 1.0

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

Description

Get list of dashboards

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260630

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortname:asc or modified_at:desc
name
optional
stringDashboard's nameMyProd
name_like
optional
stringWildcard Search for Dashboard NamesMyProd
favorite_enabled
optional
booleanWhether it is a favorite dashboardTrue

Responses

NameDescriptionExample
idDashboard’s unique IDb48e730a70e74f6aa3d2555000b5c22b
created_atCreated date time
favorite_enabledWhether it is a favorite dashboardTrue
modified_atModified date time
nameDashboard’s nameProduction-Web-Servers
namespace_codeAssociated namespace codevirtualserver
service_codeAssociated service codevirtualserver
typeDashboard typeCustom

21 - ListLogGroups

21.1 - 1.4

scp-cli servicewatch loggroup list
[--size <value>]
[--page <value>]
[--sort <value>]
[--ids <value>]
[--name <value>]
[--retention_periods <value>]

Description

Get list of Log groups.

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
ids
optional
arrayList of Log group IDs6
name
optional
stringLog group nametestlg01
retention_periods
optional
arrayList of Log group retention periods-

Responses

NameDescriptionExample
idLog group IDbce52822147744b4afe0187164caa2e8
account_idAccount ID1bcf39b344ac41cbaf0466ff0d2bebad
created_atCreated date time
created_byCreator IDf4b8a4c4017f4f8d8399f0c02582ae47
modified_atModified date time
modified_byModifier IDf4b8a4c4017f4f8d8399f0c02582ae47
nameLog group nametestlg01
retention_periodLog group retention period365
retention_period_nameLog group retention period name1 year
statusLog group statusACTIVE

21.2 - 1.3

scp-cli servicewatch loggroup list
[--size <value>]
[--page <value>]
[--sort <value>]
[--ids <value>]
[--name <value>]
[--retention_periods <value>]

Description

Get list of Log groups.

State ACTIVE (SUPPORTED)

VersionNot Before
1.320270131

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
ids
optional
arrayList of Log group IDs6
name
optional
stringLog group nametestlg01
retention_periods
optional
arrayList of Log group retention periods-

Responses

NameDescriptionExample
idLog group IDbce52822147744b4afe0187164caa2e8
account_idAccount ID1bcf39b344ac41cbaf0466ff0d2bebad
created_atCreated date time
created_byCreator IDf4b8a4c4017f4f8d8399f0c02582ae47
modified_atModified date time
modified_byModifier IDf4b8a4c4017f4f8d8399f0c02582ae47
nameLog group nametestlg01
retention_periodLog group retention period365
retention_period_nameLog group retention period name1 year
statusLog group statusACTIVE

21.3 - 1.2

scp-cli servicewatch loggroup list
[--size <value>]
[--page <value>]
[--sort <value>]
[--ids <value>]
[--name <value>]
[--retention_periods <value>]

Description

Get list of Log groups.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220261130

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
ids
optional
arrayList of Log group IDs6
name
optional
stringLog group nametestlg01
retention_periods
optional
arrayList of Log group retention periods-

Responses

NameDescriptionExample
idLog group IDbce52822147744b4afe0187164caa2e8
account_idAccount ID1bcf39b344ac41cbaf0466ff0d2bebad
created_atCreated date time
created_byCreator IDf4b8a4c4017f4f8d8399f0c02582ae47
modified_atModified date time
modified_byModifier IDf4b8a4c4017f4f8d8399f0c02582ae47
nameLog group nametestlg01
retention_periodLog group retention period365
retention_period_nameLog group retention period name1 year
statusLog group statusACTIVE

21.4 - 1.1

scp-cli servicewatch loggroup list
[--size <value>]
[--page <value>]
[--sort <value>]
[--ids <value>]
[--name <value>]
[--retention_periods <value>]

Description

Get list of Log groups.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260831

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
ids
optional
arrayList of Log group IDs6
name
optional
stringLog group nametestlg01
retention_periods
optional
arrayList of Log group retention periods-

Responses

NameDescriptionExample
idLog group IDbce52822147744b4afe0187164caa2e8
account_idAccount ID1bcf39b344ac41cbaf0466ff0d2bebad
created_atCreated date time
created_byCreator IDf4b8a4c4017f4f8d8399f0c02582ae47
modified_atModified date time
modified_byModifier IDf4b8a4c4017f4f8d8399f0c02582ae47
nameLog group nametestlg01
retention_periodLog group retention period365
retention_period_nameLog group retention period name1 year
statusLog group statusACTIVE

21.5 - 1.0

scp-cli servicewatch loggroup list
[--size <value>]
[--page <value>]
[--sort <value>]
[--ids <value>]
[--name <value>]
[--retention_periods <value>]

Description

Get list of Log groups.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260630

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
ids
optional
arrayList of Log group IDs6
name
optional
stringLog group nametestlg01
retention_periods
optional
arrayList of Log group retention periods-

Responses

NameDescriptionExample
idLog group IDbce52822147744b4afe0187164caa2e8
account_idAccount ID1bcf39b344ac41cbaf0466ff0d2bebad
created_atCreated date time
created_byCreator IDf4b8a4c4017f4f8d8399f0c02582ae47
modified_atModified date time
modified_byModifier IDf4b8a4c4017f4f8d8399f0c02582ae47
nameLog group nametestlg01
retention_periodLog group retention period365
retention_period_nameLog group retention period name1 year
statusLog group statusACTIVE

22 - ListMetricData

22.1 - 1.4

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

Description

Get metric data list

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
statistic_type
required
stringMetric Statistics TypeAVG
start
required
integerMetric Start Time - Unix Timestamp1640995200
period
required
integerStatistic Period300
metrics
required
array```’{“dimensions”: [{“key”: “VolumeID”, “value”: “45fbde15-cdd2-4891-be31-4a9de75fccda”}], “display_name”: “Virtual Server
end
required
integerMetric End Time - Unix Timestamp1640995440

Responses

NameDescriptionExample
display_nameMetric Display NameVirtual Server
status
valuesList of Metric Series Values[[1640995200, “45.5”]]

22.2 - 1.3

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

Description

Get metric data list

State ACTIVE (SUPPORTED)

VersionNot Before
1.320270131

Parameters

NameTypeDescriptionExample
statistic_type
required
stringMetric Statistics TypeAVG
start
required
integerMetric Start Time - Unix Timestamp1640995200
period
required
integerStatistic Period300
metrics
required
array```’{“dimensions”: [{“key”: “VolumeID”, “value”: “45fbde15-cdd2-4891-be31-4a9de75fccda”}], “display_name”: “Virtual Server
end
required
integerMetric End Time - Unix Timestamp1640995440

Responses

NameDescriptionExample
display_nameMetric Display NameVirtual Server
status
valuesList of Metric Series Values[[1640995200, “45.5”]]

22.3 - 1.2

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

Description

Get metric data list

State ACTIVE (SUPPORTED)

VersionNot Before
1.220261130

Parameters

NameTypeDescriptionExample
statistic_type
required
stringMetric Statistics TypeAVG
start
required
integerMetric Start Time - Unix Timestamp1640995200
period
required
integerStatistic Period300
metrics
required
array```’{“dimensions”: [{“key”: “VolumeID”, “value”: “45fbde15-cdd2-4891-be31-4a9de75fccda”}], “display_name”: “Virtual Server
end
required
integerMetric End Time - Unix Timestamp1640995440

Responses

NameDescriptionExample
display_nameMetric Display NameVirtual Server
status
valuesList of Metric Series Values[[1640995200, “45.5”]]

22.4 - 1.1

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

Description

Get metric data list

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260831

Parameters

NameTypeDescriptionExample
statistic_type
required
stringMetric Statistics TypeAVG
start
required
integerMetric Start Time - Unix Timestamp1640995200
period
required
integerStatistic Period300
metrics
required
array```’{“dimensions”: [{“key”: “VolumeID”, “value”: “45fbde15-cdd2-4891-be31-4a9de75fccda”}], “display_name”: “Virtual Server
end
required
integerMetric End Time - Unix Timestamp1640995440

Responses

NameDescriptionExample
display_nameMetric Display NameVirtual Server
status
valuesList of Metric Series Values[[1640995200, “45.5”]]

22.5 - 1.0

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

Description

Get metric data list

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260630

Parameters

NameTypeDescriptionExample
statistic_type
required
stringMetric Statistics TypeAVG
start
required
integerMetric Start Time - Unix Timestamp1640995200
period
required
integerStatistic Period300
metrics
required
array```’{“dimensions”: [{“key”: “VolumeID”, “value”: “45fbde15-cdd2-4891-be31-4a9de75fccda”}], “display_name”: “Virtual Server
end
required
integerMetric End Time - Unix Timestamp1640995440

Responses

NameDescriptionExample
display_nameMetric Display NameVirtual Server
status
valuesList of Metric Series Values[[1640995200, “45.5”]]

23 - ListMetricInfos

23.1 - 1.4

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

Description

Get metric list

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
metric_name
optional
stringMetric NameCPU Usage
namespaces
optional
arrayList of Namespace'{"dimensions": "[[\"resource_id\"]]", "name": "Virtual Server"}'
resource_id
optional
stringResource ID10bf5d24-0f20-4066-bb0b-de2b1d6ff502
resource_name
optional
stringResource NameVirtualServer01
tags
optional
arrayList of Tags'{"key": "key01", "value": "value01"}'

Responses

NameDescriptionExample
countCount1
namespaces[]

23.2 - 1.3

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

Description

Get metric list

State ACTIVE (SUPPORTED)

VersionNot Before
1.320270131

Parameters

NameTypeDescriptionExample
metric_name
optional
stringMetric NameCPU Usage
namespaces
optional
arrayList of Namespace'{"dimensions": "[[\"resource_id\"]]", "name": "Virtual Server"}'
resource_id
optional
stringResource ID10bf5d24-0f20-4066-bb0b-de2b1d6ff502
resource_name
optional
stringResource NameVirtualServer01
tags
optional
arrayList of Tags'{"key": "key01", "value": "value01"}'

Responses

NameDescriptionExample
countCount1
namespaces[]

23.3 - 1.2

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

Description

Get metric list

State ACTIVE (SUPPORTED)

VersionNot Before
1.220261130

Parameters

NameTypeDescriptionExample
metric_name
optional
stringMetric NameCPU Usage
namespaces
optional
arrayList of Namespace'{"dimensions": "[[\"resource_id\"]]", "name": "Virtual Server"}'
resource_id
optional
stringResource ID10bf5d24-0f20-4066-bb0b-de2b1d6ff502
resource_name
optional
stringResource NameVirtualServer01
tags
optional
arrayList of Tags'{"key": "key01", "value": "value01"}'

Responses

NameDescriptionExample
countCount1
namespaces[]

23.4 - 1.1

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

Description

Get metric list

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260831

Parameters

NameTypeDescriptionExample
metric_name
optional
stringMetric NameCPU Usage
namespaces
optional
arrayList of Namespace'{"dimensions": "[[\"resource_id\"]]", "name": "Virtual Server"}'
resource_id
optional
stringResource ID10bf5d24-0f20-4066-bb0b-de2b1d6ff502
resource_name
optional
stringResource NameVirtualServer01
tags
optional
arrayList of Tags'{"key": "key01", "value": "value01"}'

Responses

NameDescriptionExample
countCount1
namespaces[]

23.5 - 1.0

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

Description

Get metric list

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260630

Parameters

NameTypeDescriptionExample
metric_name
optional
stringMetric NameCPU Usage
namespaces
optional
arrayList of Namespace'{"dimensions": "[\"resource_id\"]", "name": "Virtual Server"}'
resource_id
optional
stringResource ID10bf5d24-0f20-4066-bb0b-de2b1d6ff502
resource_name
optional
stringResource NameVirtualServer01
tags
optional
arrayList of Tags'{"key": "key01", "value": "value01"}'

Responses

NameDescriptionExample
countCount1
namespaces[]

24 - SetAlert

24.1 - 1.4

scp-cli servicewatch alert set
--id <value>
--value <value>
--key <value>
--statistic <value>
--period <value>
--operator <value>
--namespace_id <value>
--metric_id <value>
--level <value>
[--dimensions <value>]
[--evaluation_count <value>]
[--individual_items <value>]
[--lower_bound <value>]
[--missing_data_option <value>]
[--threshold <value>]
[--upper_bound <value>]
[--violation_count <value>]

Description

Set the Alert

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
id
required
stringAlert ID3234bd0f12fa4d0b97ab9feff6c09b8e
value
required
stringDimension Value10bf5d24-0f20-4066-bb0b-de2b1d6ff502
key
required
stringDimension Keyresource_id
statistic
required
stringStatistic - SUM, AVG, MAX, MINAVG
period
required
integerPeriod (seconds)300
operator
required
stringOperator - EQ, NOT_EQ, GT, GTE, LT, LTE, RANGERANGE
namespace_id
required
stringNamespace ID1d9d05af5c624f2cb80a45f2c911e2f4
metric_id
required
stringMetric IDf13aab3b88c341b2bc73f8925a0e8cc5
level
required
stringAlert Level - HIGH, MIDDLE, LOWHIGH
dimensions
optional
arrayList of Dimensions'{"key": "resource_id", "value": "10bf5d24-0f20-4066-bb0b-de2b1d6ff502"}'
evaluation_count
optional
integerEvaluation Count for the Alert Condition3
individual_items
optional
arrayList of Individual Items'{"key": "VolumeID", "value": "45fbde15-cdd2-4891-be31-4a9de75fccda"}'
lower_bound
optional
numberLower bound for the Alert range operator80.0
missing_data_option
optional
****Missing Data Option - MISSING, BREACHING, NOT_BREACHING, IGNOREBREACHING
threshold
optional
numberThreshold for the Alert Condition (except fro RANGE operator)80.0
upper_bound
optional
numberUpper bound for the Alert range operator90.0
violation_count
optional
integerViolation Count for the Alert Condition2

Responses

NameDescriptionExample
keyDimension Keyresource_id
valueDimension Value10bf5d24-0f20-4066-bb0b-de2b1d6ff502

24.2 - 1.3

scp-cli servicewatch alert set
--id <value>
--value <value>
--key <value>
--statistic <value>
--period <value>
--operator <value>
--namespace_id <value>
--metric_id <value>
--level <value>
[--dimensions <value>]
[--evaluation_count <value>]
[--individual_items <value>]
[--lower_bound <value>]
[--missing_data_option <value>]
[--threshold <value>]
[--upper_bound <value>]
[--violation_count <value>]

Description

Set the Alert

State ACTIVE (SUPPORTED)

VersionNot Before
1.320270131

Parameters

NameTypeDescriptionExample
id
required
stringAlert ID3234bd0f12fa4d0b97ab9feff6c09b8e
value
required
stringDimension Value10bf5d24-0f20-4066-bb0b-de2b1d6ff502
key
required
stringDimension Keyresource_id
statistic
required
stringStatistic - SUM, AVG, MAX, MINAVG
period
required
integerPeriod (seconds)300
operator
required
stringOperator - EQ, NOT_EQ, GT, GTE, LT, LTE, RANGERANGE
namespace_id
required
stringNamespace ID1d9d05af5c624f2cb80a45f2c911e2f4
metric_id
required
stringMetric IDf13aab3b88c341b2bc73f8925a0e8cc5
level
required
stringAlert Level - HIGH, MIDDLE, LOWHIGH
dimensions
optional
arrayList of Dimensions'{"key": "resource_id", "value": "10bf5d24-0f20-4066-bb0b-de2b1d6ff502"}'
evaluation_count
optional
integerEvaluation Count for the Alert Condition3
individual_items
optional
arrayList of Individual Items'{"key": "VolumeID", "value": "45fbde15-cdd2-4891-be31-4a9de75fccda"}'
lower_bound
optional
numberLower bound for the Alert range operator80.0
missing_data_option
optional
****Missing Data Option - MISSING, BREACHING, NOT_BREACHING, IGNOREBREACHING
threshold
optional
numberThreshold for the Alert Condition (except fro RANGE operator)80.0
upper_bound
optional
numberUpper bound for the Alert range operator90.0
violation_count
optional
integerViolation Count for the Alert Condition2

Responses

NameDescriptionExample
keyDimension Keyresource_id
valueDimension Value10bf5d24-0f20-4066-bb0b-de2b1d6ff502

24.3 - 1.2

scp-cli servicewatch alert set
--id <value>
--value <value>
--key <value>
--statistic <value>
--period <value>
--operator <value>
--namespace_id <value>
--metric_id <value>
--level <value>
[--dimensions <value>]
[--evaluation_count <value>]
[--individual_items <value>]
[--lower_bound <value>]
[--missing_data_option <value>]
[--threshold <value>]
[--upper_bound <value>]
[--violation_count <value>]

Description

Set the Alert

State ACTIVE (SUPPORTED)

VersionNot Before
1.220261130

Parameters

NameTypeDescriptionExample
id
required
stringAlert ID3234bd0f12fa4d0b97ab9feff6c09b8e
value
required
stringDimension Value10bf5d24-0f20-4066-bb0b-de2b1d6ff502
key
required
stringDimension Keyresource_id
statistic
required
stringStatistic - SUM, AVG, MAX, MINAVG
period
required
integerPeriod (seconds)300
operator
required
stringOperator - EQ, NOT_EQ, GT, GTE, LT, LTE, RANGERANGE
namespace_id
required
stringNamespace ID1d9d05af5c624f2cb80a45f2c911e2f4
metric_id
required
stringMetric IDf13aab3b88c341b2bc73f8925a0e8cc5
level
required
stringAlert Level - HIGH, MIDDLE, LOWHIGH
dimensions
optional
arrayList of Dimensions'{"key": "resource_id", "value": "10bf5d24-0f20-4066-bb0b-de2b1d6ff502"}'
evaluation_count
optional
integerEvaluation Count for the Alert Condition3
individual_items
optional
arrayList of Individual Items'{"key": "VolumeID", "value": "45fbde15-cdd2-4891-be31-4a9de75fccda"}'
lower_bound
optional
numberLower bound for the Alert range operator80.0
missing_data_option
optional
****Missing Data Option - MISSING, BREACHING, NOT_BREACHING, IGNOREBREACHING
threshold
optional
numberThreshold for the Alert Condition (except fro RANGE operator)80.0
upper_bound
optional
numberUpper bound for the Alert range operator90.0
violation_count
optional
integerViolation Count for the Alert Condition2

Responses

NameDescriptionExample
keyDimension Keyresource_id
valueDimension Value10bf5d24-0f20-4066-bb0b-de2b1d6ff502

25 - SetAlertActivated

25.1 - 1.4

scp-cli servicewatch alert-activated set
--id <value>
--activated_yn <value>

Description

Set the Alert Activated

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
id
required
stringAlert ID3234bd0f12fa4d0b97ab9feff6c09b8e
activated_yn
required
stringWhether the Alert is activated or notY

Responses

NameDescriptionExample
idAlert ID3234bd0f12fa4d0b97ab9feff6c09b8e
activated_ynWhether the Alert is activated or notY
modified_atModified date time2026-06-24T10:14:52.734074

25.2 - 1.3

scp-cli servicewatch alert-activated set
--id <value>
--activated_yn <value>

Description

Set the Alert Activated

State ACTIVE (SUPPORTED)

VersionNot Before
1.320270131

Parameters

NameTypeDescriptionExample
id
required
stringAlert ID3234bd0f12fa4d0b97ab9feff6c09b8e
activated_yn
required
stringWhether the Alert is activated or notY

Responses

NameDescriptionExample
idAlert ID3234bd0f12fa4d0b97ab9feff6c09b8e
activated_ynWhether the Alert is activated or notY
modified_atModified date time2026-06-24T10:14:52.734074

25.3 - 1.2

scp-cli servicewatch alert-activated set
--id <value>
--activated_yn <value>

Description

Set the Alert Activated

State ACTIVE (SUPPORTED)

VersionNot Before
1.220261130

Parameters

NameTypeDescriptionExample
id
required
stringAlert ID3234bd0f12fa4d0b97ab9feff6c09b8e
activated_yn
required
stringWhether the Alert is activated or notY

Responses

NameDescriptionExample
idAlert ID3234bd0f12fa4d0b97ab9feff6c09b8e
activated_ynWhether the Alert is activated or notY
modified_atModified date time2026-06-24T10:14:52.734074

26 - SetAlertDescription

26.1 - 1.4

scp-cli servicewatch alert-description set
--id <value>
[--description <value>]

Description

Set the Alert Description

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
id
required
stringAlert ID3234bd0f12fa4d0b97ab9feff6c09b8e
description
optional
stringAlert DescriptionDescription for Alert Test

Responses

NameDescriptionExample
idAlert ID3234bd0f12fa4d0b97ab9feff6c09b8e
descriptionAlert DescriptionDescription for Alert Test
modified_atModified date time2026-06-24T10:14:52.733269

26.2 - 1.3

scp-cli servicewatch alert-description set
--id <value>
[--description <value>]

Description

Set the Alert Description

State ACTIVE (SUPPORTED)

VersionNot Before
1.320270131

Parameters

NameTypeDescriptionExample
id
required
stringAlert ID3234bd0f12fa4d0b97ab9feff6c09b8e
description
optional
stringAlert DescriptionDescription for Alert Test

Responses

NameDescriptionExample
idAlert ID3234bd0f12fa4d0b97ab9feff6c09b8e
descriptionAlert DescriptionDescription for Alert Test
modified_atModified date time2026-06-24T10:14:52.733269

26.3 - 1.2

scp-cli servicewatch alert-description set
--id <value>
[--description <value>]

Description

Set the Alert Description

State ACTIVE (SUPPORTED)

VersionNot Before
1.220261130

Parameters

NameTypeDescriptionExample
id
required
stringAlert ID3234bd0f12fa4d0b97ab9feff6c09b8e
description
optional
stringAlert DescriptionDescription for Alert Test

Responses

NameDescriptionExample
idAlert ID3234bd0f12fa4d0b97ab9feff6c09b8e
descriptionAlert DescriptionDescription for Alert Test
modified_atModified date time2026-06-24T10:14:52.733269

27 - SetAlertNotifications

27.1 - 1.4

scp-cli servicewatch alert-set notifications
--id <value>
--user_ids <value>

Description

Set Alert notifications

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
id
required
stringAlert ID3234bd0f12fa4d0b97ab9feff6c09b8e
user_ids
required
arrayList of User IDs1234da92-634a-4f8c-932e-9d650599ab1b

28 - SetDashboard

28.1 - 1.4

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

Description

Set dashboard

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
dashboard_id
required
stringDashboard's unique IDb48e730a70e74f6aa3d2555000b5c22b
name
optional
stringDashboard's nameRenamed-Dashboard
widgets
optional
arrayList of widgets included in the dashboard```’{“height”: 1, “order”: 1, “properties”: {“metrics”: [{“color”: “#ff7f0e”, “dimensions”: [{“key”: “resource_id”, “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

28.2 - 1.3

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

Description

Set dashboard

State ACTIVE (SUPPORTED)

VersionNot Before
1.320270131

Parameters

NameTypeDescriptionExample
dashboard_id
required
stringDashboard's unique IDb48e730a70e74f6aa3d2555000b5c22b
name
optional
stringDashboard's nameRenamed-Dashboard
widgets
optional
arrayList of widgets included in the dashboard```’{“height”: 1, “order”: 1, “properties”: {“metrics”: [{“color”: “#ff7f0e”, “dimensions”: [{“key”: “resource_id”, “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

28.3 - 1.2

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

Description

Set dashboard

State ACTIVE (SUPPORTED)

VersionNot Before
1.220261130

Parameters

NameTypeDescriptionExample
dashboard_id
required
stringDashboard's unique IDb48e730a70e74f6aa3d2555000b5c22b
name
optional
stringDashboard's nameRenamed-Dashboard
widgets
optional
arrayList of widgets included in the dashboard```’{“height”: 1, “order”: 1, “properties”: {“metrics”: [{“color”: “#ff7f0e”, “dimensions”: [{“key”: “resource_id”, “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

28.4 - 1.1

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

Description

Set dashboard

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260831

Parameters

NameTypeDescriptionExample
dashboard_id
required
stringDashboard's unique IDb48e730a70e74f6aa3d2555000b5c22b
name
optional
stringDashboard's nameRenamed-Dashboard
widgets
optional
arrayList of widgets included in the dashboard```’{“height”: 1, “order”: 1, “properties”: {“metrics”: [{“color”: “#ff7f0e”, “dimensions”: [{“key”: “resource_id”, “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

28.5 - 1.0

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

Description

Set dashboard

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260630

Parameters

NameTypeDescriptionExample
dashboard_id
required
stringDashboard's unique IDb48e730a70e74f6aa3d2555000b5c22b
name
optional
stringDashboard's nameRenamed-Dashboard
widgets
optional
arrayList of widgets included in the dashboard```’{“height”: 1, “order”: 1, “properties”: {“metrics”: [{“color”: “#ff7f0e”, “dimensions”: [{“key”: “resource_id”, “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

29 - SetEventRule

29.1 - 1.4

scp-cli servicewatch eventrule set
--event_rule_id <value>
--service_id <value>
[--active_yn <value>]
[--description <value>]
[--event_ids <value>]
[--none_attributes <value>]
[--recipient_ids <value>]
[--resource_type_id <value>]
[--srn_list <value>]

Description

Set the Event rule.

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
event_rule_id
required
stringEvent rule IDb73f95c698f540dab18860f72fafd03f
service_id
required
stringService ID2778de83d7e247609445bbd570a4eba9
active_yn
optional
****Whether the Event rule is activeY
description
optional
stringEvent rule descriptionEvent rule 1 description
event_ids
optional
arrayList of Event IDs014cb88ca2a9420e840d5c9ac16cac89
none_attributes
optional
arrayList of attributes to assign to Nonedescription
recipient_ids
optional
arrayNotification recipient IDs947c6a8559434505b28a5e21fff463d0
resource_type_id
optional
stringResource type ID596bf16709e84e27b7df397bf59b877c
srn_list
optional
arrayList of SDS cloud Resource Namessrn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::servicewatch:event-rule/a58c8645928043a6868277c7d7fef11a

Responses

NameDescriptionExample
event_ruleEvent rule

29.2 - 1.3

scp-cli servicewatch eventrule set
--event_rule_id <value>
--service_id <value>
[--active_yn <value>]
[--description <value>]
[--event_ids <value>]
[--none_attributes <value>]
[--recipient_ids <value>]
[--resource_type_id <value>]
[--srn_list <value>]

Description

Set the Event rule.

State ACTIVE (SUPPORTED)

VersionNot Before
1.320270131

Parameters

NameTypeDescriptionExample
event_rule_id
required
stringEvent rule IDb73f95c698f540dab18860f72fafd03f
service_id
required
stringService ID2778de83d7e247609445bbd570a4eba9
active_yn
optional
****Whether the Event rule is activeY
description
optional
stringEvent rule descriptionEvent rule 1 description
event_ids
optional
arrayList of Event IDs014cb88ca2a9420e840d5c9ac16cac89
none_attributes
optional
arrayList of attributes to assign to Nonedescription
recipient_ids
optional
arrayNotification recipient IDs947c6a8559434505b28a5e21fff463d0
resource_type_id
optional
stringResource type ID596bf16709e84e27b7df397bf59b877c
srn_list
optional
arrayList of SDS cloud Resource Namessrn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::servicewatch:event-rule/a58c8645928043a6868277c7d7fef11a

Responses

NameDescriptionExample
event_ruleEvent rule

29.3 - 1.2

scp-cli servicewatch eventrule set
--event_rule_id <value>
--service_id <value>
[--active_yn <value>]
[--description <value>]
[--event_ids <value>]
[--none_attributes <value>]
[--recipient_ids <value>]
[--resource_type_id <value>]
[--srn_list <value>]

Description

Set the Event rule.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220261130

Parameters

NameTypeDescriptionExample
event_rule_id
required
stringEvent rule IDb73f95c698f540dab18860f72fafd03f
service_id
required
stringService ID2778de83d7e247609445bbd570a4eba9
active_yn
optional
****Whether the Event rule is activeY
description
optional
stringEvent rule descriptionEvent rule 1 description
event_ids
optional
arrayList of Event IDs014cb88ca2a9420e840d5c9ac16cac89
none_attributes
optional
arrayList of attributes to assign to Nonedescription
recipient_ids
optional
arrayNotification recipient IDs947c6a8559434505b28a5e21fff463d0
resource_type_id
optional
stringResource type ID596bf16709e84e27b7df397bf59b877c
srn_list
optional
arrayList of SDS cloud Resource Namessrn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::servicewatch:event-rule/a58c8645928043a6868277c7d7fef11a

Responses

NameDescriptionExample
event_ruleEvent rule

29.4 - 1.1

scp-cli servicewatch eventrule set
--event_rule_id <value>
--service_id <value>
[--active_yn <value>]
[--description <value>]
[--event_ids <value>]
[--none_attributes <value>]
[--recipient_ids <value>]
[--resource_type_id <value>]
[--srn_list <value>]

Description

Set the Event rule.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260831

Parameters

NameTypeDescriptionExample
event_rule_id
required
stringEvent rule IDb73f95c698f540dab18860f72fafd03f
service_id
required
stringService ID2778de83d7e247609445bbd570a4eba9
active_yn
optional
****Whether the Event rule is activeY
description
optional
stringEvent rule descriptionEvent rule 1 description
event_ids
optional
arrayList of Event IDs014cb88ca2a9420e840d5c9ac16cac89
none_attributes
optional
arrayList of attributes to assign to Nonedescription
recipient_ids
optional
arrayNotification recipient IDs947c6a8559434505b28a5e21fff463d0
resource_type_id
optional
stringResource type ID596bf16709e84e27b7df397bf59b877c
srn_list
optional
arrayList of SDS cloud Resource Namessrn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::servicewatch:event-rule/a58c8645928043a6868277c7d7fef11a

Responses

NameDescriptionExample
event_ruleEvent rule

29.5 - 1.0

scp-cli servicewatch eventrule set
--event_rule_id <value>
--service_id <value>
[--active_yn <value>]
[--description <value>]
[--event_ids <value>]
[--none_attributes <value>]
[--recipient_ids <value>]
[--resource_type_id <value>]
[--srn_list <value>]

Description

Set the Event rule.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260630

Parameters

NameTypeDescriptionExample
event_rule_id
required
stringEvent rule IDb73f95c698f540dab18860f72fafd03f
service_id
required
stringService ID2778de83d7e247609445bbd570a4eba9
active_yn
optional
****Whether the Event rule is activeY
description
optional
stringEvent rule descriptionEvent rule 1 description
event_ids
optional
arrayList of Event IDs014cb88ca2a9420e840d5c9ac16cac89
none_attributes
optional
arrayList of attributes to assign to Nonedescription
recipient_ids
optional
arrayNotification recipient IDs947c6a8559434505b28a5e21fff463d0
resource_type_id
optional
stringResource type ID596bf16709e84e27b7df397bf59b877c
srn_list
optional
arrayList of SDS cloud Resource Namessrn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::servicewatch:event-rule/a58c8645928043a6868277c7d7fef11a

Responses

NameDescriptionExample
event_ruleEvent rule

30 - SetLogGroup

30.1 - 1.4

scp-cli servicewatch loggroup set
--log_group_id <value>
--retention_period <value>

Description

Set the Log group.

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
log_group_id
required
stringLog group IDbce52822147744b4afe0187164caa2e8
retention_period
required
integerLog group retention period365

Responses

NameDescriptionExample
log_groupLog group

30.2 - 1.3

scp-cli servicewatch loggroup set
--log_group_id <value>
--retention_period <value>

Description

Set the Log group.

State ACTIVE (SUPPORTED)

VersionNot Before
1.320270131

Parameters

NameTypeDescriptionExample
log_group_id
required
stringLog group IDbce52822147744b4afe0187164caa2e8
retention_period
required
integerLog group retention period365

Responses

NameDescriptionExample
log_groupLog group

30.3 - 1.2

scp-cli servicewatch loggroup set
--log_group_id <value>
--retention_period <value>

Description

Set the Log group.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220261130

Parameters

NameTypeDescriptionExample
log_group_id
required
stringLog group IDbce52822147744b4afe0187164caa2e8
retention_period
required
integerLog group retention period365

Responses

NameDescriptionExample
log_groupLog group

30.4 - 1.1

scp-cli servicewatch loggroup set
--log_group_id <value>
--retention_period <value>

Description

Set the Log group.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260831

Parameters

NameTypeDescriptionExample
log_group_id
required
stringLog group IDbce52822147744b4afe0187164caa2e8
retention_period
required
integerLog group retention period365

Responses

NameDescriptionExample
log_groupLog group

30.5 - 1.0

scp-cli servicewatch loggroup set
--log_group_id <value>
--retention_period <value>

Description

Set the Log group.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260630

Parameters

NameTypeDescriptionExample
log_group_id
required
stringLog group IDbce52822147744b4afe0187164caa2e8
retention_period
required
integerLog group retention period365

Responses

NameDescriptionExample
log_groupLog group

31 - ShowAgentDownloadLink

31.1 - 1.4

scp-cli servicewatch show agent download link

Description

Show link to agent download

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Responses

NameDescriptionExample
download_linkURL to download agenthttps://object-store.private.{region}.{environment}.samsungsdscloud.com/account:swt-agent/latest/ServiceWatch_Agent.zip

31.2 - 1.3

scp-cli servicewatch show agent download link

Description

Show link to agent download

State ACTIVE (SUPPORTED)

VersionNot Before
1.320270131

Responses

NameDescriptionExample
download_linkURL to download agenthttps://object-store.private.{region}.{environment}.samsungsdscloud.com/account:swt-agent/latest/ServiceWatch_Agent.zip

31.3 - 1.2

scp-cli servicewatch show agent download link

Description

Show link to agent download

State ACTIVE (SUPPORTED)

VersionNot Before
1.220261130

Responses

NameDescriptionExample
download_linkURL to download agenthttps://object-store.private.{region}.{environment}.samsungsdscloud.com/account:swt-agent/latest/ServiceWatch_Agent.zip

31.4 - 1.1

scp-cli servicewatch show agent download link

Description

Show link to agent download

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260831

Responses

NameDescriptionExample
download_linkURL to download agenthttps://object-store.private.{region}.{environment}.samsungsdscloud.com/account:swt-agent/latest/ServiceWatch_Agent.zip

32 - ShowAlert

32.1 - 1.4

scp-cli servicewatch alert show
--id <value>

Description

Show the Alert

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
id
required
stringAlert ID3234bd0f12fa4d0b97ab9feff6c09b8e

Responses

NameDescriptionExample
activated_ynWhether the Alert is activated or notY
created_atCreated date time
created_byCreator IDf4b8a4c4017f4f8d8399f0c02582ae47
descriptionAlert DescriptionDescription for Alert Test
dimensionDimension
dimensionsList of Dimensions[]
evaluation_countEvaluation Count for the Alert Condition3
evaluation_time_windowEvaluation Time Window (period * evaluation_count)900
individual_itemsList of Individual Items[]
last_policy_updated_atLast Alert Policy Updated Date Time
levelAlert Level - HIGH, MIDDLE, LOWHIGH
lower_boundLower bound for the Alert range operator80.0
metric_idMetric IDf13aab3b88c341b2bc73f8925a0e8cc5
metric_nameMetric NameCPU Usage
metric_unitMetric 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, NONEBYTE
missing_data_optionMissing Data Option - MISSING, BREACHING, NOT_BREACHING, IGNOREBREACHING
modified_atModified date time
modified_byModifier IDf4b8a4c4017f4f8d8399f0c02582ae47
nameAlert NameAlert Test
namespace_idNamespace ID1d9d05af5c624f2cb80a45f2c911e2f4
namespace_nameNamespace NameVirtual Server
operatorOperator - EQ, NOT_EQ, GT, GTE, LT, LTE, RANGERANGE
periodPeriod (seconds)300
srnSDS cloud Resource Name of the Alertsrn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::scp-servicewatch:alert/0ad6da92-634a-4f8c-932e-9d650599ab1e
stateAlert State - NORMAL, ALERT, INSUFFICIENT_DATANORMAL
statisticStatistic - SUM, AVG, MAX, MINAVG
thresholdThreshold for the Alert Condition (except fro RANGE operator)80.0
timestampTimestamp2025-08-15T11:04:00.000+0000
typeAlert TypeMETRIC_ALERT
upper_boundUpper bound for the Alert range operator90.0
violation_countViolation Count for the Alert Condition2

32.2 - 1.3

scp-cli servicewatch alert show
--id <value>

Description

Show the Alert

State ACTIVE (SUPPORTED)

VersionNot Before
1.320270131

Parameters

NameTypeDescriptionExample
id
required
stringAlert ID3234bd0f12fa4d0b97ab9feff6c09b8e

Responses

NameDescriptionExample
activated_ynWhether the Alert is activated or notY
created_atCreated date time
created_byCreator IDf4b8a4c4017f4f8d8399f0c02582ae47
descriptionAlert DescriptionDescription for Alert Test
dimensionDimension
dimensionsList of Dimensions[]
evaluation_countEvaluation Count for the Alert Condition3
evaluation_time_windowEvaluation Time Window (period * evaluation_count)900
individual_itemsList of Individual Items[]
last_policy_updated_atLast Alert Policy Updated Date Time
levelAlert Level - HIGH, MIDDLE, LOWHIGH
lower_boundLower bound for the Alert range operator80.0
metric_idMetric IDf13aab3b88c341b2bc73f8925a0e8cc5
metric_nameMetric NameCPU Usage
metric_unitMetric 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, NONEBYTE
missing_data_optionMissing Data Option - MISSING, BREACHING, NOT_BREACHING, IGNOREBREACHING
modified_atModified date time
modified_byModifier IDf4b8a4c4017f4f8d8399f0c02582ae47
nameAlert NameAlert Test
namespace_idNamespace ID1d9d05af5c624f2cb80a45f2c911e2f4
namespace_nameNamespace NameVirtual Server
operatorOperator - EQ, NOT_EQ, GT, GTE, LT, LTE, RANGERANGE
periodPeriod (seconds)300
srnSDS cloud Resource Name of the Alertsrn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::scp-servicewatch:alert/0ad6da92-634a-4f8c-932e-9d650599ab1e
stateAlert State - NORMAL, ALERT, INSUFFICIENT_DATANORMAL
statisticStatistic - SUM, AVG, MAX, MINAVG
thresholdThreshold for the Alert Condition (except fro RANGE operator)80.0
timestampTimestamp2025-08-15T11:04:00.000+0000
typeAlert TypeMETRIC_ALERT
upper_boundUpper bound for the Alert range operator90.0
violation_countViolation Count for the Alert Condition2

32.3 - 1.2

scp-cli servicewatch alert show
--id <value>

Description

Show the Alert

State ACTIVE (SUPPORTED)

VersionNot Before
1.220261130

Parameters

NameTypeDescriptionExample
id
required
stringAlert ID3234bd0f12fa4d0b97ab9feff6c09b8e

Responses

NameDescriptionExample
activated_ynWhether the Alert is activated or notY
created_atCreated date time
created_byCreator IDf4b8a4c4017f4f8d8399f0c02582ae47
descriptionAlert DescriptionDescription for Alert Test
dimensionDimension
dimensionsList of Dimensions[]
evaluation_countEvaluation Count for the Alert Condition3
evaluation_time_windowEvaluation Time Window (period * evaluation_count)900
individual_itemsList of Individual Items[]
last_policy_updated_atLast Alert Policy Updated Date Time
levelAlert Level - HIGH, MIDDLE, LOWHIGH
lower_boundLower bound for the Alert range operator80.0
metric_idMetric IDf13aab3b88c341b2bc73f8925a0e8cc5
metric_nameMetric NameCPU Usage
metric_unitMetric 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, NONEBYTE
missing_data_optionMissing Data Option - MISSING, BREACHING, NOT_BREACHING, IGNOREBREACHING
modified_atModified date time
modified_byModifier IDf4b8a4c4017f4f8d8399f0c02582ae47
nameAlert NameAlert Test
namespace_idNamespace ID1d9d05af5c624f2cb80a45f2c911e2f4
namespace_nameNamespace NameVirtual Server
operatorOperator - EQ, NOT_EQ, GT, GTE, LT, LTE, RANGERANGE
periodPeriod (seconds)300
srnSDS cloud Resource Name of the Alertsrn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::scp-servicewatch:alert/0ad6da92-634a-4f8c-932e-9d650599ab1e
stateAlert State - NORMAL, ALERT, INSUFFICIENT_DATANORMAL
statisticStatistic - SUM, AVG, MAX, MINAVG
thresholdThreshold for the Alert Condition (except fro RANGE operator)80.0
typeAlert TypeMETRIC_ALERT
upper_boundUpper bound for the Alert range operator90.0
violation_countViolation Count for the Alert Condition2

33 - ShowAlertLevelCountsByService

33.1 - 1.4

scp-cli servicewatch alert-level counts by service

Description

Show Alert level counts by service

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Responses

NameDescriptionExample
HIGHCount of HIGH Level10
LOWCount of LOW Level64
MIDDLECount of MIDDLE Level6
dashboard_idDashboard’s unique ID06565dbb67544154b1eabe81658a2e83
favorite_enabledFavorite EnabledTrue
namespace_idNamespace ID1d9d05af5c624f2cb80a45f2c911e2f4
namespace_nameNamespace NameVirtual Server
service_codeService codevirtualserver
service_menu_nameService menu nameVirtual Server

34 - ShowDashboard

34.1 - 1.4

scp-cli servicewatch dashboard show
--dashboard_id <value>

Description

Show dashboard

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
dashboard_id
required
stringDashboard's unique IDb48e730a70e74f6aa3d2555000b5c22b

Responses

NameDescriptionExample
idDashboard’s unique IDb48e730a70e74f6aa3d2555000b5c22b
alertsAlert information related to the dashboard{}
created_atCreated date time
created_byCreator IDuser-xxxxxxxx
favorite_enabledWhether it is a favorite dashboardTrue
modified_atModified date time
modified_byModifier IDuser-yyyyyyyy
nameDashboard’s nameProduction-Web-Servers
namespace_codeAssociated namespace codevirtualserver
product_nameAssociated resource typeServiceWatch
resource_idAssociated resource IDc8e41e595ad040a8abe57e2ffc109113
resource_nameAssociated resource nameProduction-Web-Servers
resource_typeAssociated resource typedashboard
service_codeAssociated service codevirtualserver
share_typeSharing typePrivate
srnService resource name (SRN)srn:vs:kr-central-1:123456789012:instance/c8e41e595ad040a8abe57e2ffc109113
typeDashboard typeCustom
widgetsList of widgets included in the dashboard[]

34.2 - 1.3

scp-cli servicewatch dashboard show
--dashboard_id <value>

Description

Show dashboard

State ACTIVE (SUPPORTED)

VersionNot Before
1.320270131

Parameters

NameTypeDescriptionExample
dashboard_id
required
stringDashboard's unique IDb48e730a70e74f6aa3d2555000b5c22b

Responses

NameDescriptionExample
idDashboard’s unique IDb48e730a70e74f6aa3d2555000b5c22b
alertsAlert information related to the dashboard{}
created_atCreated date time
created_byCreator IDuser-xxxxxxxx
favorite_enabledWhether it is a favorite dashboardTrue
modified_atModified date time
modified_byModifier IDuser-yyyyyyyy
nameDashboard’s nameProduction-Web-Servers
product_nameAssociated resource typeServiceWatch
resource_idAssociated resource IDc8e41e595ad040a8abe57e2ffc109113
resource_nameAssociated resource nameProduction-Web-Servers
resource_typeAssociated resource typedashboard
service_codeAssociated service codevirtualserver
share_typeSharing typePrivate
srnService resource name (SRN)srn:vs:kr-central-1:123456789012:instance/c8e41e595ad040a8abe57e2ffc109113
typeDashboard typeCustom
widgetsList of widgets included in the dashboard[]

34.3 - 1.2

scp-cli servicewatch dashboard show
--dashboard_id <value>

Description

Show dashboard

State ACTIVE (SUPPORTED)

VersionNot Before
1.220261130

Parameters

NameTypeDescriptionExample
dashboard_id
required
stringDashboard's unique IDb48e730a70e74f6aa3d2555000b5c22b

Responses

NameDescriptionExample
idDashboard’s unique IDb48e730a70e74f6aa3d2555000b5c22b
alertsAlert information related to the dashboard{}
created_atCreated date time
created_byCreator IDuser-xxxxxxxx
favorite_enabledWhether it is a favorite dashboardTrue
modified_atModified date time
modified_byModifier IDuser-yyyyyyyy
nameDashboard’s nameProduction-Web-Servers
product_nameAssociated resource typeServiceWatch
resource_idAssociated resource IDc8e41e595ad040a8abe57e2ffc109113
resource_nameAssociated resource nameProduction-Web-Servers
resource_typeAssociated resource typedashboard
service_codeAssociated service codevirtualserver
share_typeSharing typePrivate
srnService resource name (SRN)srn:vs:kr-central-1:123456789012:instance/c8e41e595ad040a8abe57e2ffc109113
typeDashboard typeCustom
widgetsList of widgets included in the dashboard[]

34.4 - 1.1

scp-cli servicewatch dashboard show
--dashboard_id <value>

Description

Show dashboard

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260831

Parameters

NameTypeDescriptionExample
dashboard_id
required
stringDashboard's unique IDb48e730a70e74f6aa3d2555000b5c22b

Responses

NameDescriptionExample
idDashboard’s unique IDb48e730a70e74f6aa3d2555000b5c22b
alertsAlert information related to the dashboard{}
created_atCreated date time
created_byCreator IDuser-xxxxxxxx
favorite_enabledWhether it is a favorite dashboardTrue
modified_atModified date time
modified_byModifier IDuser-yyyyyyyy
nameDashboard’s nameProduction-Web-Servers
product_nameAssociated resource typeServiceWatch
resource_idAssociated resource IDc8e41e595ad040a8abe57e2ffc109113
resource_nameAssociated resource nameProduction-Web-Servers
resource_typeAssociated resource typedashboard
service_codeAssociated service codevirtualserver
share_typeSharing typePrivate
srnService resource name (SRN)srn:vs:kr-central-1:123456789012:instance/c8e41e595ad040a8abe57e2ffc109113
typeDashboard typeCustom
widgetsList of widgets included in the dashboard[]

34.5 - 1.0

scp-cli servicewatch dashboard show
--dashboard_id <value>

Description

Show dashboard

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260630

Parameters

NameTypeDescriptionExample
dashboard_id
required
stringDashboard's unique IDb48e730a70e74f6aa3d2555000b5c22b

Responses

NameDescriptionExample
idDashboard’s unique IDb48e730a70e74f6aa3d2555000b5c22b
alertsAlert information related to the dashboard{}
created_atCreated date time
created_byCreator IDuser-xxxxxxxx
favorite_enabledWhether it is a favorite dashboardTrue
modified_atModified date time
modified_byModifier IDuser-yyyyyyyy
nameDashboard’s nameProduction-Web-Servers
product_nameAssociated resource typeServiceWatch
resource_idAssociated resource IDc8e41e595ad040a8abe57e2ffc109113
resource_nameAssociated resource nameProduction-Web-Servers
resource_typeAssociated resource typedashboard
share_typeSharing typePrivate
srnService resource name (SRN)srn:vs:kr-central-1:123456789012:instance/c8e41e595ad040a8abe57e2ffc109113
typeDashboard typeCustom
widgetsList of widgets included in the dashboard[]

35 - ShowEventRule

35.1 - 1.4

scp-cli servicewatch eventrule show
--event_rule_id <value>

Description

Show the Event rule.

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
event_rule_id
required
stringEvent rule IDb73f95c698f540dab18860f72fafd03f

Responses

NameDescriptionExample
event_ruleEvent rule

35.2 - 1.3

scp-cli servicewatch eventrule show
--event_rule_id <value>

Description

Show the Event rule.

State ACTIVE (SUPPORTED)

VersionNot Before
1.320270131

Parameters

NameTypeDescriptionExample
event_rule_id
required
stringEvent rule IDb73f95c698f540dab18860f72fafd03f

Responses

NameDescriptionExample
event_ruleEvent rule

35.3 - 1.2

scp-cli servicewatch eventrule show
--event_rule_id <value>

Description

Show the Event rule.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220261130

Parameters

NameTypeDescriptionExample
event_rule_id
required
stringEvent rule IDb73f95c698f540dab18860f72fafd03f

Responses

NameDescriptionExample
event_ruleEvent rule

36 - ShowLogGroup

36.1 - 1.4

scp-cli servicewatch loggroup show
--log_group_id <value>

Description

Show the Log group.

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
log_group_id
required
stringLog group IDbce52822147744b4afe0187164caa2e8

Responses

NameDescriptionExample
log_groupLog group

36.2 - 1.3

scp-cli servicewatch loggroup show
--log_group_id <value>

Description

Show the Log group.

State ACTIVE (SUPPORTED)

VersionNot Before
1.320270131

Parameters

NameTypeDescriptionExample
log_group_id
required
stringLog group IDbce52822147744b4afe0187164caa2e8

Responses

NameDescriptionExample
log_groupLog group

36.3 - 1.2

scp-cli servicewatch loggroup show
--log_group_id <value>

Description

Show the Log group.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220261130

Parameters

NameTypeDescriptionExample
log_group_id
required
stringLog group IDbce52822147744b4afe0187164caa2e8

Responses

NameDescriptionExample
log_groupLog group

37 - ShowLogStream

37.1 - 1.4

scp-cli servicewatch logstream show
--log_stream_id <value>
--log_group_id <value>

Description

Show the Log group log stream

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
log_stream_id
required
stringLog stream IDb0fc99a46a2c44b8b22739b130853dd8
log_group_id
required
stringLog group IDbce52822147744b4afe0187164caa2e8

Responses

NameDescriptionExample
log_streamLog stream

37.2 - 1.3

scp-cli servicewatch logstream show
--log_stream_id <value>
--log_group_id <value>

Description

Show the Log group log stream

State ACTIVE (SUPPORTED)

VersionNot Before
1.320270131

Parameters

NameTypeDescriptionExample
log_stream_id
required
stringLog stream IDb0fc99a46a2c44b8b22739b130853dd8
log_group_id
required
stringLog group IDbce52822147744b4afe0187164caa2e8

Responses

NameDescriptionExample
log_streamLog stream

37.3 - 1.2

scp-cli servicewatch logstream show
--log_stream_id <value>
--log_group_id <value>

Description

Show the Log group log stream

State ACTIVE (SUPPORTED)

VersionNot Before
1.220261130

Parameters

NameTypeDescriptionExample
log_stream_id
required
stringLog stream IDb0fc99a46a2c44b8b22739b130853dd8
log_group_id
required
stringLog group IDbce52822147744b4afe0187164caa2e8

Responses

NameDescriptionExample
log_streamLog stream