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.
| Version | Status | Not Before |
|---|
| 1.2 | CURRENT | - |
| 1.1 | SUPPORTED | 20260831 |
| 1.0 | DEPRECATED | 20260630 |
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)
Parameters
| Name | Type | Description | Example |
|---|
value required | string | Dimension Value | 10bf5d24-0f20-4066-bb0b-de2b1d6ff502 |
key required | string | Dimension Key | InstanceId |
statistic required | string | Statistic - SUM, AVG, MAX, MIN | AVG |
period required | integer | Period (seconds) | 300 |
operator required | string | Operator - EQ, NOT_EQ, GT, GTE, LT, LTE, RANGE | RANGE |
namespace_id required | string | Namespace ID | d583a229-9766-4eb8-96c4-ec389902ba3d |
name required | string | Alert Name | Alert1 |
metric_id required | string | Metric ID | d91097ac-0387-4e69-adb2-7b8d453b8db5 |
level required | string | Alert Level - HIGH, MIDDLE, LOW | HIGH |
description optional | string | Alert Description | Alert1 Description |
dimensions optional | array | List of Dimensions | '{"key": "InstanceId", "value": "10bf5d24-0f20-4066-bb0b-de2b1d6ff502"}' |
evaluation_count optional | integer | Evaluation Count for the Alert Condition | 3 |
individual_items optional | array | List of Individual Items | '{"key": "VolumeID", "value": "45fbde15-cdd2-4891-be31-4a9de75fccda"}' |
lower_bound optional | number | Lower bound for the Alert range operator | 80.0 |
missing_data_option optional | **** | Missing Data Option - MISSING, BREACHING, NOT_BREACHING, IGNORE | BREACHING |
recipient_ids optional | array | List of User IDs | 1234da92-634a-4f8c-932e-9d650599ab1b |
tags optional | array | List of Tags | '{"key": "key01", "value": "value01"}' |
threshold optional | number | Threshold for the Alert Condition (except fro RANGE operator) | 80.0 |
upper_bound optional | number | Upper bound for the Alert range operator | 90.0 |
violation_count optional | integer | Violation Count for the Alert Condition | 2 |
Responses
| Name | Description | Example |
|---|
| id | Alert ID | 0ad6da92-634a-4f8c-932e-9d650599ab1e |
| created_at | Created date time | |
| created_by | Creator ID | f4b8a4c4017f4f8d8399f0c02582ae47 |
1.2 - CreateCustomLogEvents
1.2.1 - 1.2
scpcli servicewatch logeventcustom create
--resourcelogs <value>
Description
Create Custom log events
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
resourcelogs required | array | Resource Logs | '{"resource": {"attributes": [{"key": "log_stream_value", "value": {"stringValue": "a1e2f3045678901a2b3c4d5e6f7a8b81"}}, {"key": "log_group_value", "value": {"stringValue": "b1e2f3045678901a2b3c4d5e6f7a8b81"}}, {"key": "account_id", "value": {"stringValue": "c1e2f3045678901a2b3c4d5e6f7a8b81"}}]}, "scopeLogs": [{"logRecords": [{"body": {"stringValue": "level=info otlp test log"}, "timeUnixNano": "1762336464000000000"}]}]}' |
Responses
| Name | Description | Example |
|---|
| status | Status | success |
1.2.2 - 1.1
scpcli servicewatch logeventcustom create
--resourcelogs <value>
Description
Create Custom log events
State
ACTIVE (SUPPORTED)
| Version | Not Before |
|---|
| 1.1 | 20260831 |
Parameters
| Name | Type | Description | Example |
|---|
resourcelogs required | array | Resource Logs | '{"resource": {"attributes": [{"key": "log_stream_value", "value": {"stringValue": "a1e2f3045678901a2b3c4d5e6f7a8b81"}}, {"key": "log_group_value", "value": {"stringValue": "b1e2f3045678901a2b3c4d5e6f7a8b81"}}, {"key": "account_id", "value": {"stringValue": "c1e2f3045678901a2b3c4d5e6f7a8b81"}}]}, "scopeLogs": [{"logRecords": [{"body": {"stringValue": "level=info otlp test log"}, "timeUnixNano": "1762336464000000000"}]}]}' |
Responses
| Name | Description | Example |
|---|
| status | Status | success |
1.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)
Parameters
| Name | Type | Description | Example |
|---|
log_stream_name required | string | Log stream name | testls01 |
log_group_name required | string | Log group name | testlg01 |
Responses
| Name | Description | Example |
|---|
| account_id | Account ID | 1bcf39b344ac41cbaf0466ff0d2bebad |
| log_group_value | Log group value | fa6169af200b4d5db229aff384b2a028 |
| log_stream_value | Log stream value | 551513c5182b45beb22eadb634cdccfb |
| requests_per_second | Export log requests per second | 500 |
1.3.2 - 1.1
scpcli servicewatch logstreamcustom create
--log_stream_name <value>
--log_group_name <value>
Description
Create a custom log stream
State
ACTIVE (SUPPORTED)
| Version | Not Before |
|---|
| 1.1 | 20260831 |
Parameters
| Name | Type | Description | Example |
|---|
log_stream_name required | string | Log stream name | testls01 |
log_group_name required | string | Log group name | testlg01 |
Responses
| Name | Description | Example |
|---|
| account_id | Account ID | 1bcf39b344ac41cbaf0466ff0d2bebad |
| log_group_value | Log group value | fa6169af200b4d5db229aff384b2a028 |
| log_stream_value | Log stream value | 551513c5182b45beb22eadb634cdccfb |
| requests_per_second | Export log requests per second | 500 |
1.4 - CreateCustomMetricMetas
1.4.1 - 1.2
scpcli servicewatch metriccustommeta create
--namespace <value>
--metricmetas <value>
Description
Create Custom Metric Metas
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
namespace required | string | Namespace | MyCustom/filestorage |
metricmetas required | array | | '{"descriptionEn": "filestorage volume total byte", "descriptionKo": "\ud30c\uc77c\uc2a4\ud1a0\ub9ac\uc9c0 \ucd1d \ubc14\uc774\ud2b8 \uc218", "dimensions": [["image_id"]], "metricName": "Custom_filestorage_volume_total_byte", "storageResolution": 60, "unit": "Bytes"}' |
Responses
| Name | Description | Example |
|---|
| code | RESPONSE STATUS CODE of Metric | Success |
| message | Message about Updated Unit Info | [libvirt_domain_info_virtual_cpus] unit is updated from Count to Bytes |
1.4.2 - 1.1
scpcli servicewatch metriccustommeta create
--namespace <value>
--metricmetas <value>
Description
Create Custom Metric Metas
State
ACTIVE (SUPPORTED)
| Version | Not Before |
|---|
| 1.1 | 20260831 |
Parameters
| Name | Type | Description | Example |
|---|
namespace required | string | Namespace | MyCustom/filestorage |
metricmetas required | array | | '{"descriptionEn": "filestorage volume total byte", "descriptionKo": "\ud30c\uc77c\uc2a4\ud1a0\ub9ac\uc9c0 \ucd1d \ubc14\uc774\ud2b8 \uc218", "dimensions": [["image_id"]], "metricName": "Custom_filestorage_volume_total_byte", "storageResolution": 60, "unit": "Bytes"}' |
Responses
| Name | Description | Example |
|---|
| code | RESPONSE STATUS CODE of Metric | Success |
| message | Message about Updated Unit Info | [libvirt_domain_info_virtual_cpus] unit is updated from Count to Bytes |
1.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)
Parameters
| Name | Type | Description | Example |
|---|
resource_metrics required | array | The resourceMetrics field holds a set of all metric data associated with a specific resource | '{"resource": {"attributes": [{"key": "", "value": {"array_value": "", "bool_value": "", "byte_value": "", "double_value": "", "int_value": "", "kvlist_value": "", "string_value": ""}}]}, "scope_metrics": [{"metrics": [{"description": "The total number of bytes read successfully.", "gauge": {"data_points": [{"as_double": 0.75, "as_int": 10, "attributes": [{"key": "", "value": {"array_value": "", "bool_value": "", "byte_value": "", "double_value": "", "int_value": "", "kvlist_value": "", "string_value": ""}}], "start_time_unix_nano": "1753776789854000000", "time_unix_nano": "1753776789854000000"}]}, "name": "node_disk_read_bytes_total", "sum": {"aggregation_temporality": "2", "data_points": [{"as_double": 0.75, "as_int": 10, "attributes": [{"key": "", "value": {"array_value": "", "bool_value": "", "byte_value": "", "double_value": "", "int_value": "", "kvlist_value": "", "string_value": ""}}], "start_time_unix_nano": "1753776789854000000", "time_unix_nano": "1753776789854000000"}], "is_monotonic": true}, "unit": "Bytes"}], "scope": {"name": "ServiceWatch-Agent", "version": "1.0.0"}}]}' |
Responses
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)
| Version | Not Before |
|---|
| 1.1 | 20260831 |
Parameters
| Name | Type | Description | Example |
|---|
resource_metrics required | array | The resourceMetrics field holds a set of all metric data associated with a specific resource | '{"resource": {"attributes": [{"key": "", "value": {"array_value": "", "bool_value": "", "byte_value": "", "double_value": "", "int_value": "", "kvlist_value": "", "string_value": ""}}]}, "scope_metrics": [{"metrics": [{"description": "The total number of bytes read successfully.", "gauge": {"data_points": [{"as_double": 0.75, "as_int": 10, "attributes": [{"key": "", "value": {"array_value": "", "bool_value": "", "byte_value": "", "double_value": "", "int_value": "", "kvlist_value": "", "string_value": ""}}], "start_time_unix_nano": "1753776789854000000", "time_unix_nano": "1753776789854000000"}]}, "name": "node_disk_read_bytes_total", "sum": {"aggregation_temporality": "2", "data_points": [{"as_double": 0.75, "as_int": 10, "attributes": [{"key": "", "value": {"array_value": "", "bool_value": "", "byte_value": "", "double_value": "", "int_value": "", "kvlist_value": "", "string_value": ""}}], "start_time_unix_nano": "1753776789854000000", "time_unix_nano": "1753776789854000000"}], "is_monotonic": true}, "unit": "Bytes"}], "scope": {"name": "ServiceWatch-Agent", "version": "1.0.0"}}]}' |
Responses
1.6 - CreateDashboard
1.6.1 - 1.2
scpcli servicewatch dashboard create
--name <value>
[--widgets <value>]
Description
Create dashboard
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
name required | string | Dashboard's name | New-Monitoring-Dashboard |
widgets optional | array | List of widgets included in the dashboard | ```’{“height”: 1, “order”: 1, “properties”: {“metrics”: [{“color”: “#ff7f0e”, “dimensions”: [{“key”: “InstanceId”, “value”: “10bf5d24-0f20-4066-bb0b-de2b1d6ff502”}], “display_name”: “EC2-Prod-CPU”, “individual_items”: [{“key”: “BucketId”, “value”: “b-1234567890abcdef0”}], “name”: “CPUUtilization”, “namespace_name”: “Virtual Server”, “period”: 300, “statistic_type”: “AVG”}], “period”: 300, “stacked”: false, “statistic_type”: “AVG”, “title”: “Virtual Server |
Responses
| Name | Description | Example |
|---|
| id | Widget’s unique ID | 75da70a1a4fb486ab0282cf90693ec3c |
| dashboard_id | Dashboard’s unique ID | b48e730a70e74f6aa3d2555000b5c22b |
| height | Widget’s height | 1 |
| order | Widget’s order in the dashboard | 1 |
| properties | Widget’s detailed properties | |
| type | Widget type | metric |
| width | Widget’s width | 1 |
1.6.2 - 1.1
scpcli servicewatch dashboard create
--name <value>
[--widgets <value>]
Description
Create dashboard
State
ACTIVE (SUPPORTED)
| Version | Not Before |
|---|
| 1.1 | 20260831 |
Parameters
| Name | Type | Description | Example |
|---|
name required | string | Dashboard's name | New-Monitoring-Dashboard |
widgets optional | array | List of widgets included in the dashboard | ```’{“height”: 1, “order”: 1, “properties”: {“metrics”: [{“color”: “#ff7f0e”, “dimensions”: [{“key”: “InstanceId”, “value”: “10bf5d24-0f20-4066-bb0b-de2b1d6ff502”}], “display_name”: “EC2-Prod-CPU”, “individual_items”: [{“key”: “BucketId”, “value”: “b-1234567890abcdef0”}], “name”: “CPUUtilization”, “namespace_name”: “Virtual Server”, “period”: 300, “statistic_type”: “AVG”}], “period”: 300, “stacked”: false, “statistic_type”: “AVG”, “title”: “Virtual Server |
Responses
| Name | Description | Example |
|---|
| id | Widget’s unique ID | 75da70a1a4fb486ab0282cf90693ec3c |
| dashboard_id | Dashboard’s unique ID | b48e730a70e74f6aa3d2555000b5c22b |
| height | Widget’s height | 1 |
| order | Widget’s order in the dashboard | 1 |
| properties | Widget’s detailed properties | |
| type | Widget type | metric |
| width | Widget’s width | 1 |
1.6.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.
| Version | Not Before |
|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|
name required | string | Dashboard's name | New-Monitoring-Dashboard |
widgets optional | array | List of widgets included in the dashboard | ```’{“height”: 1, “order”: 1, “properties”: {“metrics”: [{“color”: “#ff7f0e”, “dimensions”: [{“key”: “InstanceId”, “value”: “10bf5d24-0f20-4066-bb0b-de2b1d6ff502”}], “display_name”: “EC2-Prod-CPU”, “individual_items”: [{“key”: “BucketId”, “value”: “b-1234567890abcdef0”}], “name”: “CPUUtilization”, “namespace_name”: “Virtual Server”, “period”: 300, “statistic_type”: “AVG”}], “period”: 300, “stacked”: false, “statistic_type”: “AVG”, “title”: “Virtual Server |
Responses
| Name | Description | Example |
|---|
| id | Widget’s unique ID | 75da70a1a4fb486ab0282cf90693ec3c |
| dashboard_id | Dashboard’s unique ID | b48e730a70e74f6aa3d2555000b5c22b |
| height | Widget’s height | 1 |
| order | Widget’s order in the dashboard | 1 |
| properties | Widget’s detailed properties | |
| type | Widget type | metric |
| width | Widget’s width | 1 |
1.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)
Parameters
| Name | Type | Description | Example |
|---|
service_id required | string | Service ID | 2778de83d7e247609445bbd570a4eba9 |
name required | string | Event rule name | Event rule 1 |
description optional | string | Event rule description | Event rule 1 description |
event_ids optional | array | List of Event IDs | 014cb88ca2a9420e840d5c9ac16cac89 |
recipient_ids optional | array | Notification recipient IDs | 947c6a8559434505b28a5e21fff463d0 |
resource_type_id optional | string | Resource type ID | 596bf16709e84e27b7df397bf59b877c |
srn_list optional | array | List of SDS cloud Resource Names | srn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::servicewatch:event-rule/a58c8645928043a6868277c7d7fef11a |
tags optional | array | List of Tags | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|
| event_rule | Event 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)
| Version | Not Before |
|---|
| 1.1 | 20260831 |
Parameters
| Name | Type | Description | Example |
|---|
service_id required | string | Service ID | 2778de83d7e247609445bbd570a4eba9 |
name required | string | Event rule name | Event rule 1 |
description optional | string | Event rule description | Event rule 1 description |
event_ids optional | array | List of Event IDs | 014cb88ca2a9420e840d5c9ac16cac89 |
recipient_ids optional | array | Notification recipient IDs | 947c6a8559434505b28a5e21fff463d0 |
resource_type_id optional | string | Resource type ID | 596bf16709e84e27b7df397bf59b877c |
srn_list optional | array | List of SDS cloud Resource Names | srn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::servicewatch:event-rule/a58c8645928043a6868277c7d7fef11a |
tags optional | array | List of Tags | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|
| event_rule | Event 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.
| Version | Not Before |
|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|
service_id required | string | Service ID | 2778de83d7e247609445bbd570a4eba9 |
name required | string | Event rule name | Event rule 1 |
description optional | string | Event rule description | Event rule 1 description |
event_ids optional | array | List of Event IDs | 014cb88ca2a9420e840d5c9ac16cac89 |
recipient_ids optional | array | Notification recipient IDs | 947c6a8559434505b28a5e21fff463d0 |
resource_type_id optional | string | Resource type ID | 596bf16709e84e27b7df397bf59b877c |
srn_list optional | array | List of SDS cloud Resource Names | srn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::servicewatch:event-rule/a58c8645928043a6868277c7d7fef11a |
tags optional | array | List of Tags | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|
| event_rule | Event 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)
Parameters
| Name | Type | Description | Example |
|---|
retention_period required | integer | Log group retention period | 365 |
name required | string | Log group name | testlg01 |
tags optional | array | List of Tags | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|
| log_group | Log 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)
| Version | Not Before |
|---|
| 1.1 | 20260831 |
Parameters
| Name | Type | Description | Example |
|---|
retention_period required | integer | Log group retention period | 365 |
name required | string | Log group name | testlg01 |
tags optional | array | List of Tags | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|
| log_group | Log 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.
| Version | Not Before |
|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|
retention_period required | integer | Log group retention period | 365 |
name required | string | Log group name | testlg01 |
tags optional | array | List of Tags | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|
| log_group | Log 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)
Parameters
| Name | Type | Description | Example |
|---|
log_group_id required | string | Log group ID | bce52822147744b4afe0187164caa2e8 |
name required | string | Log stream name | testls01 |
Responses
| Name | Description | Example |
|---|
| log_stream | Log 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)
| Version | Not Before |
|---|
| 1.1 | 20260831 |
Parameters
| Name | Type | Description | Example |
|---|
log_group_id required | string | Log group ID | bce52822147744b4afe0187164caa2e8 |
name required | string | Log stream name | testls01 |
Responses
| Name | Description | Example |
|---|
| log_stream | Log 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.
| Version | Not Before |
|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|
log_group_id required | string | Log group ID | bce52822147744b4afe0187164caa2e8 |
name required | string | Log stream name | testls01 |
Responses
| Name | Description | Example |
|---|
| log_stream | Log stream | |
1.10 - DeleteAlerts
1.10.1 - 1.2
scpcli servicewatch alert delete-bulk
--ids <value>
Description
Delete Alerts
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
ids required | array | List of Alert IDs | 0ad6da92-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)
Parameters
| Name | Type | Description | Example |
|---|
dashboard_ids required | array | List of dashboard IDs | b48e730a70e74f6aa3d2555000b5c22b |
1.11.2 - 1.1
scpcli servicewatch dashboard delete
--dashboard_ids <value>
Description
Delete bulk dashboards
State
ACTIVE (SUPPORTED)
| Version | Not Before |
|---|
| 1.1 | 20260831 |
Parameters
| Name | Type | Description | Example |
|---|
dashboard_ids required | array | List of dashboard IDs | b48e730a70e74f6aa3d2555000b5c22b |
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.
| Version | Not Before |
|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|
dashboard_ids required | array | List of dashboard IDs | b48e730a70e74f6aa3d2555000b5c22b |
1.12 - DeleteEventRules
1.12.1 - 1.2
scpcli servicewatch eventrule delete-bulk
--ids <value>
Description
Delete Event rules.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
ids required | array | List of Event rule IDs | 66d77b4e32d04558b2382b1d14765d86 |
1.12.2 - 1.1
scpcli servicewatch eventrule delete-bulk
--ids <value>
Description
Delete Event rules.
State
ACTIVE (SUPPORTED)
| Version | Not Before |
|---|
| 1.1 | 20260831 |
Parameters
| Name | Type | Description | Example |
|---|
ids required | array | List of Event rule IDs | 66d77b4e32d04558b2382b1d14765d86 |
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.
| Version | Not Before |
|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|
ids required | array | List of Event rule IDs | 66d77b4e32d04558b2382b1d14765d86 |
1.13 - DeleteLogGroups
1.13.1 - 1.2
scpcli servicewatch loggroup delete-bulk
--ids <value>
Description
Delete Log groups.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
ids required | array | List of Log group IDs | 602b39cb1d6b4b7fb0f18de43a4c689c |
1.13.2 - 1.1
scpcli servicewatch loggroup delete-bulk
--ids <value>
Description
Delete Log groups.
State
ACTIVE (SUPPORTED)
| Version | Not Before |
|---|
| 1.1 | 20260831 |
Parameters
| Name | Type | Description | Example |
|---|
ids required | array | List of Log group IDs | 602b39cb1d6b4b7fb0f18de43a4c689c |
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.
| Version | Not Before |
|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|
ids required | array | List of Log group IDs | 602b39cb1d6b4b7fb0f18de43a4c689c |
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)
Parameters
| Name | Type | Description | Example |
|---|
log_group_id required | string | Log group ID | bce52822147744b4afe0187164caa2e8 |
ids required | array | List of Log stream IDs | b0fc99a46a2c44b8b22739b130853dd8 |
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)
| Version | Not Before |
|---|
| 1.1 | 20260831 |
Parameters
| Name | Type | Description | Example |
|---|
log_group_id required | string | Log group ID | bce52822147744b4afe0187164caa2e8 |
ids required | array | List of Log stream IDs | b0fc99a46a2c44b8b22739b130853dd8 |
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.
| Version | Not Before |
|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|
log_group_id required | string | Log group ID | bce52822147744b4afe0187164caa2e8 |
ids required | array | List of Log stream IDs | b0fc99a46a2c44b8b22739b130853dd8 |
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)
Parameters
| Name | Type | Description | Example |
|---|
statistic_type required | string | Metric Statistics Type | AVG |
start required | integer | Metric Start Time - Unix Timestamp | 1640995200 |
period required | integer | Statistic Period | 300 |
metrics required | array | | ```’{“color”: “#0000ff”, “dimensions”: [{“key”: “VolumeID”, “value”: “45fbde15-cdd2-4891-be31-4a9de75fccda”}], “display_name”: “Virtual Server |
end required | integer | Metric End Time - Unix Timestamp | 1640995440 |
height optional | integer | Chart Image Height(pixels) | 400 |
timezone optional | string | Timezone | UTC |
title optional | string | Chart Title | Virtual Server Metric Chart |
width optional | integer | Chart Image Width(pixels) | 600 |
Responses
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)
| Version | Not Before |
|---|
| 1.1 | 20260831 |
Parameters
| Name | Type | Description | Example |
|---|
statistic_type required | string | Metric Statistics Type | AVG |
start required | integer | Metric Start Time - Unix Timestamp | 1640995200 |
period required | integer | Statistic Period | 300 |
metrics required | array | | ```’{“color”: “#0000ff”, “dimensions”: [{“key”: “VolumeID”, “value”: “45fbde15-cdd2-4891-be31-4a9de75fccda”}], “display_name”: “Virtual Server |
end required | integer | Metric End Time - Unix Timestamp | 1640995440 |
height optional | integer | Chart Image Height(pixels) | 400 |
timezone optional | string | Timezone | UTC |
title optional | string | Chart Title | Virtual Server Metric Chart |
width optional | integer | Chart Image Width(pixels) | 600 |
Responses
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.
| Version | Not Before |
|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|
statistic_type required | string | Metric Statistics Type | AVG |
start required | integer | Metric Start Time - Unix Timestamp | 1640995200 |
period required | integer | Statistic Period | 300 |
metrics required | array | | ```’{“color”: “#0000ff”, “dimensions”: [{“key”: “VolumeID”, “value”: “45fbde15-cdd2-4891-be31-4a9de75fccda”}], “display_name”: “Virtual Server |
end required | integer | Metric End Time - Unix Timestamp | 1640995440 |
height optional | integer | Chart Image Height(pixels) | 400 |
timezone optional | string | Timezone | UTC |
title optional | string | Chart Title | Virtual Server Metric Chart |
width optional | integer | Chart Image Width(pixels) | 600 |
Responses
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)
Parameters
| Name | Type | Description | Example |
|---|
size optional | integer | size | 20 |
page optional | integer | page | 0 |
sort optional | string | sort | name:asc or modified_at:desc |
name optional | string | Dashboard's name | MyProd |
name_like optional | string | Wildcard Search for Dashboard Names | MyProd |
favorite_enabled optional | boolean | Whether it is a favorite dashboard | True |
type optional | string | Dashboard type | Custom |
service_code optional | string | Associated service code | virtualserver |
Responses
| Name | Description | Example |
|---|
| id | Dashboard’s unique ID | b48e730a70e74f6aa3d2555000b5c22b |
| created_at | Created date time | |
| favorite_enabled | Whether it is a favorite dashboard | True |
| modified_at | Modified date time | |
| name | Dashboard’s name | Production-Web-Servers |
| type | Dashboard type | Custom |
1.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)
| Version | Not Before |
|---|
| 1.1 | 20260831 |
Parameters
| Name | Type | Description | Example |
|---|
size optional | integer | size | 20 |
page optional | integer | page | 0 |
sort optional | string | sort | name:asc or modified_at:desc |
name optional | string | Dashboard's name | MyProd |
name_like optional | string | Wildcard Search for Dashboard Names | MyProd |
favorite_enabled optional | boolean | Whether it is a favorite dashboard | True |
Responses
| Name | Description | Example |
|---|
| id | Dashboard’s unique ID | b48e730a70e74f6aa3d2555000b5c22b |
| created_at | Created date time | |
| favorite_enabled | Whether it is a favorite dashboard | True |
| modified_at | Modified date time | |
| name | Dashboard’s name | Production-Web-Servers |
| type | Dashboard type | Custom |
1.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.
| Version | Not Before |
|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|
size optional | integer | size | 20 |
page optional | integer | page | 0 |
sort optional | string | sort | name:asc or modified_at:desc |
name optional | string | Dashboard's name | MyProd |
name_like optional | string | Wildcard Search for Dashboard Names | MyProd |
favorite_enabled optional | boolean | Whether it is a favorite dashboard | True |
Responses
| Name | Description | Example |
|---|
| id | Dashboard’s unique ID | b48e730a70e74f6aa3d2555000b5c22b |
| created_at | Created date time | |
| favorite_enabled | Whether it is a favorite dashboard | True |
| modified_at | Modified date time | |
| name | Dashboard’s name | Production-Web-Servers |
| type | Dashboard type | Custom |
1.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)
Parameters
| Name | Type | Description | Example |
|---|
size optional | integer | size | 20 |
page optional | integer | page | 0 |
sort optional | string | sort | created_at:desc |
ids optional | array | List of Log group IDs | 6 |
name optional | string | Log group name | testlg01 |
retention_periods optional | array | List of Log group retention periods | - |
Responses
| Name | Description | Example |
|---|
| id | Log group ID | bce52822147744b4afe0187164caa2e8 |
| account_id | Account ID | 1bcf39b344ac41cbaf0466ff0d2bebad |
| created_at | Created date time | |
| created_by | Creator ID | f4b8a4c4017f4f8d8399f0c02582ae47 |
| modified_at | Modified date time | |
| modified_by | Modifier ID | f4b8a4c4017f4f8d8399f0c02582ae47 |
| name | Log group name | testlg01 |
| retention_period | Log group retention period | 365 |
| retention_period_name | Log group retention period name | 1 year |
| status | Log group status | ACTIVE |
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)
| Version | Not Before |
|---|
| 1.1 | 20260831 |
Parameters
| Name | Type | Description | Example |
|---|
size optional | integer | size | 20 |
page optional | integer | page | 0 |
sort optional | string | sort | created_at:desc |
ids optional | array | List of Log group IDs | 6 |
name optional | string | Log group name | testlg01 |
retention_periods optional | array | List of Log group retention periods | - |
Responses
| Name | Description | Example |
|---|
| id | Log group ID | bce52822147744b4afe0187164caa2e8 |
| account_id | Account ID | 1bcf39b344ac41cbaf0466ff0d2bebad |
| created_at | Created date time | |
| created_by | Creator ID | f4b8a4c4017f4f8d8399f0c02582ae47 |
| modified_at | Modified date time | |
| modified_by | Modifier ID | f4b8a4c4017f4f8d8399f0c02582ae47 |
| name | Log group name | testlg01 |
| retention_period | Log group retention period | 365 |
| retention_period_name | Log group retention period name | 1 year |
| status | Log group status | ACTIVE |
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.
| Version | Not Before |
|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|
size optional | integer | size | 20 |
page optional | integer | page | 0 |
sort optional | string | sort | created_at:desc |
ids optional | array | List of Log group IDs | 6 |
name optional | string | Log group name | testlg01 |
retention_periods optional | array | List of Log group retention periods | - |
Responses
| Name | Description | Example |
|---|
| id | Log group ID | bce52822147744b4afe0187164caa2e8 |
| account_id | Account ID | 1bcf39b344ac41cbaf0466ff0d2bebad |
| created_at | Created date time | |
| created_by | Creator ID | f4b8a4c4017f4f8d8399f0c02582ae47 |
| modified_at | Modified date time | |
| modified_by | Modifier ID | f4b8a4c4017f4f8d8399f0c02582ae47 |
| name | Log group name | testlg01 |
| retention_period | Log group retention period | 365 |
| retention_period_name | Log group retention period name | 1 year |
| status | Log group status | ACTIVE |
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)
Parameters
| Name | Type | Description | Example |
|---|
statistic_type required | string | Metric Statistics Type | AVG |
start required | integer | Metric Start Time - Unix Timestamp | 1640995200 |
period required | integer | Statistic Period | 300 |
metrics required | array | | ```’{“dimensions”: [{“key”: “VolumeID”, “value”: “45fbde15-cdd2-4891-be31-4a9de75fccda”}], “display_name”: “Virtual Server |
end required | integer | Metric End Time - Unix Timestamp | 1640995440 |
Responses
| Name | Description | Example |
|---|
| display_name | Metric Display Name | Virtual Server |
| status | | |
| values | List of Metric Series Values | [[1640995200, “45.5”]] |
1.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)
| Version | Not Before |
|---|
| 1.1 | 20260831 |
Parameters
| Name | Type | Description | Example |
|---|
statistic_type required | string | Metric Statistics Type | AVG |
start required | integer | Metric Start Time - Unix Timestamp | 1640995200 |
period required | integer | Statistic Period | 300 |
metrics required | array | | ```’{“dimensions”: [{“key”: “VolumeID”, “value”: “45fbde15-cdd2-4891-be31-4a9de75fccda”}], “display_name”: “Virtual Server |
end required | integer | Metric End Time - Unix Timestamp | 1640995440 |
Responses
| Name | Description | Example |
|---|
| display_name | Metric Display Name | Virtual Server |
| status | | |
| values | List of Metric Series Values | [[1640995200, “45.5”]] |
1.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.
| Version | Not Before |
|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|
statistic_type required | string | Metric Statistics Type | AVG |
start required | integer | Metric Start Time - Unix Timestamp | 1640995200 |
period required | integer | Statistic Period | 300 |
metrics required | array | | ```’{“dimensions”: [{“key”: “VolumeID”, “value”: “45fbde15-cdd2-4891-be31-4a9de75fccda”}], “display_name”: “Virtual Server |
end required | integer | Metric End Time - Unix Timestamp | 1640995440 |
Responses
| Name | Description | Example |
|---|
| display_name | Metric Display Name | Virtual Server |
| status | | |
| values | List of Metric Series Values | [[1640995200, “45.5”]] |
1.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)
Parameters
| Name | Type | Description | Example |
|---|
metric_name optional | string | Metric Name | CPU Usage/Core[Basic] |
namespaces optional | array | List of Namespace | '{"dimensions": "[[\"resource_id\"]]", "name": "Virtual Server"}' |
resource_id optional | string | Resource ID | 10bf5d24-0f20-4066-bb0b-de2b1d6ff502 |
resource_name optional | string | Resource Name | VirtualServer01 |
tags optional | array | List of Tags | '{"key": "key01", "value": "value01"}' |
Responses
| Name | Description | Example |
|---|
| id | Namespace ID | d583a229-9766-4eb8-96c4-ec389902ba3d |
| dimensions | | |
| name | Namespace | Virtual Server |
| service_name | | |
1.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)
| Version | Not Before |
|---|
| 1.1 | 20260831 |
Parameters
| Name | Type | Description | Example |
|---|
metric_name optional | string | Metric Name | CPU Usage/Core[Basic] |
namespaces optional | array | List of Namespace | '{"dimensions": "[[\"resource_id\"]]", "name": "Virtual Server"}' |
resource_id optional | string | Resource ID | 10bf5d24-0f20-4066-bb0b-de2b1d6ff502 |
resource_name optional | string | Resource Name | VirtualServer01 |
tags optional | array | List of Tags | '{"key": "key01", "value": "value01"}' |
Responses
| Name | Description | Example |
|---|
| id | Namespace ID | d583a229-9766-4eb8-96c4-ec389902ba3d |
| dimensions | | |
| name | Namespace | Virtual Server |
| service_name | | |
1.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.
| Version | Not Before |
|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|
metric_name optional | string | Metric Name | CPU Usage/Core[Basic] |
namespaces optional | array | List of Namespace | '{"dimensions": "[\"resource_id\"]", "name": "Virtual Server"}' |
resource_id optional | string | Resource ID | 10bf5d24-0f20-4066-bb0b-de2b1d6ff502 |
resource_name optional | string | Resource Name | VirtualServer01 |
tags optional | array | List of Tags | '{"key": "key01", "value": "value01"}' |
Responses
| Name | Description | Example |
|---|
| id | Namespace ID | d583a229-9766-4eb8-96c4-ec389902ba3d |
| dimensions | | |
| name | Namespace | Virtual Server |
| service_name | | |
1.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)
Parameters
| Name | Type | Description | Example |
|---|
id required | string | Alert ID | 0ad6da92-634a-4f8c-932e-9d650599ab1e |
value required | string | Dimension Value | 10bf5d24-0f20-4066-bb0b-de2b1d6ff502 |
key required | string | Dimension Key | InstanceId |
statistic required | string | Statistic - SUM, AVG, MAX, MIN | AVG |
period required | integer | Period (seconds) | 300 |
operator required | string | Operator - EQ, NOT_EQ, GT, GTE, LT, LTE, RANGE | RANGE |
namespace_id required | string | Namespace ID | d583a229-9766-4eb8-96c4-ec389902ba3d |
metric_id required | string | Metric ID | d91097ac-0387-4e69-adb2-7b8d453b8db5 |
level required | string | Alert Level - HIGH, MIDDLE, LOW | HIGH |
dimensions optional | array | List of Dimensions | '{"key": "InstanceId", "value": "10bf5d24-0f20-4066-bb0b-de2b1d6ff502"}' |
evaluation_count optional | integer | Evaluation Count for the Alert Condition | 3 |
individual_items optional | array | List of Individual Items | '{"key": "VolumeID", "value": "45fbde15-cdd2-4891-be31-4a9de75fccda"}' |
lower_bound optional | number | Lower bound for the Alert range operator | 80.0 |
missing_data_option optional | **** | Missing Data Option - MISSING, BREACHING, NOT_BREACHING, IGNORE | BREACHING |
threshold optional | number | Threshold for the Alert Condition (except fro RANGE operator) | 80.0 |
upper_bound optional | number | Upper bound for the Alert range operator | 90.0 |
violation_count optional | integer | Violation Count for the Alert Condition | 2 |
Responses
| Name | Description | Example |
|---|
| key | Dimension Key | InstanceId |
| value | Dimension Value | 10bf5d24-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)
Parameters
| Name | Type | Description | Example |
|---|
id required | string | Alert ID | 0ad6da92-634a-4f8c-932e-9d650599ab1e |
activated_yn required | string | Whether the Alert is activated or not | Y |
Responses
| Name | Description | Example |
|---|
| id | Alert ID | 0ad6da92-634a-4f8c-932e-9d650599ab1e |
| activated_yn | Whether the Alert is activated or not | Y |
| modified_at | Modified date time | 2026-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)
Parameters
| Name | Type | Description | Example |
|---|
id required | string | Alert ID | 0ad6da92-634a-4f8c-932e-9d650599ab1e |
description optional | string | Alert Description | Alert1 Description |
Responses
| Name | Description | Example |
|---|
| id | Alert ID | 0ad6da92-634a-4f8c-932e-9d650599ab1e |
| description | Alert Description | Alert1 Description |
| modified_at | Modified date time | 2026-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)
Parameters
| Name | Type | Description | Example |
|---|
dashboard_id required | string | Dashboard's unique ID | b48e730a70e74f6aa3d2555000b5c22b |
name optional | string | Dashboard's name | Renamed-Dashboard |
widgets optional | array | List of widgets included in the dashboard | ```’{“height”: 1, “order”: 1, “properties”: {“metrics”: [{“color”: “#ff7f0e”, “dimensions”: [{“key”: “InstanceId”, “value”: “10bf5d24-0f20-4066-bb0b-de2b1d6ff502”}], “display_name”: “EC2-Prod-CPU”, “individual_items”: [{“key”: “BucketId”, “value”: “b-1234567890abcdef0”}], “name”: “CPUUtilization”, “namespace_name”: “Virtual Server”, “period”: 300, “statistic_type”: “AVG”}], “period”: 300, “stacked”: false, “statistic_type”: “AVG”, “title”: “Virtual Server |
1.23.2 - 1.1
scpcli servicewatch dashboard set
--dashboard_id <value>
[--name <value>]
[--widgets <value>]
Description
Set dashboard
State
ACTIVE (SUPPORTED)
| Version | Not Before |
|---|
| 1.1 | 20260831 |
Parameters
| Name | Type | Description | Example |
|---|
dashboard_id required | string | Dashboard's unique ID | b48e730a70e74f6aa3d2555000b5c22b |
name optional | string | Dashboard's name | Renamed-Dashboard |
widgets optional | array | List of widgets included in the dashboard | ```’{“height”: 1, “order”: 1, “properties”: {“metrics”: [{“color”: “#ff7f0e”, “dimensions”: [{“key”: “InstanceId”, “value”: “10bf5d24-0f20-4066-bb0b-de2b1d6ff502”}], “display_name”: “EC2-Prod-CPU”, “individual_items”: [{“key”: “BucketId”, “value”: “b-1234567890abcdef0”}], “name”: “CPUUtilization”, “namespace_name”: “Virtual Server”, “period”: 300, “statistic_type”: “AVG”}], “period”: 300, “stacked”: false, “statistic_type”: “AVG”, “title”: “Virtual Server |
1.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.
| Version | Not Before |
|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|
dashboard_id required | string | Dashboard's unique ID | b48e730a70e74f6aa3d2555000b5c22b |
name optional | string | Dashboard's name | Renamed-Dashboard |
widgets optional | array | List of widgets included in the dashboard | ```’{“height”: 1, “order”: 1, “properties”: {“metrics”: [{“color”: “#ff7f0e”, “dimensions”: [{“key”: “InstanceId”, “value”: “10bf5d24-0f20-4066-bb0b-de2b1d6ff502”}], “display_name”: “EC2-Prod-CPU”, “individual_items”: [{“key”: “BucketId”, “value”: “b-1234567890abcdef0”}], “name”: “CPUUtilization”, “namespace_name”: “Virtual Server”, “period”: 300, “statistic_type”: “AVG”}], “period”: 300, “stacked”: false, “statistic_type”: “AVG”, “title”: “Virtual Server |
1.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)
Parameters
| Name | Type | Description | Example |
|---|
event_rule_id required | string | Event rule ID | b73f95c698f540dab18860f72fafd03f |
service_id required | string | Service ID | 2778de83d7e247609445bbd570a4eba9 |
active_yn optional | **** | Whether the Event rule is active | Y |
description optional | string | Event rule description | Event rule 1 description |
event_ids optional | array | List of Event IDs | 014cb88ca2a9420e840d5c9ac16cac89 |
none_attributes optional | array | List of attributes to assign to None | description |
recipient_ids optional | array | Notification recipient IDs | 947c6a8559434505b28a5e21fff463d0 |
resource_type_id optional | string | Resource type ID | 596bf16709e84e27b7df397bf59b877c |
srn_list optional | array | List of SDS cloud Resource Names | srn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::servicewatch:event-rule/a58c8645928043a6868277c7d7fef11a |
Responses
| Name | Description | Example |
|---|
| event_rule | Event 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)
| Version | Not Before |
|---|
| 1.1 | 20260831 |
Parameters
| Name | Type | Description | Example |
|---|
event_rule_id required | string | Event rule ID | b73f95c698f540dab18860f72fafd03f |
service_id required | string | Service ID | 2778de83d7e247609445bbd570a4eba9 |
active_yn optional | **** | Whether the Event rule is active | Y |
description optional | string | Event rule description | Event rule 1 description |
event_ids optional | array | List of Event IDs | 014cb88ca2a9420e840d5c9ac16cac89 |
none_attributes optional | array | List of attributes to assign to None | description |
recipient_ids optional | array | Notification recipient IDs | 947c6a8559434505b28a5e21fff463d0 |
resource_type_id optional | string | Resource type ID | 596bf16709e84e27b7df397bf59b877c |
srn_list optional | array | List of SDS cloud Resource Names | srn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::servicewatch:event-rule/a58c8645928043a6868277c7d7fef11a |
Responses
| Name | Description | Example |
|---|
| event_rule | Event 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.
| Version | Not Before |
|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|
event_rule_id required | string | Event rule ID | b73f95c698f540dab18860f72fafd03f |
service_id required | string | Service ID | 2778de83d7e247609445bbd570a4eba9 |
active_yn optional | **** | Whether the Event rule is active | Y |
description optional | string | Event rule description | Event rule 1 description |
event_ids optional | array | List of Event IDs | 014cb88ca2a9420e840d5c9ac16cac89 |
none_attributes optional | array | List of attributes to assign to None | description |
recipient_ids optional | array | Notification recipient IDs | 947c6a8559434505b28a5e21fff463d0 |
resource_type_id optional | string | Resource type ID | 596bf16709e84e27b7df397bf59b877c |
srn_list optional | array | List of SDS cloud Resource Names | srn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::servicewatch:event-rule/a58c8645928043a6868277c7d7fef11a |
Responses
| Name | Description | Example |
|---|
| event_rule | Event 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)
Parameters
| Name | Type | Description | Example |
|---|
log_group_id required | string | Log group ID | bce52822147744b4afe0187164caa2e8 |
retention_period required | integer | Log group retention period | 365 |
Responses
| Name | Description | Example |
|---|
| log_group | Log 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)
| Version | Not Before |
|---|
| 1.1 | 20260831 |
Parameters
| Name | Type | Description | Example |
|---|
log_group_id required | string | Log group ID | bce52822147744b4afe0187164caa2e8 |
retention_period required | integer | Log group retention period | 365 |
Responses
| Name | Description | Example |
|---|
| log_group | Log 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.
| Version | Not Before |
|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|
log_group_id required | string | Log group ID | bce52822147744b4afe0187164caa2e8 |
retention_period required | integer | Log group retention period | 365 |
Responses
| Name | Description | Example |
|---|
| log_group | Log group | |
1.26 - ShowAgentDownloadLink
1.26.1 - 1.2
scpcli servicewatch show agent download link
Description
Show link to agent download
State
ACTIVE (CURRENT)
Responses
| Name | Description | Example |
|---|
| download_link | URL to download agent | https://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)
| Version | Not Before |
|---|
| 1.1 | 20260831 |
Responses
| Name | Description | Example |
|---|
| download_link | URL to download agent | https://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)
Parameters
| Name | Type | Description | Example |
|---|
id required | string | Alert ID | 0ad6da92-634a-4f8c-932e-9d650599ab1e |
Responses
| Name | Description | Example |
|---|
| key | Dimension Key | InstanceId |
| value | Dimension Value | 10bf5d24-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)
Parameters
| Name | Type | Description | Example |
|---|
dashboard_id required | string | Dashboard's unique ID | b48e730a70e74f6aa3d2555000b5c22b |
Responses
| Name | Description | Example |
|---|
| id | Widget’s unique ID | 75da70a1a4fb486ab0282cf90693ec3c |
| dashboard_id | Dashboard’s unique ID | b48e730a70e74f6aa3d2555000b5c22b |
| height | Widget’s height | 1 |
| order | Widget’s order in the dashboard | 1 |
| properties | Widget’s detailed properties | |
| type | Widget type | metric |
| width | Widget’s width | 1 |
1.28.2 - 1.1
scpcli servicewatch dashboard show
--dashboard_id <value>
Description
Show dashboard
State
ACTIVE (SUPPORTED)
| Version | Not Before |
|---|
| 1.1 | 20260831 |
Parameters
| Name | Type | Description | Example |
|---|
dashboard_id required | string | Dashboard's unique ID | b48e730a70e74f6aa3d2555000b5c22b |
Responses
| Name | Description | Example |
|---|
| id | Widget’s unique ID | 75da70a1a4fb486ab0282cf90693ec3c |
| dashboard_id | Dashboard’s unique ID | b48e730a70e74f6aa3d2555000b5c22b |
| height | Widget’s height | 1 |
| order | Widget’s order in the dashboard | 1 |
| properties | Widget’s detailed properties | |
| type | Widget type | metric |
| width | Widget’s width | 1 |
1.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.
| Version | Not Before |
|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|
dashboard_id required | string | Dashboard's unique ID | b48e730a70e74f6aa3d2555000b5c22b |
Responses
| Name | Description | Example |
|---|
| id | Widget’s unique ID | 75da70a1a4fb486ab0282cf90693ec3c |
| dashboard_id | Dashboard’s unique ID | b48e730a70e74f6aa3d2555000b5c22b |
| height | Widget’s height | 1 |
| order | Widget’s order in the dashboard | 1 |
| properties | Widget’s detailed properties | |
| type | Widget type | metric |
| width | Widget’s width | 1 |
1.29 - ShowEventRule
1.29.1 - 1.2
scpcli servicewatch eventrule show
--event_rule_id <value>
Description
Show the Event rule.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
event_rule_id required | string | Event rule ID | b73f95c698f540dab18860f72fafd03f |
Responses
| Name | Description | Example |
|---|
| event_rule | Event 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)
Parameters
| Name | Type | Description | Example |
|---|
log_group_id required | string | Log group ID | bce52822147744b4afe0187164caa2e8 |
Responses
| Name | Description | Example |
|---|
| log_group | Log 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)
Parameters
| Name | Type | Description | Example |
|---|
log_stream_id required | string | Log stream ID | b0fc99a46a2c44b8b22739b130853dd8 |
log_group_id required | string | Log group ID | bce52822147744b4afe0187164caa2e8 |
Responses
| Name | Description | Example |
|---|
| log_stream | Log stream | |