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

Return to the regular view of this page.

ServiceWatch

Overview

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

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

Version

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

VersionStatusNot Before
1.2CURRENT-
1.1SUPPORTED20260831
1.0DEPRECATED20260630

1 - CLIs

1.1 - CreateAlert

1.1.1 - 1.2

scpcli 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.2-

Parameters

NameTypeDescriptionExample
value
required
stringDimension Value10bf5d24-0f20-4066-bb0b-de2b1d6ff502
key
required
stringDimension KeyInstanceId
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 IDd583a229-9766-4eb8-96c4-ec389902ba3d
name
required
stringAlert NameAlert1
metric_id
required
stringMetric IDd91097ac-0387-4e69-adb2-7b8d453b8db5
level
required
stringAlert Level - HIGH, MIDDLE, LOWHIGH
description
optional
stringAlert DescriptionAlert1 Description
dimensions
optional
arrayList of Dimensions'{"key": "InstanceId", "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 ID0ad6da92-634a-4f8c-932e-9d650599ab1e
created_atCreated date time
created_byCreator IDf4b8a4c4017f4f8d8399f0c02582ae47

1.2 - CreateCustomLogEvents

1.2.1 - 1.2

scpcli servicewatch logeventcustom create
--resourcelogs <value>

Description

Create Custom log events

State ACTIVE (CURRENT)

VersionNot Before
1.2-

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

1.2.2 - 1.1

scpcli servicewatch logeventcustom create
--resourcelogs <value>

Description

Create Custom log events

State ACTIVE (SUPPORTED)

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

1.3 - CreateCustomLogStream

1.3.1 - 1.2

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

Description

Create a custom log stream

State ACTIVE (CURRENT)

VersionNot Before
1.2-

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

1.3.2 - 1.1

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

Description

Create a custom log stream

State ACTIVE (SUPPORTED)

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

1.4 - CreateCustomMetricMetas

1.4.1 - 1.2

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

Description

Create Custom Metric Metas

State ACTIVE (CURRENT)

VersionNot Before
1.2-

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
codeRESPONSE STATUS CODE of MetricSuccess
messageMessage about Updated Unit Info[libvirt_domain_info_virtual_cpus] unit is updated from Count to Bytes

1.4.2 - 1.1

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

Description

Create Custom Metric Metas

State ACTIVE (SUPPORTED)

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
codeRESPONSE STATUS CODE of MetricSuccess
messageMessage about Updated Unit Info[libvirt_domain_info_virtual_cpus] unit is updated from Count to Bytes

1.5 - CreateCustomMetrics

1.5.1 - 1.2

scpcli servicewatch metriccustom create
--resource_metrics <value>

Description

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

State ACTIVE (CURRENT)

VersionNot Before
1.2-

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

1.5.2 - 1.1

scpcli servicewatch metriccustom create
--resource_metrics <value>

Description

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

State ACTIVE (SUPPORTED)

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

1.6 - CreateDashboard

1.6.1 - 1.2

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

Description

Create dashboard

State ACTIVE (CURRENT)

VersionNot Before
1.2-

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”: “InstanceId”, “value”: “10bf5d24-0f20-4066-bb0b-de2b1d6ff502”}], “display_name”: “EC2-Prod-CPU”, “individual_items”: [{“key”: “BucketId”, “value”: “b-1234567890abcdef0”}], “name”: “CPUUtilization”, “namespace_name”: “Virtual Server”, “period”: 300, “statistic_type”: “AVG”}], “period”: 300, “stacked”: false, “statistic_type”: “AVG”, “title”: “Virtual Server

Responses

NameDescriptionExample
idWidget’s unique ID75da70a1a4fb486ab0282cf90693ec3c
dashboard_idDashboard’s unique IDb48e730a70e74f6aa3d2555000b5c22b
heightWidget’s height1
orderWidget’s order in the dashboard1
propertiesWidget’s detailed properties
typeWidget typemetric
widthWidget’s width1

1.6.2 - 1.1

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

Description

Create dashboard

State ACTIVE (SUPPORTED)

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”: “InstanceId”, “value”: “10bf5d24-0f20-4066-bb0b-de2b1d6ff502”}], “display_name”: “EC2-Prod-CPU”, “individual_items”: [{“key”: “BucketId”, “value”: “b-1234567890abcdef0”}], “name”: “CPUUtilization”, “namespace_name”: “Virtual Server”, “period”: 300, “statistic_type”: “AVG”}], “period”: 300, “stacked”: false, “statistic_type”: “AVG”, “title”: “Virtual Server

Responses

NameDescriptionExample
idWidget’s unique ID75da70a1a4fb486ab0282cf90693ec3c
dashboard_idDashboard’s unique IDb48e730a70e74f6aa3d2555000b5c22b
heightWidget’s height1
orderWidget’s order in the dashboard1
propertiesWidget’s detailed properties
typeWidget typemetric
widthWidget’s width1

1.6.3 - 1.0

scpcli 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”: “InstanceId”, “value”: “10bf5d24-0f20-4066-bb0b-de2b1d6ff502”}], “display_name”: “EC2-Prod-CPU”, “individual_items”: [{“key”: “BucketId”, “value”: “b-1234567890abcdef0”}], “name”: “CPUUtilization”, “namespace_name”: “Virtual Server”, “period”: 300, “statistic_type”: “AVG”}], “period”: 300, “stacked”: false, “statistic_type”: “AVG”, “title”: “Virtual Server

Responses

NameDescriptionExample
idWidget’s unique ID75da70a1a4fb486ab0282cf90693ec3c
dashboard_idDashboard’s unique IDb48e730a70e74f6aa3d2555000b5c22b
heightWidget’s height1
orderWidget’s order in the dashboard1
propertiesWidget’s detailed properties
typeWidget typemetric
widthWidget’s width1

1.7 - CreateEventRule

1.7.1 - 1.2

scpcli 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.2-

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

1.7.2 - 1.1

scpcli 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.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

1.7.3 - 1.0

scpcli 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

1.8 - CreateLogGroup

1.8.1 - 1.2

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

Description

Create a Log group.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

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

1.8.2 - 1.1

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

Description

Create a Log group.

State ACTIVE (SUPPORTED)

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

1.8.3 - 1.0

scpcli 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

1.9 - CreateLogStream

1.9.1 - 1.2

scpcli servicewatch logstream create
--log_group_id <value>
--name <value>

Description

Create a Log group log stream.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
log_group_id
required
stringLog group IDbce52822147744b4afe0187164caa2e8
name
required
stringLog stream nametestls01

Responses

NameDescriptionExample
log_streamLog stream

1.9.2 - 1.1

scpcli servicewatch logstream create
--log_group_id <value>
--name <value>

Description

Create a Log group log stream.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120260831

Parameters

NameTypeDescriptionExample
log_group_id
required
stringLog group IDbce52822147744b4afe0187164caa2e8
name
required
stringLog stream nametestls01

Responses

NameDescriptionExample
log_streamLog stream

1.9.3 - 1.0

scpcli 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

1.10 - DeleteAlerts

1.10.1 - 1.2

scpcli servicewatch alert delete-bulk
--ids <value>

Description

Delete Alerts

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
ids
required
arrayList of Alert IDs0ad6da92-634a-4f8c-932e-9d650599ab1e

1.11 - DeleteBulkDashboards

1.11.1 - 1.2

scpcli servicewatch dashboard delete
--dashboard_ids <value>

Description

Delete bulk dashboards

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
dashboard_ids
required
arrayList of dashboard IDsb48e730a70e74f6aa3d2555000b5c22b

1.11.2 - 1.1

scpcli servicewatch dashboard delete
--dashboard_ids <value>

Description

Delete bulk dashboards

State ACTIVE (SUPPORTED)

VersionNot Before
1.120260831

Parameters

NameTypeDescriptionExample
dashboard_ids
required
arrayList of dashboard IDsb48e730a70e74f6aa3d2555000b5c22b

1.11.3 - 1.0

scpcli 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

1.12 - DeleteEventRules

1.12.1 - 1.2

scpcli servicewatch eventrule delete-bulk
--ids <value>

Description

Delete Event rules.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
ids
required
arrayList of Event rule IDs66d77b4e32d04558b2382b1d14765d86

1.12.2 - 1.1

scpcli servicewatch eventrule delete-bulk
--ids <value>

Description

Delete Event rules.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120260831

Parameters

NameTypeDescriptionExample
ids
required
arrayList of Event rule IDs66d77b4e32d04558b2382b1d14765d86

1.12.3 - 1.0

scpcli 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

1.13 - DeleteLogGroups

1.13.1 - 1.2

scpcli servicewatch loggroup delete-bulk
--ids <value>

Description

Delete Log groups.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
ids
required
arrayList of Log group IDs602b39cb1d6b4b7fb0f18de43a4c689c

1.13.2 - 1.1

scpcli servicewatch loggroup delete-bulk
--ids <value>

Description

Delete Log groups.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120260831

Parameters

NameTypeDescriptionExample
ids
required
arrayList of Log group IDs602b39cb1d6b4b7fb0f18de43a4c689c

1.13.3 - 1.0

scpcli 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

1.14 - DeleteLogStreams

1.14.1 - 1.2

scpcli servicewatch logstream delete-bulk
--log_group_id <value>
--ids <value>

Description

Delete Log group log streams.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

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

1.14.2 - 1.1

scpcli servicewatch logstream delete-bulk
--log_group_id <value>
--ids <value>

Description

Delete Log group log streams.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120260831

Parameters

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

1.14.3 - 1.0

scpcli 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

1.15 - DownloadMetricDataImage

1.15.1 - 1.2

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

Description

Download metric data image

State ACTIVE (CURRENT)

VersionNot Before
1.2-

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

1.15.2 - 1.1

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

Description

Download metric data image

State ACTIVE (SUPPORTED)

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

1.15.3 - 1.0

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

Description

Download metric data image

State ACTIVE (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

1.16 - ListDashboards

1.16.1 - 1.2

scpcli 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 (CURRENT)

VersionNot Before
1.2-

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
typeDashboard typeCustom

1.16.2 - 1.1

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

Description

Get list of dashboards

State ACTIVE (SUPPORTED)

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
typeDashboard typeCustom

1.16.3 - 1.0

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

Description

Get list of dashboards

State ACTIVE (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
typeDashboard typeCustom

1.17 - ListLogGroups

1.17.1 - 1.2

scpcli 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.2-

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

1.17.2 - 1.1

scpcli 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.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

1.17.3 - 1.0

scpcli 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

1.18 - ListMetricData

1.18.1 - 1.2

scpcli 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.2-

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”]]

1.18.2 - 1.1

scpcli 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.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”]]

1.18.3 - 1.0

scpcli 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”]]

1.19 - ListMetricInfos

1.19.1 - 1.2

scpcli 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.2-

Parameters

NameTypeDescriptionExample
metric_name
optional
stringMetric NameCPU Usage/Core[Basic]
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
idNamespace IDd583a229-9766-4eb8-96c4-ec389902ba3d
dimensions
nameNamespaceVirtual Server
service_name

1.19.2 - 1.1

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

Description

Get metric list

State ACTIVE (SUPPORTED)

VersionNot Before
1.120260831

Parameters

NameTypeDescriptionExample
metric_name
optional
stringMetric NameCPU Usage/Core[Basic]
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
idNamespace IDd583a229-9766-4eb8-96c4-ec389902ba3d
dimensions
nameNamespaceVirtual Server
service_name

1.19.3 - 1.0

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

Description

Get metric list

State ACTIVE (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/Core[Basic]
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
idNamespace IDd583a229-9766-4eb8-96c4-ec389902ba3d
dimensions
nameNamespaceVirtual Server
service_name

1.20 - SetAlert

1.20.1 - 1.2

scpcli 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.2-

Parameters

NameTypeDescriptionExample
id
required
stringAlert ID0ad6da92-634a-4f8c-932e-9d650599ab1e
value
required
stringDimension Value10bf5d24-0f20-4066-bb0b-de2b1d6ff502
key
required
stringDimension KeyInstanceId
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 IDd583a229-9766-4eb8-96c4-ec389902ba3d
metric_id
required
stringMetric IDd91097ac-0387-4e69-adb2-7b8d453b8db5
level
required
stringAlert Level - HIGH, MIDDLE, LOWHIGH
dimensions
optional
arrayList of Dimensions'{"key": "InstanceId", "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 KeyInstanceId
valueDimension Value10bf5d24-0f20-4066-bb0b-de2b1d6ff502

1.21 - SetAlertActivated

1.21.1 - 1.2

scpcli servicewatch alert-activated set
--id <value>
--activated_yn <value>

Description

Set the Alert Activated

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
id
required
stringAlert ID0ad6da92-634a-4f8c-932e-9d650599ab1e
activated_yn
required
stringWhether the Alert is activated or notY

Responses

NameDescriptionExample
idAlert ID0ad6da92-634a-4f8c-932e-9d650599ab1e
activated_ynWhether the Alert is activated or notY
modified_atModified date time2026-03-13T02:34:40.008404

1.22 - SetAlertDescription

1.22.1 - 1.2

scpcli servicewatch alert-description set
--id <value>
[--description <value>]

Description

Set the Alert Description

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
id
required
stringAlert ID0ad6da92-634a-4f8c-932e-9d650599ab1e
description
optional
stringAlert DescriptionAlert1 Description

Responses

NameDescriptionExample
idAlert ID0ad6da92-634a-4f8c-932e-9d650599ab1e
descriptionAlert DescriptionAlert1 Description
modified_atModified date time2026-03-13T02:34:40.006634

1.23 - SetDashboard

1.23.1 - 1.2

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

Description

Set dashboard

State ACTIVE (CURRENT)

VersionNot Before
1.2-

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”: “InstanceId”, “value”: “10bf5d24-0f20-4066-bb0b-de2b1d6ff502”}], “display_name”: “EC2-Prod-CPU”, “individual_items”: [{“key”: “BucketId”, “value”: “b-1234567890abcdef0”}], “name”: “CPUUtilization”, “namespace_name”: “Virtual Server”, “period”: 300, “statistic_type”: “AVG”}], “period”: 300, “stacked”: false, “statistic_type”: “AVG”, “title”: “Virtual Server

1.23.2 - 1.1

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

Description

Set dashboard

State ACTIVE (SUPPORTED)

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”: “InstanceId”, “value”: “10bf5d24-0f20-4066-bb0b-de2b1d6ff502”}], “display_name”: “EC2-Prod-CPU”, “individual_items”: [{“key”: “BucketId”, “value”: “b-1234567890abcdef0”}], “name”: “CPUUtilization”, “namespace_name”: “Virtual Server”, “period”: 300, “statistic_type”: “AVG”}], “period”: 300, “stacked”: false, “statistic_type”: “AVG”, “title”: “Virtual Server

1.23.3 - 1.0

scpcli 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”: “InstanceId”, “value”: “10bf5d24-0f20-4066-bb0b-de2b1d6ff502”}], “display_name”: “EC2-Prod-CPU”, “individual_items”: [{“key”: “BucketId”, “value”: “b-1234567890abcdef0”}], “name”: “CPUUtilization”, “namespace_name”: “Virtual Server”, “period”: 300, “statistic_type”: “AVG”}], “period”: 300, “stacked”: false, “statistic_type”: “AVG”, “title”: “Virtual Server

1.24 - SetEventRule

1.24.1 - 1.2

scpcli 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.2-

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

1.24.2 - 1.1

scpcli 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.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

1.24.3 - 1.0

scpcli 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

1.25 - SetLogGroup

1.25.1 - 1.2

scpcli servicewatch loggroup set
--log_group_id <value>
--retention_period <value>

Description

Set the Log group.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

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

Responses

NameDescriptionExample
log_groupLog group

1.25.2 - 1.1

scpcli servicewatch loggroup set
--log_group_id <value>
--retention_period <value>

Description

Set the Log group.

State ACTIVE (SUPPORTED)

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

1.25.3 - 1.0

scpcli 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

1.26 - ShowAgentDownloadLink

1.26.1 - 1.2

scpcli servicewatch show agent download link

Description

Show link to agent download

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Responses

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

1.26.2 - 1.1

scpcli servicewatch show agent download link

Description

Show link to agent download

State ACTIVE (SUPPORTED)

VersionNot Before
1.120260831

Responses

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

1.27 - ShowAlert

1.27.1 - 1.2

scpcli servicewatch alert show
--id <value>

Description

Show the Alert

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
id
required
stringAlert ID0ad6da92-634a-4f8c-932e-9d650599ab1e

Responses

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

1.28 - ShowDashboard

1.28.1 - 1.2

scpcli servicewatch dashboard show
--dashboard_id <value>

Description

Show dashboard

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
dashboard_id
required
stringDashboard's unique IDb48e730a70e74f6aa3d2555000b5c22b

Responses

NameDescriptionExample
idWidget’s unique ID75da70a1a4fb486ab0282cf90693ec3c
dashboard_idDashboard’s unique IDb48e730a70e74f6aa3d2555000b5c22b
heightWidget’s height1
orderWidget’s order in the dashboard1
propertiesWidget’s detailed properties
typeWidget typemetric
widthWidget’s width1

1.28.2 - 1.1

scpcli servicewatch dashboard show
--dashboard_id <value>

Description

Show dashboard

State ACTIVE (SUPPORTED)

VersionNot Before
1.120260831

Parameters

NameTypeDescriptionExample
dashboard_id
required
stringDashboard's unique IDb48e730a70e74f6aa3d2555000b5c22b

Responses

NameDescriptionExample
idWidget’s unique ID75da70a1a4fb486ab0282cf90693ec3c
dashboard_idDashboard’s unique IDb48e730a70e74f6aa3d2555000b5c22b
heightWidget’s height1
orderWidget’s order in the dashboard1
propertiesWidget’s detailed properties
typeWidget typemetric
widthWidget’s width1

1.28.3 - 1.0

scpcli 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
idWidget’s unique ID75da70a1a4fb486ab0282cf90693ec3c
dashboard_idDashboard’s unique IDb48e730a70e74f6aa3d2555000b5c22b
heightWidget’s height1
orderWidget’s order in the dashboard1
propertiesWidget’s detailed properties
typeWidget typemetric
widthWidget’s width1

1.29 - ShowEventRule

1.29.1 - 1.2

scpcli servicewatch eventrule show
--event_rule_id <value>

Description

Show the Event rule.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
event_rule_id
required
stringEvent rule IDb73f95c698f540dab18860f72fafd03f

Responses

NameDescriptionExample
event_ruleEvent rule

1.30 - ShowLogGroup

1.30.1 - 1.2

scpcli servicewatch loggroup show
--log_group_id <value>

Description

Show the Log group.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
log_group_id
required
stringLog group IDbce52822147744b4afe0187164caa2e8

Responses

NameDescriptionExample
log_groupLog group

1.31 - ShowLogStream

1.31.1 - 1.2

scpcli servicewatch logstream show
--log_stream_id <value>
--log_group_id <value>

Description

Show the Log group log stream

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
log_stream_id
required
stringLog stream IDb0fc99a46a2c44b8b22739b130853dd8
log_group_id
required
stringLog group IDbce52822147744b4afe0187164caa2e8

Responses

NameDescriptionExample
log_streamLog stream