This is the multi-page printable view of this section. Click here to print.
CLIs
- 1: CreateAlert
- 2: CreateCustomLogEvents
- 3: CreateCustomLogStream
- 4: CreateCustomMetricMetas
- 5: CreateCustomMetrics
- 6: CreateDashboard
- 7: CreateEventRule
- 8: CreateLogGroup
- 9: CreateLogGroupExportTask
- 9.1: 1.4
- 10: CreateLogStream
- 11: DeleteAlerts
- 12: DeleteBulkDashboards
- 13: DeleteEventRules
- 14: DeleteLogGroups
- 15: DeleteLogStreams
- 16: DownloadMetricDataImage
- 17: GetListOfAlertNotifications
- 17.1: 1.4
- 18: GetListOfAlerts
- 18.1: 1.4
- 19: GetListOfNamespacesByAlerts
- 19.1: 1.4
- 20: ListDashboards
- 21: ListLogGroups
- 22: ListMetricData
- 23: ListMetricInfos
- 24: SetAlert
- 25: SetAlertActivated
- 26: SetAlertDescription
- 27: SetAlertNotifications
- 27.1: 1.4
- 28: SetDashboard
- 29: SetEventRule
- 30: SetLogGroup
- 31: ShowAgentDownloadLink
- 32: ShowAlert
- 33: ShowAlertLevelCountsByService
- 33.1: 1.4
- 34: ShowDashboard
- 35: ShowEventRule
- 36: ShowLogGroup
- 37: ShowLogStream
1 - CreateAlert
1.1 - 1.4
scp-cli servicewatch alert create
--value <value>
--key <value>
--statistic <value>
--period <value>
--operator <value>
--namespace_id <value>
--name <value>
--metric_id <value>
--level <value>
[--description <value>]
[--dimensions <value>]
[--evaluation_count <value>]
[--individual_items <value>]
[--lower_bound <value>]
[--missing_data_option <value>]
[--recipient_ids <value>]
[--tags <value>]
[--threshold <value>]
[--upper_bound <value>]
[--violation_count <value>]
Description
Create an Alert
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.4 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| value required | string | Dimension Value | 10bf5d24-0f20-4066-bb0b-de2b1d6ff502 |
| key required | string | Dimension Key | resource_id |
| 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 | 1d9d05af5c624f2cb80a45f2c911e2f4 |
| name required | string | Alert Name | Alert Test |
| metric_id required | string | Metric ID | f13aab3b88c341b2bc73f8925a0e8cc5 |
| level required | string | Alert Level - HIGH, MIDDLE, LOW | HIGH |
| description optional | string | Alert Description | Description for Alert Test |
| dimensions optional | array | List of Dimensions | '{"key": "resource_id", "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 | 3234bd0f12fa4d0b97ab9feff6c09b8e |
| created_at | Created date time | |
| created_by | Creator ID | f4b8a4c4017f4f8d8399f0c02582ae47 |
1.2 - 1.3
scp-cli servicewatch alert create
--value <value>
--key <value>
--statistic <value>
--period <value>
--operator <value>
--namespace_id <value>
--name <value>
--metric_id <value>
--level <value>
[--description <value>]
[--dimensions <value>]
[--evaluation_count <value>]
[--individual_items <value>]
[--lower_bound <value>]
[--missing_data_option <value>]
[--recipient_ids <value>]
[--tags <value>]
[--threshold <value>]
[--upper_bound <value>]
[--violation_count <value>]
Description
Create an Alert
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.3 | 20270131 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| value required | string | Dimension Value | 10bf5d24-0f20-4066-bb0b-de2b1d6ff502 |
| key required | string | Dimension Key | resource_id |
| 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 | 1d9d05af5c624f2cb80a45f2c911e2f4 |
| name required | string | Alert Name | Alert Test |
| metric_id required | string | Metric ID | f13aab3b88c341b2bc73f8925a0e8cc5 |
| level required | string | Alert Level - HIGH, MIDDLE, LOW | HIGH |
| description optional | string | Alert Description | Description for Alert Test |
| dimensions optional | array | List of Dimensions | '{"key": "resource_id", "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 | 3234bd0f12fa4d0b97ab9feff6c09b8e |
| created_at | Created date time | |
| created_by | Creator ID | f4b8a4c4017f4f8d8399f0c02582ae47 |
1.3 - 1.2
scp-cli servicewatch alert create
--value <value>
--key <value>
--statistic <value>
--period <value>
--operator <value>
--namespace_id <value>
--name <value>
--metric_id <value>
--level <value>
[--description <value>]
[--dimensions <value>]
[--evaluation_count <value>]
[--individual_items <value>]
[--lower_bound <value>]
[--missing_data_option <value>]
[--recipient_ids <value>]
[--tags <value>]
[--threshold <value>]
[--upper_bound <value>]
[--violation_count <value>]
Description
Create an Alert
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| value required | string | Dimension Value | 10bf5d24-0f20-4066-bb0b-de2b1d6ff502 |
| key required | string | Dimension Key | resource_id |
| 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 | 1d9d05af5c624f2cb80a45f2c911e2f4 |
| name required | string | Alert Name | Alert Test |
| metric_id required | string | Metric ID | f13aab3b88c341b2bc73f8925a0e8cc5 |
| level required | string | Alert Level - HIGH, MIDDLE, LOW | HIGH |
| description optional | string | Alert Description | Description for Alert Test |
| dimensions optional | array | List of Dimensions | '{"key": "resource_id", "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 | 3234bd0f12fa4d0b97ab9feff6c09b8e |
| created_at | Created date time | |
| created_by | Creator ID | f4b8a4c4017f4f8d8399f0c02582ae47 |
2 - CreateCustomLogEvents
2.1 - 1.4
scp-cli servicewatch logeventcustom create
--resourcelogs <value>
Description
Create Custom log events
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.4 | - |
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 |
2.2 - 1.3
scp-cli servicewatch logeventcustom create
--resourcelogs <value>
Description
Create Custom log events
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.3 | 20270131 |
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 |
2.3 - 1.2
scp-cli servicewatch logeventcustom create
--resourcelogs <value>
Description
Create Custom log events
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20261130 |
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 |
2.4 - 1.1
scp-cli servicewatch logeventcustom create
--resourcelogs <value>
Description
Create Custom log events
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| 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 |
3 - CreateCustomLogStream
3.1 - 1.4
scp-cli servicewatch logstreamcustom create
--log_stream_name <value>
--log_group_name <value>
Description
Create a custom log stream
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.4 | - |
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 |
3.2 - 1.3
scp-cli servicewatch logstreamcustom create
--log_stream_name <value>
--log_group_name <value>
Description
Create a custom log stream
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.3 | 20270131 |
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 |
3.3 - 1.2
scp-cli servicewatch logstreamcustom create
--log_stream_name <value>
--log_group_name <value>
Description
Create a custom log stream
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20261130 |
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 |
3.4 - 1.1
scp-cli servicewatch logstreamcustom create
--log_stream_name <value>
--log_group_name <value>
Description
Create a custom log stream
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| 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 |
4 - CreateCustomMetricMetas
4.1 - 1.4
scp-cli servicewatch metriccustommeta create
--namespace <value>
--metricmetas <value>
Description
Create Custom Metric Metas
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.4 | - |
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 |
|---|---|---|
| account_id | Account ID of Metrics | d79a5194b1a44a858969eb94754d3ba1 |
| max_data_points | ||
| unit_logs | [] |
4.2 - 1.3
scp-cli servicewatch metriccustommeta create
--namespace <value>
--metricmetas <value>
Description
Create Custom Metric Metas
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.3 | 20270131 |
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 |
|---|---|---|
| account_id | Account ID of Metrics | d79a5194b1a44a858969eb94754d3ba1 |
| max_data_points | ||
| unit_logs | [] |
4.3 - 1.2
scp-cli servicewatch metriccustommeta create
--namespace <value>
--metricmetas <value>
Description
Create Custom Metric Metas
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20261130 |
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 |
|---|---|---|
| account_id | Account ID of Metrics | d79a5194b1a44a858969eb94754d3ba1 |
| max_data_points | ||
| unit_logs | [] |
4.4 - 1.1
scp-cli servicewatch metriccustommeta create
--namespace <value>
--metricmetas <value>
Description
Create Custom Metric Metas
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| 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 |
|---|---|---|
| account_id | Account ID of Metrics | d79a5194b1a44a858969eb94754d3ba1 |
| max_data_points | ||
| unit_logs | [] |
5 - CreateCustomMetrics
5.1 - 1.4
scp-cli servicewatch metriccustom create
--resource_metrics <value>
Description
Create Custom Metrics. The request body of this API can receive data in either camelCase or snake_case.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.4 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| resource_metrics required | array | The resourceMetrics field holds a set of all metric data associated with a specific resource | '{"resource": {"attributes": [{"key": "", "value": {"array_value": "", "bool_value": "", "byte_value": "", "double_value": "", "int_value": "", "kvlist_value": "", "string_value": ""}}]}, "scope_metrics": [{"metrics": [{"description": "The total number of bytes read successfully.", "gauge": {"data_points": [{"as_double": 0.75, "as_int": 10, "attributes": [{"key": "", "value": {"array_value": "", "bool_value": "", "byte_value": "", "double_value": "", "int_value": "", "kvlist_value": "", "string_value": ""}}], "start_time_unix_nano": "1753776789854000000", "time_unix_nano": "1753776789854000000"}]}, "name": "node_disk_read_bytes_total", "sum": {"aggregation_temporality": "2", "data_points": [{"as_double": 0.75, "as_int": 10, "attributes": [{"key": "", "value": {"array_value": "", "bool_value": "", "byte_value": "", "double_value": "", "int_value": "", "kvlist_value": "", "string_value": ""}}], "start_time_unix_nano": "1753776789854000000", "time_unix_nano": "1753776789854000000"}], "is_monotonic": true}, "unit": "Bytes"}], "scope": {"name": "ServiceWatch-Agent", "version": "1.0.0"}}]}' |
Responses
| Name | Description | Example |
|---|
5.2 - 1.3
scp-cli servicewatch metriccustom create
--resource_metrics <value>
Description
Create Custom Metrics. The request body of this API can receive data in either camelCase or snake_case.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.3 | 20270131 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| resource_metrics required | array | The resourceMetrics field holds a set of all metric data associated with a specific resource | '{"resource": {"attributes": [{"key": "", "value": {"array_value": "", "bool_value": "", "byte_value": "", "double_value": "", "int_value": "", "kvlist_value": "", "string_value": ""}}]}, "scope_metrics": [{"metrics": [{"description": "The total number of bytes read successfully.", "gauge": {"data_points": [{"as_double": 0.75, "as_int": 10, "attributes": [{"key": "", "value": {"array_value": "", "bool_value": "", "byte_value": "", "double_value": "", "int_value": "", "kvlist_value": "", "string_value": ""}}], "start_time_unix_nano": "1753776789854000000", "time_unix_nano": "1753776789854000000"}]}, "name": "node_disk_read_bytes_total", "sum": {"aggregation_temporality": "2", "data_points": [{"as_double": 0.75, "as_int": 10, "attributes": [{"key": "", "value": {"array_value": "", "bool_value": "", "byte_value": "", "double_value": "", "int_value": "", "kvlist_value": "", "string_value": ""}}], "start_time_unix_nano": "1753776789854000000", "time_unix_nano": "1753776789854000000"}], "is_monotonic": true}, "unit": "Bytes"}], "scope": {"name": "ServiceWatch-Agent", "version": "1.0.0"}}]}' |
Responses
| Name | Description | Example |
|---|
5.3 - 1.2
scp-cli servicewatch metriccustom create
--resource_metrics <value>
Description
Create Custom Metrics. The request body of this API can receive data in either camelCase or snake_case.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| resource_metrics required | array | The resourceMetrics field holds a set of all metric data associated with a specific resource | '{"resource": {"attributes": [{"key": "", "value": {"array_value": "", "bool_value": "", "byte_value": "", "double_value": "", "int_value": "", "kvlist_value": "", "string_value": ""}}]}, "scope_metrics": [{"metrics": [{"description": "The total number of bytes read successfully.", "gauge": {"data_points": [{"as_double": 0.75, "as_int": 10, "attributes": [{"key": "", "value": {"array_value": "", "bool_value": "", "byte_value": "", "double_value": "", "int_value": "", "kvlist_value": "", "string_value": ""}}], "start_time_unix_nano": "1753776789854000000", "time_unix_nano": "1753776789854000000"}]}, "name": "node_disk_read_bytes_total", "sum": {"aggregation_temporality": "2", "data_points": [{"as_double": 0.75, "as_int": 10, "attributes": [{"key": "", "value": {"array_value": "", "bool_value": "", "byte_value": "", "double_value": "", "int_value": "", "kvlist_value": "", "string_value": ""}}], "start_time_unix_nano": "1753776789854000000", "time_unix_nano": "1753776789854000000"}], "is_monotonic": true}, "unit": "Bytes"}], "scope": {"name": "ServiceWatch-Agent", "version": "1.0.0"}}]}' |
Responses
| Name | Description | Example |
|---|
5.4 - 1.1
scp-cli servicewatch metriccustom create
--resource_metrics <value>
Description
Create Custom Metrics. The request body of this API can receive data in either camelCase or snake_case.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| 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
| Name | Description | Example |
|---|
6 - CreateDashboard
6.1 - 1.4
scp-cli servicewatch dashboard create
--name <value>
[--widgets <value>]
Description
Create dashboard
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.4 | - |
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”: “resource_id”, “value”: “10bf5d24-0f20-4066-bb0b-de2b1d6ff502”}], “display_name”: “EC2-Prod-CPU”, “individual_items”: [{“key”: “BucketId”, “value”: “b-1234567890abcdef0”}], “name”: “CPUUtilization”, “namespace_name”: “Virtual Server”, “period”: 300, “statistic_type”: “AVG”}], “period”: 300, “stacked”: false, “statistic_type”: “AVG”, “title”: “Virtual Server |
Responses
| Name | Description | Example |
|---|---|---|
| id | Dashboard’s unique ID | b48e730a70e74f6aa3d2555000b5c22b |
| alerts | Alert information related to the dashboard | {} |
| created_at | Created date time | |
| created_by | Creator ID | user-xxxxxxxx |
| favorite_enabled | Whether it is a favorite dashboard | True |
| modified_at | Modified date time | |
| modified_by | Modifier ID | user-yyyyyyyy |
| name | Dashboard’s name | Production-Web-Servers |
| product_name | Associated resource type | ServiceWatch |
| resource_id | Associated resource ID | c8e41e595ad040a8abe57e2ffc109113 |
| resource_name | Associated resource name | Production-Web-Servers |
| resource_type | Associated resource type | dashboard |
| service_code | Associated service code | virtualserver |
| share_type | Sharing type | Private |
| srn | Service resource name (SRN) | srn:vs:kr-central-1:123456789012:instance/c8e41e595ad040a8abe57e2ffc109113 |
| type | Dashboard type | Custom |
| widgets | List of widgets included in the dashboard | [] |
6.2 - 1.3
scp-cli servicewatch dashboard create
--name <value>
[--widgets <value>]
Description
Create dashboard
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.3 | 20270131 |
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”: “resource_id”, “value”: “10bf5d24-0f20-4066-bb0b-de2b1d6ff502”}], “display_name”: “EC2-Prod-CPU”, “individual_items”: [{“key”: “BucketId”, “value”: “b-1234567890abcdef0”}], “name”: “CPUUtilization”, “namespace_name”: “Virtual Server”, “period”: 300, “statistic_type”: “AVG”}], “period”: 300, “stacked”: false, “statistic_type”: “AVG”, “title”: “Virtual Server |
Responses
| Name | Description | Example |
|---|---|---|
| id | Dashboard’s unique ID | b48e730a70e74f6aa3d2555000b5c22b |
| alerts | Alert information related to the dashboard | {} |
| created_at | Created date time | |
| created_by | Creator ID | user-xxxxxxxx |
| favorite_enabled | Whether it is a favorite dashboard | True |
| modified_at | Modified date time | |
| modified_by | Modifier ID | user-yyyyyyyy |
| name | Dashboard’s name | Production-Web-Servers |
| product_name | Associated resource type | ServiceWatch |
| resource_id | Associated resource ID | c8e41e595ad040a8abe57e2ffc109113 |
| resource_name | Associated resource name | Production-Web-Servers |
| resource_type | Associated resource type | dashboard |
| service_code | Associated service code | virtualserver |
| share_type | Sharing type | Private |
| srn | Service resource name (SRN) | srn:vs:kr-central-1:123456789012:instance/c8e41e595ad040a8abe57e2ffc109113 |
| type | Dashboard type | Custom |
| widgets | List of widgets included in the dashboard | [] |
6.3 - 1.2
scp-cli servicewatch dashboard create
--name <value>
[--widgets <value>]
Description
Create dashboard
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20261130 |
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”: “resource_id”, “value”: “10bf5d24-0f20-4066-bb0b-de2b1d6ff502”}], “display_name”: “EC2-Prod-CPU”, “individual_items”: [{“key”: “BucketId”, “value”: “b-1234567890abcdef0”}], “name”: “CPUUtilization”, “namespace_name”: “Virtual Server”, “period”: 300, “statistic_type”: “AVG”}], “period”: 300, “stacked”: false, “statistic_type”: “AVG”, “title”: “Virtual Server |
Responses
| Name | Description | Example |
|---|---|---|
| id | Dashboard’s unique ID | b48e730a70e74f6aa3d2555000b5c22b |
| alerts | Alert information related to the dashboard | {} |
| created_at | Created date time | |
| created_by | Creator ID | user-xxxxxxxx |
| favorite_enabled | Whether it is a favorite dashboard | True |
| modified_at | Modified date time | |
| modified_by | Modifier ID | user-yyyyyyyy |
| name | Dashboard’s name | Production-Web-Servers |
| product_name | Associated resource type | ServiceWatch |
| resource_id | Associated resource ID | c8e41e595ad040a8abe57e2ffc109113 |
| resource_name | Associated resource name | Production-Web-Servers |
| resource_type | Associated resource type | dashboard |
| service_code | Associated service code | virtualserver |
| share_type | Sharing type | Private |
| srn | Service resource name (SRN) | srn:vs:kr-central-1:123456789012:instance/c8e41e595ad040a8abe57e2ffc109113 |
| type | Dashboard type | Custom |
| widgets | List of widgets included in the dashboard | [] |
6.4 - 1.1
scp-cli servicewatch dashboard create
--name <value>
[--widgets <value>]
Description
Create dashboard
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| 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”: “resource_id”, “value”: “10bf5d24-0f20-4066-bb0b-de2b1d6ff502”}], “display_name”: “EC2-Prod-CPU”, “individual_items”: [{“key”: “BucketId”, “value”: “b-1234567890abcdef0”}], “name”: “CPUUtilization”, “namespace_name”: “Virtual Server”, “period”: 300, “statistic_type”: “AVG”}], “period”: 300, “stacked”: false, “statistic_type”: “AVG”, “title”: “Virtual Server |
Responses
| Name | Description | Example |
|---|---|---|
| id | Dashboard’s unique ID | b48e730a70e74f6aa3d2555000b5c22b |
| alerts | Alert information related to the dashboard | {} |
| created_at | Created date time | |
| created_by | Creator ID | user-xxxxxxxx |
| favorite_enabled | Whether it is a favorite dashboard | True |
| modified_at | Modified date time | |
| modified_by | Modifier ID | user-yyyyyyyy |
| name | Dashboard’s name | Production-Web-Servers |
| product_name | Associated resource type | ServiceWatch |
| resource_id | Associated resource ID | c8e41e595ad040a8abe57e2ffc109113 |
| resource_name | Associated resource name | Production-Web-Servers |
| resource_type | Associated resource type | dashboard |
| service_code | Associated service code | virtualserver |
| share_type | Sharing type | Private |
| srn | Service resource name (SRN) | srn:vs:kr-central-1:123456789012:instance/c8e41e595ad040a8abe57e2ffc109113 |
| type | Dashboard type | Custom |
| widgets | List of widgets included in the dashboard | [] |
6.5 - 1.0
scp-cli servicewatch dashboard create
--name <value>
[--widgets <value>]
Description
Create dashboard
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| 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”: “resource_id”, “value”: “10bf5d24-0f20-4066-bb0b-de2b1d6ff502”}], “display_name”: “EC2-Prod-CPU”, “individual_items”: [{“key”: “BucketId”, “value”: “b-1234567890abcdef0”}], “name”: “CPUUtilization”, “namespace_name”: “Virtual Server”, “period”: 300, “statistic_type”: “AVG”}], “period”: 300, “stacked”: false, “statistic_type”: “AVG”, “title”: “Virtual Server |
Responses
| Name | Description | Example |
|---|---|---|
| id | Dashboard’s unique ID | b48e730a70e74f6aa3d2555000b5c22b |
| alerts | Alert information related to the dashboard | {} |
| created_at | Created date time | |
| created_by | Creator ID | user-xxxxxxxx |
| favorite_enabled | Whether it is a favorite dashboard | True |
| modified_at | Modified date time | |
| modified_by | Modifier ID | user-yyyyyyyy |
| name | Dashboard’s name | Production-Web-Servers |
| product_name | Associated resource type | ServiceWatch |
| resource_id | Associated resource ID | c8e41e595ad040a8abe57e2ffc109113 |
| resource_name | Associated resource name | Production-Web-Servers |
| resource_type | Associated resource type | dashboard |
| share_type | Sharing type | Private |
| srn | Service resource name (SRN) | srn:vs:kr-central-1:123456789012:instance/c8e41e595ad040a8abe57e2ffc109113 |
| type | Dashboard type | Custom |
| widgets | List of widgets included in the dashboard | [] |
7 - CreateEventRule
7.1 - 1.4
scp-cli servicewatch eventrule create
--service_id <value>
--name <value>
[--description <value>]
[--event_ids <value>]
[--recipient_ids <value>]
[--resource_type_id <value>]
[--srn_list <value>]
[--tags <value>]
Description
Create an Event rule.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.4 | - |
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 |
7.2 - 1.3
scp-cli servicewatch eventrule create
--service_id <value>
--name <value>
[--description <value>]
[--event_ids <value>]
[--recipient_ids <value>]
[--resource_type_id <value>]
[--srn_list <value>]
[--tags <value>]
Description
Create an Event rule.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.3 | 20270131 |
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 |
7.3 - 1.2
scp-cli servicewatch eventrule create
--service_id <value>
--name <value>
[--description <value>]
[--event_ids <value>]
[--recipient_ids <value>]
[--resource_type_id <value>]
[--srn_list <value>]
[--tags <value>]
Description
Create an Event rule.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20261130 |
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 |
7.4 - 1.1
scp-cli servicewatch eventrule create
--service_id <value>
--name <value>
[--description <value>]
[--event_ids <value>]
[--recipient_ids <value>]
[--resource_type_id <value>]
[--srn_list <value>]
[--tags <value>]
Description
Create an Event rule.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| 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 |
7.5 - 1.0
scp-cli servicewatch eventrule create
--service_id <value>
--name <value>
[--description <value>]
[--event_ids <value>]
[--recipient_ids <value>]
[--resource_type_id <value>]
[--srn_list <value>]
[--tags <value>]
Description
Create an Event rule.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| 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 |
8 - CreateLogGroup
8.1 - 1.4
scp-cli servicewatch loggroup create
--retention_period <value>
--name <value>
[--tags <value>]
Description
Create a Log group.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.4 | - |
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 |
8.2 - 1.3
scp-cli servicewatch loggroup create
--retention_period <value>
--name <value>
[--tags <value>]
Description
Create a Log group.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.3 | 20270131 |
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 |
8.3 - 1.2
scp-cli servicewatch loggroup create
--retention_period <value>
--name <value>
[--tags <value>]
Description
Create a Log group.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20261130 |
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 |
8.4 - 1.1
scp-cli servicewatch loggroup create
--retention_period <value>
--name <value>
[--tags <value>]
Description
Create a Log group.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| 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 |
8.5 - 1.0
scp-cli servicewatch loggroup create
--retention_period <value>
--name <value>
[--tags <value>]
Description
Create a Log group.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| 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 |
9 - CreateLogGroupExportTask
9.1 - 1.4
scp-cli servicewatch loggroupexport create
--start_at <value>
--log_stream_ids <value>
--log_group_id <value>
--end_at <value>
--bucket_name <value>
Description
Create a Log group export task.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.4 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| start_at required | string | Start datetime | - |
| log_stream_ids required | array | List of Log stream IDs | - |
| log_group_id required | string | Log group ID | - |
| end_at required | string | End datetime | - |
| bucket_name required | string | Log group export task bucket name | - |
Responses
| Name | Description | Example |
|---|---|---|
| log_group_export | Log group export task |
10 - CreateLogStream
10.1 - 1.4
scp-cli servicewatch logstream create
--log_group_id <value>
--name <value>
Description
Create a Log group log stream.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.4 | - |
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 |
10.2 - 1.3
scp-cli servicewatch logstream create
--log_group_id <value>
--name <value>
Description
Create a Log group log stream.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.3 | 20270131 |
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 |
10.3 - 1.2
scp-cli servicewatch logstream create
--log_group_id <value>
--name <value>
Description
Create a Log group log stream.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20261130 |
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 |
10.4 - 1.1
scp-cli servicewatch logstream create
--log_group_id <value>
--name <value>
Description
Create a Log group log stream.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| 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 |
10.5 - 1.0
scp-cli servicewatch logstream create
--log_group_id <value>
--name <value>
Description
Create a Log group log stream.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| 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 |
11 - DeleteAlerts
11.1 - 1.4
scp-cli servicewatch alert delete-bulk
--ids <value>
Description
Delete Alerts
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.4 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| ids required | array | List of Alert IDs | 3234bd0f12fa4d0b97ab9feff6c09b8e |
11.2 - 1.3
scp-cli servicewatch alert delete-bulk
--ids <value>
Description
Delete Alerts
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.3 | 20270131 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| ids required | array | List of Alert IDs | 3234bd0f12fa4d0b97ab9feff6c09b8e |
11.3 - 1.2
scp-cli servicewatch alert delete-bulk
--ids <value>
Description
Delete Alerts
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| ids required | array | List of Alert IDs | 3234bd0f12fa4d0b97ab9feff6c09b8e |
12 - DeleteBulkDashboards
12.1 - 1.4
scp-cli servicewatch dashboard delete
--dashboard_ids <value>
Description
Delete bulk dashboards
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.4 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| dashboard_ids required | array | List of dashboard IDs | b48e730a70e74f6aa3d2555000b5c22b |
12.2 - 1.3
scp-cli servicewatch dashboard delete
--dashboard_ids <value>
Description
Delete bulk dashboards
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.3 | 20270131 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| dashboard_ids required | array | List of dashboard IDs | b48e730a70e74f6aa3d2555000b5c22b |
12.3 - 1.2
scp-cli servicewatch dashboard delete
--dashboard_ids <value>
Description
Delete bulk dashboards
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| dashboard_ids required | array | List of dashboard IDs | b48e730a70e74f6aa3d2555000b5c22b |
12.4 - 1.1
scp-cli servicewatch dashboard delete
--dashboard_ids <value>
Description
Delete bulk dashboards
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260831 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| dashboard_ids required | array | List of dashboard IDs | b48e730a70e74f6aa3d2555000b5c22b |
12.5 - 1.0
scp-cli servicewatch dashboard delete
--dashboard_ids <value>
Description
Delete bulk dashboards
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| dashboard_ids required | array | List of dashboard IDs | b48e730a70e74f6aa3d2555000b5c22b |
13 - DeleteEventRules
13.1 - 1.4
scp-cli servicewatch eventrule delete-bulk
--ids <value>
Description
Delete Event rules.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.4 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| ids required | array | List of Event rule IDs | 66d77b4e32d04558b2382b1d14765d86 |
13.2 - 1.3
scp-cli servicewatch eventrule delete-bulk
--ids <value>
Description
Delete Event rules.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.3 | 20270131 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| ids required | array | List of Event rule IDs | 66d77b4e32d04558b2382b1d14765d86 |
13.3 - 1.2
scp-cli servicewatch eventrule delete-bulk
--ids <value>
Description
Delete Event rules.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| ids required | array | List of Event rule IDs | 66d77b4e32d04558b2382b1d14765d86 |
13.4 - 1.1
scp-cli servicewatch eventrule delete-bulk
--ids <value>
Description
Delete Event rules.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260831 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| ids required | array | List of Event rule IDs | 66d77b4e32d04558b2382b1d14765d86 |
13.5 - 1.0
scp-cli servicewatch eventrule delete-bulk
--ids <value>
Description
Delete Event rules.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| ids required | array | List of Event rule IDs | 66d77b4e32d04558b2382b1d14765d86 |
14 - DeleteLogGroups
14.1 - 1.4
scp-cli servicewatch loggroup delete-bulk
--ids <value>
Description
Delete Log groups.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.4 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| ids required | array | List of Log group IDs | 602b39cb1d6b4b7fb0f18de43a4c689c |
14.2 - 1.3
scp-cli servicewatch loggroup delete-bulk
--ids <value>
Description
Delete Log groups.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.3 | 20270131 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| ids required | array | List of Log group IDs | 602b39cb1d6b4b7fb0f18de43a4c689c |
14.3 - 1.2
scp-cli servicewatch loggroup delete-bulk
--ids <value>
Description
Delete Log groups.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| ids required | array | List of Log group IDs | 602b39cb1d6b4b7fb0f18de43a4c689c |
14.4 - 1.1
scp-cli servicewatch loggroup delete-bulk
--ids <value>
Description
Delete Log groups.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260831 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| ids required | array | List of Log group IDs | 602b39cb1d6b4b7fb0f18de43a4c689c |
14.5 - 1.0
scp-cli servicewatch loggroup delete-bulk
--ids <value>
Description
Delete Log groups.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| ids required | array | List of Log group IDs | 602b39cb1d6b4b7fb0f18de43a4c689c |
15 - DeleteLogStreams
15.1 - 1.4
scp-cli servicewatch logstream delete-bulk
--log_group_id <value>
--ids <value>
Description
Delete Log group log streams.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.4 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| log_group_id required | string | Log group ID | bce52822147744b4afe0187164caa2e8 |
| ids required | array | List of Log stream IDs | b0fc99a46a2c44b8b22739b130853dd8 |
15.2 - 1.3
scp-cli servicewatch logstream delete-bulk
--log_group_id <value>
--ids <value>
Description
Delete Log group log streams.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.3 | 20270131 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| log_group_id required | string | Log group ID | bce52822147744b4afe0187164caa2e8 |
| ids required | array | List of Log stream IDs | b0fc99a46a2c44b8b22739b130853dd8 |
15.3 - 1.2
scp-cli servicewatch logstream delete-bulk
--log_group_id <value>
--ids <value>
Description
Delete Log group log streams.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| log_group_id required | string | Log group ID | bce52822147744b4afe0187164caa2e8 |
| ids required | array | List of Log stream IDs | b0fc99a46a2c44b8b22739b130853dd8 |
15.4 - 1.1
scp-cli servicewatch logstream delete-bulk
--log_group_id <value>
--ids <value>
Description
Delete Log group log streams.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| 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 |
15.5 - 1.0
scp-cli servicewatch logstream delete-bulk
--log_group_id <value>
--ids <value>
Description
Delete Log group log streams.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| 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 |
16 - DownloadMetricDataImage
16.1 - 1.4
scp-cli servicewatch metricdataimage list
--statistic_type <value>
--start <value>
--period <value>
--metrics <value>
--end <value>
[--height <value>]
[--timezone <value>]
[--title <value>]
[--width <value>]
Description
Download metric data image
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.4 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| statistic_type required | string | Metric Statistics Type | AVG |
| start required | integer | Metric Start Time - Unix Timestamp | 1640995200 |
| period required | integer | Statistic Period | 300 |
| metrics required | array | ```’{“color”: “#0000ff”, “dimensions”: [{“key”: “VolumeID”, “value”: “45fbde15-cdd2-4891-be31-4a9de75fccda”}], “display_name”: “Virtual Server | |
| end required | integer | Metric End Time - Unix Timestamp | 1640995440 |
| height optional | integer | Chart Image Height(pixels) | 400 |
| timezone optional | string | Timezone | UTC |
| title optional | string | Chart Title | Virtual Server Metric Chart |
| width optional | integer | Chart Image Width(pixels) | 600 |
Responses
| Name | Description | Example |
|---|
16.2 - 1.3
scp-cli servicewatch metricdataimage list
--statistic_type <value>
--start <value>
--period <value>
--metrics <value>
--end <value>
[--height <value>]
[--timezone <value>]
[--title <value>]
[--width <value>]
Description
Download metric data image
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.3 | 20270131 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| statistic_type required | string | Metric Statistics Type | AVG |
| start required | integer | Metric Start Time - Unix Timestamp | 1640995200 |
| period required | integer | Statistic Period | 300 |
| metrics required | array | ```’{“color”: “#0000ff”, “dimensions”: [{“key”: “VolumeID”, “value”: “45fbde15-cdd2-4891-be31-4a9de75fccda”}], “display_name”: “Virtual Server | |
| end required | integer | Metric End Time - Unix Timestamp | 1640995440 |
| height optional | integer | Chart Image Height(pixels) | 400 |
| timezone optional | string | Timezone | UTC |
| title optional | string | Chart Title | Virtual Server Metric Chart |
| width optional | integer | Chart Image Width(pixels) | 600 |
Responses
| Name | Description | Example |
|---|
16.3 - 1.2
scp-cli servicewatch metricdataimage list
--statistic_type <value>
--start <value>
--period <value>
--metrics <value>
--end <value>
[--height <value>]
[--timezone <value>]
[--title <value>]
[--width <value>]
Description
Download metric data image
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| statistic_type required | string | Metric Statistics Type | AVG |
| start required | integer | Metric Start Time - Unix Timestamp | 1640995200 |
| period required | integer | Statistic Period | 300 |
| metrics required | array | ```’{“color”: “#0000ff”, “dimensions”: [{“key”: “VolumeID”, “value”: “45fbde15-cdd2-4891-be31-4a9de75fccda”}], “display_name”: “Virtual Server | |
| end required | integer | Metric End Time - Unix Timestamp | 1640995440 |
| height optional | integer | Chart Image Height(pixels) | 400 |
| timezone optional | string | Timezone | UTC |
| title optional | string | Chart Title | Virtual Server Metric Chart |
| width optional | integer | Chart Image Width(pixels) | 600 |
Responses
| Name | Description | Example |
|---|
16.4 - 1.1
scp-cli servicewatch metricdataimage list
--statistic_type <value>
--start <value>
--period <value>
--metrics <value>
--end <value>
[--height <value>]
[--timezone <value>]
[--title <value>]
[--width <value>]
Description
Download metric data image
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| 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
| Name | Description | Example |
|---|
16.5 - 1.0
scp-cli servicewatch metricdataimage list
--statistic_type <value>
--start <value>
--period <value>
--metrics <value>
--end <value>
[--height <value>]
[--timezone <value>]
[--title <value>]
[--width <value>]
Description
Download metric data image
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| 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
| Name | Description | Example |
|---|
17 - GetListOfAlertNotifications
17.1 - 1.4
scp-cli servicewatch alert-notification list
--id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--user_name <value>]
Description
Get list of Alert notifications
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.4 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| id required | string | Alert ID | 3234bd0f12fa4d0b97ab9feff6c09b8e |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| user_name optional | string | User name | 홍길동 |
Responses
| Name | Description | Example |
|---|---|---|
| id | ||
| activated_yn | ||
| alert_id | ||
| created_at | ||
| created_by | ||
| last_login_at | ||
| modified_at | ||
| modified_by | ||
| user_created_at | ||
| user_id | ||
| user_name |
18 - GetListOfAlerts
18.1 - 1.4
scp-cli servicewatch alert list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--activated_yn <value>]
[--states <value>]
[--levels <value>]
[--from_last_policy_updated_at <value>]
[--to_last_policy_updated_at <value>]
[--namespace_ids <value>]
[--namespace_names <value>]
[--type <value>]
Description
Get list of Alerts
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.4 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | Alert Name | Alert Test |
| activated_yn optional | **** | Whether the Alert is activated or not | Y |
| states optional | string | Alert State - NORMAL, ALERT, INSUFFICIENT_DATA | NORMAL,ALERT |
| levels optional | string | Alert Level - HIGH, MIDDLE, LOW | HIGH,MIDDLE |
| from_last_policy_updated_at optional | string | Alert Start Last Policy Updated Date Time | 2026-04-01T00:00:00+09:00 |
| to_last_policy_updated_at optional | string | Alert End Last Policy Updated Date Time | 2026-04-30T23:59:59+09:00 |
| namespace_ids optional | string | Comma-separated namespace IDs | 1d9d05af5c624f2cb80a45f2c911e2f4,6b6c3239f0504e30b067fe9498be1681 |
| namespace_names optional | string | Comma-separated namespace names | Virtual Server,Internet Gateway |
| type optional | string | Alert Type | METRIC_ALERT |
Responses
| Name | Description | Example |
|---|---|---|
| id | Alert ID | 3234bd0f12fa4d0b97ab9feff6c09b8e |
| activated_yn | Whether the Alert is activated or not | Y |
| evaluation_time_window | Evaluation Time Window (period * evaluation_count) | 900 |
| last_policy_updated_at | Last Alert Policy Updated Date Time | 2026-06-24T10:14:52.700924 |
| level | Alert Level - HIGH, MIDDLE, LOW | HIGH |
| lower_bound | Lower bound for the Alert range operator | 80.0 |
| metric_name | Metric Name | CPU Usage |
| metric_unit | Metric Unit. Allowed Units: SECONDS, MICROSECONDS, MILLISECONDS, BYTES, KILOBYTES, MEGABYTES, GIGABYTES, TERABYTES, BITS, KILOBITS, MEGABITS, GIGABITS, TERABITS, PERCENT, COUNT, BYTES_PER_SECOND, KILOBYTES_PER_SECOND, MEGABYTES_PER_SECOND, GIGABYTES_PER_SECOND, TERABYTES_PER_SECOND, BITS_PER_SECOND, KILOBITS_PER_SECOND, MEGABITS_PER_SECOND, GIGABITS_PER_SECOND, TERABITS_PER_SECOND, COUNT_PER_SECOND, COUNT_PER_MINUTE, NONE | BYTE |
| name | Alert Name | Alert Test |
| namespace_name | Namespace Name | Virtual Server |
| operator | Operator - EQ, NOT_EQ, GT, GTE, LT, LTE, RANGE | RANGE |
| state | Alert State - NORMAL, ALERT, INSUFFICIENT_DATA | NORMAL |
| statistic | Statistic - SUM, AVG, MAX, MIN | AVG |
| threshold | Threshold for the Alert Condition (except fro RANGE operator) | 80.0 |
| type | Alert Type | METRIC_ALERT |
| upper_bound | Upper bound for the Alert range operator | 90.0 |
19 - GetListOfNamespacesByAlerts
19.1 - 1.4
scp-cli servicewatch alert-namespace list
Description
Get list of Namespaces by alerts
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.4 | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Namespace ID | 1d9d05af5c624f2cb80a45f2c911e2f4 |
| created_at | Created date time | |
| created_by | Creator ID | f4b8a4c4017f4f8d8399f0c02582ae47 |
| description | Description of Namespace | 이것은 Virtual Server에 대한 설명입니다. |
| modified_at | Modified date time | |
| modified_by | Modifier ID | f4b8a4c4017f4f8d8399f0c02582ae47 |
| name | Namespace Name | Virtual Server |
| region_id | Region Name | kr-west1 |
| service_id | Service ID |
20 - ListDashboards
20.1 - 1.4
scp-cli servicewatch dashboard list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--name_like <value>]
[--favorite_enabled <value>]
[--type <value>]
[--service_code <value>]
[--namespace_code <value>]
Description
Get list of dashboards
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.4 | - |
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 |
| namespace_code optional | string | Associated namespace 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 |
| namespace_code | Associated namespace code | virtualserver |
| service_code | Associated service code | virtualserver |
| type | Dashboard type | Custom |
20.2 - 1.3
scp-cli servicewatch dashboard list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--name_like <value>]
[--favorite_enabled <value>]
[--type <value>]
[--service_code <value>]
Description
Get list of dashboards
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.3 | 20270131 |
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 |
| namespace_code | Associated namespace code | virtualserver |
| service_code | Associated service code | virtualserver |
| type | Dashboard type | Custom |
20.3 - 1.2
scp-cli servicewatch dashboard list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--name_like <value>]
[--favorite_enabled <value>]
[--type <value>]
[--service_code <value>]
Description
Get list of dashboards
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20261130 |
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 |
| namespace_code | Associated namespace code | virtualserver |
| service_code | Associated service code | virtualserver |
| type | Dashboard type | Custom |
20.4 - 1.1
scp-cli servicewatch dashboard list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--name_like <value>]
[--favorite_enabled <value>]
Description
Get list of dashboards
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| 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 |
| namespace_code | Associated namespace code | virtualserver |
| service_code | Associated service code | virtualserver |
| type | Dashboard type | Custom |
20.5 - 1.0
scp-cli servicewatch dashboard list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--name_like <value>]
[--favorite_enabled <value>]
Description
Get list of dashboards
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| 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 |
| namespace_code | Associated namespace code | virtualserver |
| service_code | Associated service code | virtualserver |
| type | Dashboard type | Custom |
21 - ListLogGroups
21.1 - 1.4
scp-cli servicewatch loggroup list
[--size <value>]
[--page <value>]
[--sort <value>]
[--ids <value>]
[--name <value>]
[--retention_periods <value>]
Description
Get list of Log groups.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.4 | - |
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 |
21.2 - 1.3
scp-cli servicewatch loggroup list
[--size <value>]
[--page <value>]
[--sort <value>]
[--ids <value>]
[--name <value>]
[--retention_periods <value>]
Description
Get list of Log groups.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.3 | 20270131 |
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 |
21.3 - 1.2
scp-cli servicewatch loggroup list
[--size <value>]
[--page <value>]
[--sort <value>]
[--ids <value>]
[--name <value>]
[--retention_periods <value>]
Description
Get list of Log groups.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20261130 |
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 |
21.4 - 1.1
scp-cli servicewatch loggroup list
[--size <value>]
[--page <value>]
[--sort <value>]
[--ids <value>]
[--name <value>]
[--retention_periods <value>]
Description
Get list of Log groups.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| 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 |
21.5 - 1.0
scp-cli servicewatch loggroup list
[--size <value>]
[--page <value>]
[--sort <value>]
[--ids <value>]
[--name <value>]
[--retention_periods <value>]
Description
Get list of Log groups.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| 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 |
22 - ListMetricData
22.1 - 1.4
scp-cli servicewatch metricdata list
--statistic_type <value>
--start <value>
--period <value>
--metrics <value>
--end <value>
Description
Get metric data list
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.4 | - |
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”]] |
22.2 - 1.3
scp-cli servicewatch metricdata list
--statistic_type <value>
--start <value>
--period <value>
--metrics <value>
--end <value>
Description
Get metric data list
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.3 | 20270131 |
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”]] |
22.3 - 1.2
scp-cli servicewatch metricdata list
--statistic_type <value>
--start <value>
--period <value>
--metrics <value>
--end <value>
Description
Get metric data list
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20261130 |
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”]] |
22.4 - 1.1
scp-cli servicewatch metricdata list
--statistic_type <value>
--start <value>
--period <value>
--metrics <value>
--end <value>
Description
Get metric data list
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| 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”]] |
22.5 - 1.0
scp-cli servicewatch metricdata list
--statistic_type <value>
--start <value>
--period <value>
--metrics <value>
--end <value>
Description
Get metric data list
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| 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”]] |
23 - ListMetricInfos
23.1 - 1.4
scp-cli servicewatch metricinfo list
[--metric_name <value>]
[--namespaces <value>]
[--resource_id <value>]
[--resource_name <value>]
[--tags <value>]
Description
Get metric list
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.4 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| metric_name optional | string | Metric Name | CPU Usage |
| 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 |
|---|---|---|
| count | Count | 1 |
| namespaces | [] |
23.2 - 1.3
scp-cli servicewatch metricinfo list
[--metric_name <value>]
[--namespaces <value>]
[--resource_id <value>]
[--resource_name <value>]
[--tags <value>]
Description
Get metric list
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.3 | 20270131 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| metric_name optional | string | Metric Name | CPU Usage |
| 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 |
|---|---|---|
| count | Count | 1 |
| namespaces | [] |
23.3 - 1.2
scp-cli servicewatch metricinfo list
[--metric_name <value>]
[--namespaces <value>]
[--resource_id <value>]
[--resource_name <value>]
[--tags <value>]
Description
Get metric list
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| metric_name optional | string | Metric Name | CPU Usage |
| 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 |
|---|---|---|
| count | Count | 1 |
| namespaces | [] |
23.4 - 1.1
scp-cli servicewatch metricinfo list
[--metric_name <value>]
[--namespaces <value>]
[--resource_id <value>]
[--resource_name <value>]
[--tags <value>]
Description
Get metric list
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260831 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| metric_name optional | string | Metric Name | CPU Usage |
| 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 |
|---|---|---|
| count | Count | 1 |
| namespaces | [] |
23.5 - 1.0
scp-cli servicewatch metricinfo list
[--metric_name <value>]
[--namespaces <value>]
[--resource_id <value>]
[--resource_name <value>]
[--tags <value>]
Description
Get metric list
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| metric_name optional | string | Metric Name | CPU Usage |
| 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 |
|---|---|---|
| count | Count | 1 |
| namespaces | [] |
24 - SetAlert
24.1 - 1.4
scp-cli servicewatch alert set
--id <value>
--value <value>
--key <value>
--statistic <value>
--period <value>
--operator <value>
--namespace_id <value>
--metric_id <value>
--level <value>
[--dimensions <value>]
[--evaluation_count <value>]
[--individual_items <value>]
[--lower_bound <value>]
[--missing_data_option <value>]
[--threshold <value>]
[--upper_bound <value>]
[--violation_count <value>]
Description
Set the Alert
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.4 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| id required | string | Alert ID | 3234bd0f12fa4d0b97ab9feff6c09b8e |
| value required | string | Dimension Value | 10bf5d24-0f20-4066-bb0b-de2b1d6ff502 |
| key required | string | Dimension Key | resource_id |
| 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 | 1d9d05af5c624f2cb80a45f2c911e2f4 |
| metric_id required | string | Metric ID | f13aab3b88c341b2bc73f8925a0e8cc5 |
| level required | string | Alert Level - HIGH, MIDDLE, LOW | HIGH |
| dimensions optional | array | List of Dimensions | '{"key": "resource_id", "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 | resource_id |
| value | Dimension Value | 10bf5d24-0f20-4066-bb0b-de2b1d6ff502 |
24.2 - 1.3
scp-cli servicewatch alert set
--id <value>
--value <value>
--key <value>
--statistic <value>
--period <value>
--operator <value>
--namespace_id <value>
--metric_id <value>
--level <value>
[--dimensions <value>]
[--evaluation_count <value>]
[--individual_items <value>]
[--lower_bound <value>]
[--missing_data_option <value>]
[--threshold <value>]
[--upper_bound <value>]
[--violation_count <value>]
Description
Set the Alert
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.3 | 20270131 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| id required | string | Alert ID | 3234bd0f12fa4d0b97ab9feff6c09b8e |
| value required | string | Dimension Value | 10bf5d24-0f20-4066-bb0b-de2b1d6ff502 |
| key required | string | Dimension Key | resource_id |
| 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 | 1d9d05af5c624f2cb80a45f2c911e2f4 |
| metric_id required | string | Metric ID | f13aab3b88c341b2bc73f8925a0e8cc5 |
| level required | string | Alert Level - HIGH, MIDDLE, LOW | HIGH |
| dimensions optional | array | List of Dimensions | '{"key": "resource_id", "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 | resource_id |
| value | Dimension Value | 10bf5d24-0f20-4066-bb0b-de2b1d6ff502 |
24.3 - 1.2
scp-cli servicewatch alert set
--id <value>
--value <value>
--key <value>
--statistic <value>
--period <value>
--operator <value>
--namespace_id <value>
--metric_id <value>
--level <value>
[--dimensions <value>]
[--evaluation_count <value>]
[--individual_items <value>]
[--lower_bound <value>]
[--missing_data_option <value>]
[--threshold <value>]
[--upper_bound <value>]
[--violation_count <value>]
Description
Set the Alert
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| id required | string | Alert ID | 3234bd0f12fa4d0b97ab9feff6c09b8e |
| value required | string | Dimension Value | 10bf5d24-0f20-4066-bb0b-de2b1d6ff502 |
| key required | string | Dimension Key | resource_id |
| 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 | 1d9d05af5c624f2cb80a45f2c911e2f4 |
| metric_id required | string | Metric ID | f13aab3b88c341b2bc73f8925a0e8cc5 |
| level required | string | Alert Level - HIGH, MIDDLE, LOW | HIGH |
| dimensions optional | array | List of Dimensions | '{"key": "resource_id", "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 | resource_id |
| value | Dimension Value | 10bf5d24-0f20-4066-bb0b-de2b1d6ff502 |
25 - SetAlertActivated
25.1 - 1.4
scp-cli servicewatch alert-activated set
--id <value>
--activated_yn <value>
Description
Set the Alert Activated
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.4 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| id required | string | Alert ID | 3234bd0f12fa4d0b97ab9feff6c09b8e |
| activated_yn required | string | Whether the Alert is activated or not | Y |
Responses
| Name | Description | Example |
|---|---|---|
| id | Alert ID | 3234bd0f12fa4d0b97ab9feff6c09b8e |
| activated_yn | Whether the Alert is activated or not | Y |
| modified_at | Modified date time | 2026-06-24T10:14:52.734074 |
25.2 - 1.3
scp-cli servicewatch alert-activated set
--id <value>
--activated_yn <value>
Description
Set the Alert Activated
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.3 | 20270131 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| id required | string | Alert ID | 3234bd0f12fa4d0b97ab9feff6c09b8e |
| activated_yn required | string | Whether the Alert is activated or not | Y |
Responses
| Name | Description | Example |
|---|---|---|
| id | Alert ID | 3234bd0f12fa4d0b97ab9feff6c09b8e |
| activated_yn | Whether the Alert is activated or not | Y |
| modified_at | Modified date time | 2026-06-24T10:14:52.734074 |
25.3 - 1.2
scp-cli servicewatch alert-activated set
--id <value>
--activated_yn <value>
Description
Set the Alert Activated
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| id required | string | Alert ID | 3234bd0f12fa4d0b97ab9feff6c09b8e |
| activated_yn required | string | Whether the Alert is activated or not | Y |
Responses
| Name | Description | Example |
|---|---|---|
| id | Alert ID | 3234bd0f12fa4d0b97ab9feff6c09b8e |
| activated_yn | Whether the Alert is activated or not | Y |
| modified_at | Modified date time | 2026-06-24T10:14:52.734074 |
26 - SetAlertDescription
26.1 - 1.4
scp-cli servicewatch alert-description set
--id <value>
[--description <value>]
Description
Set the Alert Description
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.4 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| id required | string | Alert ID | 3234bd0f12fa4d0b97ab9feff6c09b8e |
| description optional | string | Alert Description | Description for Alert Test |
Responses
| Name | Description | Example |
|---|---|---|
| id | Alert ID | 3234bd0f12fa4d0b97ab9feff6c09b8e |
| description | Alert Description | Description for Alert Test |
| modified_at | Modified date time | 2026-06-24T10:14:52.733269 |
26.2 - 1.3
scp-cli servicewatch alert-description set
--id <value>
[--description <value>]
Description
Set the Alert Description
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.3 | 20270131 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| id required | string | Alert ID | 3234bd0f12fa4d0b97ab9feff6c09b8e |
| description optional | string | Alert Description | Description for Alert Test |
Responses
| Name | Description | Example |
|---|---|---|
| id | Alert ID | 3234bd0f12fa4d0b97ab9feff6c09b8e |
| description | Alert Description | Description for Alert Test |
| modified_at | Modified date time | 2026-06-24T10:14:52.733269 |
26.3 - 1.2
scp-cli servicewatch alert-description set
--id <value>
[--description <value>]
Description
Set the Alert Description
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| id required | string | Alert ID | 3234bd0f12fa4d0b97ab9feff6c09b8e |
| description optional | string | Alert Description | Description for Alert Test |
Responses
| Name | Description | Example |
|---|---|---|
| id | Alert ID | 3234bd0f12fa4d0b97ab9feff6c09b8e |
| description | Alert Description | Description for Alert Test |
| modified_at | Modified date time | 2026-06-24T10:14:52.733269 |
27 - SetAlertNotifications
27.1 - 1.4
scp-cli servicewatch alert-set notifications
--id <value>
--user_ids <value>
Description
Set Alert notifications
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.4 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| id required | string | Alert ID | 3234bd0f12fa4d0b97ab9feff6c09b8e |
| user_ids required | array | List of User IDs | 1234da92-634a-4f8c-932e-9d650599ab1b |
28 - SetDashboard
28.1 - 1.4
scp-cli servicewatch dashboard set
--dashboard_id <value>
[--name <value>]
[--widgets <value>]
Description
Set dashboard
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.4 | - |
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”: “resource_id”, “value”: “10bf5d24-0f20-4066-bb0b-de2b1d6ff502”}], “display_name”: “EC2-Prod-CPU”, “individual_items”: [{“key”: “BucketId”, “value”: “b-1234567890abcdef0”}], “name”: “CPUUtilization”, “namespace_name”: “Virtual Server”, “period”: 300, “statistic_type”: “AVG”}], “period”: 300, “stacked”: false, “statistic_type”: “AVG”, “title”: “Virtual Server |
28.2 - 1.3
scp-cli servicewatch dashboard set
--dashboard_id <value>
[--name <value>]
[--widgets <value>]
Description
Set dashboard
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.3 | 20270131 |
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”: “resource_id”, “value”: “10bf5d24-0f20-4066-bb0b-de2b1d6ff502”}], “display_name”: “EC2-Prod-CPU”, “individual_items”: [{“key”: “BucketId”, “value”: “b-1234567890abcdef0”}], “name”: “CPUUtilization”, “namespace_name”: “Virtual Server”, “period”: 300, “statistic_type”: “AVG”}], “period”: 300, “stacked”: false, “statistic_type”: “AVG”, “title”: “Virtual Server |
28.3 - 1.2
scp-cli servicewatch dashboard set
--dashboard_id <value>
[--name <value>]
[--widgets <value>]
Description
Set dashboard
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20261130 |
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”: “resource_id”, “value”: “10bf5d24-0f20-4066-bb0b-de2b1d6ff502”}], “display_name”: “EC2-Prod-CPU”, “individual_items”: [{“key”: “BucketId”, “value”: “b-1234567890abcdef0”}], “name”: “CPUUtilization”, “namespace_name”: “Virtual Server”, “period”: 300, “statistic_type”: “AVG”}], “period”: 300, “stacked”: false, “statistic_type”: “AVG”, “title”: “Virtual Server |
28.4 - 1.1
scp-cli servicewatch dashboard set
--dashboard_id <value>
[--name <value>]
[--widgets <value>]
Description
Set dashboard
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| 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”: “resource_id”, “value”: “10bf5d24-0f20-4066-bb0b-de2b1d6ff502”}], “display_name”: “EC2-Prod-CPU”, “individual_items”: [{“key”: “BucketId”, “value”: “b-1234567890abcdef0”}], “name”: “CPUUtilization”, “namespace_name”: “Virtual Server”, “period”: 300, “statistic_type”: “AVG”}], “period”: 300, “stacked”: false, “statistic_type”: “AVG”, “title”: “Virtual Server |
28.5 - 1.0
scp-cli servicewatch dashboard set
--dashboard_id <value>
[--name <value>]
[--widgets <value>]
Description
Set dashboard
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| 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”: “resource_id”, “value”: “10bf5d24-0f20-4066-bb0b-de2b1d6ff502”}], “display_name”: “EC2-Prod-CPU”, “individual_items”: [{“key”: “BucketId”, “value”: “b-1234567890abcdef0”}], “name”: “CPUUtilization”, “namespace_name”: “Virtual Server”, “period”: 300, “statistic_type”: “AVG”}], “period”: 300, “stacked”: false, “statistic_type”: “AVG”, “title”: “Virtual Server |
29 - SetEventRule
29.1 - 1.4
scp-cli servicewatch eventrule set
--event_rule_id <value>
--service_id <value>
[--active_yn <value>]
[--description <value>]
[--event_ids <value>]
[--none_attributes <value>]
[--recipient_ids <value>]
[--resource_type_id <value>]
[--srn_list <value>]
Description
Set the Event rule.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.4 | - |
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 |
29.2 - 1.3
scp-cli servicewatch eventrule set
--event_rule_id <value>
--service_id <value>
[--active_yn <value>]
[--description <value>]
[--event_ids <value>]
[--none_attributes <value>]
[--recipient_ids <value>]
[--resource_type_id <value>]
[--srn_list <value>]
Description
Set the Event rule.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.3 | 20270131 |
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 |
29.3 - 1.2
scp-cli servicewatch eventrule set
--event_rule_id <value>
--service_id <value>
[--active_yn <value>]
[--description <value>]
[--event_ids <value>]
[--none_attributes <value>]
[--recipient_ids <value>]
[--resource_type_id <value>]
[--srn_list <value>]
Description
Set the Event rule.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20261130 |
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 |
29.4 - 1.1
scp-cli servicewatch eventrule set
--event_rule_id <value>
--service_id <value>
[--active_yn <value>]
[--description <value>]
[--event_ids <value>]
[--none_attributes <value>]
[--recipient_ids <value>]
[--resource_type_id <value>]
[--srn_list <value>]
Description
Set the Event rule.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| 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 |
29.5 - 1.0
scp-cli servicewatch eventrule set
--event_rule_id <value>
--service_id <value>
[--active_yn <value>]
[--description <value>]
[--event_ids <value>]
[--none_attributes <value>]
[--recipient_ids <value>]
[--resource_type_id <value>]
[--srn_list <value>]
Description
Set the Event rule.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| 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 |
30 - SetLogGroup
30.1 - 1.4
scp-cli servicewatch loggroup set
--log_group_id <value>
--retention_period <value>
Description
Set the Log group.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.4 | - |
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 |
30.2 - 1.3
scp-cli servicewatch loggroup set
--log_group_id <value>
--retention_period <value>
Description
Set the Log group.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.3 | 20270131 |
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 |
30.3 - 1.2
scp-cli servicewatch loggroup set
--log_group_id <value>
--retention_period <value>
Description
Set the Log group.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20261130 |
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 |
30.4 - 1.1
scp-cli servicewatch loggroup set
--log_group_id <value>
--retention_period <value>
Description
Set the Log group.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| 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 |
30.5 - 1.0
scp-cli servicewatch loggroup set
--log_group_id <value>
--retention_period <value>
Description
Set the Log group.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| 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 |
31 - ShowAgentDownloadLink
31.1 - 1.4
scp-cli servicewatch show agent download link
Description
Show link to agent download
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.4 | - |
Responses
| Name | Description | Example |
|---|---|---|
| download_link | URL to download agent | https://object-store.private.{region}.{environment}.samsungsdscloud.com/account:swt-agent/latest/ServiceWatch_Agent.zip |
31.2 - 1.3
scp-cli servicewatch show agent download link
Description
Show link to agent download
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.3 | 20270131 |
Responses
| Name | Description | Example |
|---|---|---|
| download_link | URL to download agent | https://object-store.private.{region}.{environment}.samsungsdscloud.com/account:swt-agent/latest/ServiceWatch_Agent.zip |
31.3 - 1.2
scp-cli servicewatch show agent download link
Description
Show link to agent download
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20261130 |
Responses
| Name | Description | Example |
|---|---|---|
| download_link | URL to download agent | https://object-store.private.{region}.{environment}.samsungsdscloud.com/account:swt-agent/latest/ServiceWatch_Agent.zip |
31.4 - 1.1
scp-cli servicewatch show agent download link
Description
Show link to agent download
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| 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/latest/ServiceWatch_Agent.zip |
32 - ShowAlert
32.1 - 1.4
scp-cli servicewatch alert show
--id <value>
Description
Show the Alert
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.4 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| id required | string | Alert ID | 3234bd0f12fa4d0b97ab9feff6c09b8e |
Responses
| Name | Description | Example |
|---|---|---|
| activated_yn | Whether the Alert is activated or not | Y |
| created_at | Created date time | |
| created_by | Creator ID | f4b8a4c4017f4f8d8399f0c02582ae47 |
| description | Alert Description | Description for Alert Test |
| dimension | Dimension | |
| dimensions | List of Dimensions | [] |
| evaluation_count | Evaluation Count for the Alert Condition | 3 |
| evaluation_time_window | Evaluation Time Window (period * evaluation_count) | 900 |
| individual_items | List of Individual Items | [] |
| last_policy_updated_at | Last Alert Policy Updated Date Time | |
| level | Alert Level - HIGH, MIDDLE, LOW | HIGH |
| lower_bound | Lower bound for the Alert range operator | 80.0 |
| metric_id | Metric ID | f13aab3b88c341b2bc73f8925a0e8cc5 |
| metric_name | Metric Name | CPU Usage |
| metric_unit | Metric Unit. Allowed Units: SECONDS, MICROSECONDS, MILLISECONDS, BYTES, KILOBYTES, MEGABYTES, GIGABYTES, TERABYTES, BITS, KILOBITS, MEGABITS, GIGABITS, TERABITS, PERCENT, COUNT, BYTES_PER_SECOND, KILOBYTES_PER_SECOND, MEGABYTES_PER_SECOND, GIGABYTES_PER_SECOND, TERABYTES_PER_SECOND, BITS_PER_SECOND, KILOBITS_PER_SECOND, MEGABITS_PER_SECOND, GIGABITS_PER_SECOND, TERABITS_PER_SECOND, COUNT_PER_SECOND, COUNT_PER_MINUTE, NONE | BYTE |
| missing_data_option | Missing Data Option - MISSING, BREACHING, NOT_BREACHING, IGNORE | BREACHING |
| modified_at | Modified date time | |
| modified_by | Modifier ID | f4b8a4c4017f4f8d8399f0c02582ae47 |
| name | Alert Name | Alert Test |
| namespace_id | Namespace ID | 1d9d05af5c624f2cb80a45f2c911e2f4 |
| namespace_name | Namespace Name | Virtual Server |
| operator | Operator - EQ, NOT_EQ, GT, GTE, LT, LTE, RANGE | RANGE |
| period | Period (seconds) | 300 |
| srn | SDS cloud Resource Name of the Alert | srn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::scp-servicewatch:alert/0ad6da92-634a-4f8c-932e-9d650599ab1e |
| state | Alert State - NORMAL, ALERT, INSUFFICIENT_DATA | NORMAL |
| statistic | Statistic - SUM, AVG, MAX, MIN | AVG |
| threshold | Threshold for the Alert Condition (except fro RANGE operator) | 80.0 |
| timestamp | Timestamp | 2025-08-15T11:04:00.000+0000 |
| type | Alert Type | METRIC_ALERT |
| upper_bound | Upper bound for the Alert range operator | 90.0 |
| violation_count | Violation Count for the Alert Condition | 2 |
32.2 - 1.3
scp-cli servicewatch alert show
--id <value>
Description
Show the Alert
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.3 | 20270131 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| id required | string | Alert ID | 3234bd0f12fa4d0b97ab9feff6c09b8e |
Responses
| Name | Description | Example |
|---|---|---|
| activated_yn | Whether the Alert is activated or not | Y |
| created_at | Created date time | |
| created_by | Creator ID | f4b8a4c4017f4f8d8399f0c02582ae47 |
| description | Alert Description | Description for Alert Test |
| dimension | Dimension | |
| dimensions | List of Dimensions | [] |
| evaluation_count | Evaluation Count for the Alert Condition | 3 |
| evaluation_time_window | Evaluation Time Window (period * evaluation_count) | 900 |
| individual_items | List of Individual Items | [] |
| last_policy_updated_at | Last Alert Policy Updated Date Time | |
| level | Alert Level - HIGH, MIDDLE, LOW | HIGH |
| lower_bound | Lower bound for the Alert range operator | 80.0 |
| metric_id | Metric ID | f13aab3b88c341b2bc73f8925a0e8cc5 |
| metric_name | Metric Name | CPU Usage |
| metric_unit | Metric Unit. Allowed Units: SECONDS, MICROSECONDS, MILLISECONDS, BYTES, KILOBYTES, MEGABYTES, GIGABYTES, TERABYTES, BITS, KILOBITS, MEGABITS, GIGABITS, TERABITS, PERCENT, COUNT, BYTES_PER_SECOND, KILOBYTES_PER_SECOND, MEGABYTES_PER_SECOND, GIGABYTES_PER_SECOND, TERABYTES_PER_SECOND, BITS_PER_SECOND, KILOBITS_PER_SECOND, MEGABITS_PER_SECOND, GIGABITS_PER_SECOND, TERABITS_PER_SECOND, COUNT_PER_SECOND, COUNT_PER_MINUTE, NONE | BYTE |
| missing_data_option | Missing Data Option - MISSING, BREACHING, NOT_BREACHING, IGNORE | BREACHING |
| modified_at | Modified date time | |
| modified_by | Modifier ID | f4b8a4c4017f4f8d8399f0c02582ae47 |
| name | Alert Name | Alert Test |
| namespace_id | Namespace ID | 1d9d05af5c624f2cb80a45f2c911e2f4 |
| namespace_name | Namespace Name | Virtual Server |
| operator | Operator - EQ, NOT_EQ, GT, GTE, LT, LTE, RANGE | RANGE |
| period | Period (seconds) | 300 |
| srn | SDS cloud Resource Name of the Alert | srn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::scp-servicewatch:alert/0ad6da92-634a-4f8c-932e-9d650599ab1e |
| state | Alert State - NORMAL, ALERT, INSUFFICIENT_DATA | NORMAL |
| statistic | Statistic - SUM, AVG, MAX, MIN | AVG |
| threshold | Threshold for the Alert Condition (except fro RANGE operator) | 80.0 |
| timestamp | Timestamp | 2025-08-15T11:04:00.000+0000 |
| type | Alert Type | METRIC_ALERT |
| upper_bound | Upper bound for the Alert range operator | 90.0 |
| violation_count | Violation Count for the Alert Condition | 2 |
32.3 - 1.2
scp-cli servicewatch alert show
--id <value>
Description
Show the Alert
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| id required | string | Alert ID | 3234bd0f12fa4d0b97ab9feff6c09b8e |
Responses
| Name | Description | Example |
|---|---|---|
| activated_yn | Whether the Alert is activated or not | Y |
| created_at | Created date time | |
| created_by | Creator ID | f4b8a4c4017f4f8d8399f0c02582ae47 |
| description | Alert Description | Description for Alert Test |
| dimension | Dimension | |
| dimensions | List of Dimensions | [] |
| evaluation_count | Evaluation Count for the Alert Condition | 3 |
| evaluation_time_window | Evaluation Time Window (period * evaluation_count) | 900 |
| individual_items | List of Individual Items | [] |
| last_policy_updated_at | Last Alert Policy Updated Date Time | |
| level | Alert Level - HIGH, MIDDLE, LOW | HIGH |
| lower_bound | Lower bound for the Alert range operator | 80.0 |
| metric_id | Metric ID | f13aab3b88c341b2bc73f8925a0e8cc5 |
| metric_name | Metric Name | CPU Usage |
| metric_unit | Metric Unit. Allowed Units: SECONDS, MICROSECONDS, MILLISECONDS, BYTES, KILOBYTES, MEGABYTES, GIGABYTES, TERABYTES, BITS, KILOBITS, MEGABITS, GIGABITS, TERABITS, PERCENT, COUNT, BYTES_PER_SECOND, KILOBYTES_PER_SECOND, MEGABYTES_PER_SECOND, GIGABYTES_PER_SECOND, TERABYTES_PER_SECOND, BITS_PER_SECOND, KILOBITS_PER_SECOND, MEGABITS_PER_SECOND, GIGABITS_PER_SECOND, TERABITS_PER_SECOND, COUNT_PER_SECOND, COUNT_PER_MINUTE, NONE | BYTE |
| missing_data_option | Missing Data Option - MISSING, BREACHING, NOT_BREACHING, IGNORE | BREACHING |
| modified_at | Modified date time | |
| modified_by | Modifier ID | f4b8a4c4017f4f8d8399f0c02582ae47 |
| name | Alert Name | Alert Test |
| namespace_id | Namespace ID | 1d9d05af5c624f2cb80a45f2c911e2f4 |
| namespace_name | Namespace Name | Virtual Server |
| operator | Operator - EQ, NOT_EQ, GT, GTE, LT, LTE, RANGE | RANGE |
| period | Period (seconds) | 300 |
| srn | SDS cloud Resource Name of the Alert | srn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::scp-servicewatch:alert/0ad6da92-634a-4f8c-932e-9d650599ab1e |
| state | Alert State - NORMAL, ALERT, INSUFFICIENT_DATA | NORMAL |
| statistic | Statistic - SUM, AVG, MAX, MIN | AVG |
| threshold | Threshold for the Alert Condition (except fro RANGE operator) | 80.0 |
| type | Alert Type | METRIC_ALERT |
| upper_bound | Upper bound for the Alert range operator | 90.0 |
| violation_count | Violation Count for the Alert Condition | 2 |
33 - ShowAlertLevelCountsByService
33.1 - 1.4
scp-cli servicewatch alert-level counts by service
Description
Show Alert level counts by service
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.4 | - |
Responses
| Name | Description | Example |
|---|---|---|
| HIGH | Count of HIGH Level | 10 |
| LOW | Count of LOW Level | 64 |
| MIDDLE | Count of MIDDLE Level | 6 |
| dashboard_id | Dashboard’s unique ID | 06565dbb67544154b1eabe81658a2e83 |
| favorite_enabled | Favorite Enabled | True |
| namespace_id | Namespace ID | 1d9d05af5c624f2cb80a45f2c911e2f4 |
| namespace_name | Namespace Name | Virtual Server |
| service_code | Service code | virtualserver |
| service_menu_name | Service menu name | Virtual Server |
34 - ShowDashboard
34.1 - 1.4
scp-cli servicewatch dashboard show
--dashboard_id <value>
Description
Show dashboard
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.4 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| dashboard_id required | string | Dashboard's unique ID | b48e730a70e74f6aa3d2555000b5c22b |
Responses
| Name | Description | Example |
|---|---|---|
| id | Dashboard’s unique ID | b48e730a70e74f6aa3d2555000b5c22b |
| alerts | Alert information related to the dashboard | {} |
| created_at | Created date time | |
| created_by | Creator ID | user-xxxxxxxx |
| favorite_enabled | Whether it is a favorite dashboard | True |
| modified_at | Modified date time | |
| modified_by | Modifier ID | user-yyyyyyyy |
| name | Dashboard’s name | Production-Web-Servers |
| namespace_code | Associated namespace code | virtualserver |
| product_name | Associated resource type | ServiceWatch |
| resource_id | Associated resource ID | c8e41e595ad040a8abe57e2ffc109113 |
| resource_name | Associated resource name | Production-Web-Servers |
| resource_type | Associated resource type | dashboard |
| service_code | Associated service code | virtualserver |
| share_type | Sharing type | Private |
| srn | Service resource name (SRN) | srn:vs:kr-central-1:123456789012:instance/c8e41e595ad040a8abe57e2ffc109113 |
| type | Dashboard type | Custom |
| widgets | List of widgets included in the dashboard | [] |
34.2 - 1.3
scp-cli servicewatch dashboard show
--dashboard_id <value>
Description
Show dashboard
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.3 | 20270131 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| dashboard_id required | string | Dashboard's unique ID | b48e730a70e74f6aa3d2555000b5c22b |
Responses
| Name | Description | Example |
|---|---|---|
| id | Dashboard’s unique ID | b48e730a70e74f6aa3d2555000b5c22b |
| alerts | Alert information related to the dashboard | {} |
| created_at | Created date time | |
| created_by | Creator ID | user-xxxxxxxx |
| favorite_enabled | Whether it is a favorite dashboard | True |
| modified_at | Modified date time | |
| modified_by | Modifier ID | user-yyyyyyyy |
| name | Dashboard’s name | Production-Web-Servers |
| product_name | Associated resource type | ServiceWatch |
| resource_id | Associated resource ID | c8e41e595ad040a8abe57e2ffc109113 |
| resource_name | Associated resource name | Production-Web-Servers |
| resource_type | Associated resource type | dashboard |
| service_code | Associated service code | virtualserver |
| share_type | Sharing type | Private |
| srn | Service resource name (SRN) | srn:vs:kr-central-1:123456789012:instance/c8e41e595ad040a8abe57e2ffc109113 |
| type | Dashboard type | Custom |
| widgets | List of widgets included in the dashboard | [] |
34.3 - 1.2
scp-cli servicewatch dashboard show
--dashboard_id <value>
Description
Show dashboard
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| dashboard_id required | string | Dashboard's unique ID | b48e730a70e74f6aa3d2555000b5c22b |
Responses
| Name | Description | Example |
|---|---|---|
| id | Dashboard’s unique ID | b48e730a70e74f6aa3d2555000b5c22b |
| alerts | Alert information related to the dashboard | {} |
| created_at | Created date time | |
| created_by | Creator ID | user-xxxxxxxx |
| favorite_enabled | Whether it is a favorite dashboard | True |
| modified_at | Modified date time | |
| modified_by | Modifier ID | user-yyyyyyyy |
| name | Dashboard’s name | Production-Web-Servers |
| product_name | Associated resource type | ServiceWatch |
| resource_id | Associated resource ID | c8e41e595ad040a8abe57e2ffc109113 |
| resource_name | Associated resource name | Production-Web-Servers |
| resource_type | Associated resource type | dashboard |
| service_code | Associated service code | virtualserver |
| share_type | Sharing type | Private |
| srn | Service resource name (SRN) | srn:vs:kr-central-1:123456789012:instance/c8e41e595ad040a8abe57e2ffc109113 |
| type | Dashboard type | Custom |
| widgets | List of widgets included in the dashboard | [] |
34.4 - 1.1
scp-cli servicewatch dashboard show
--dashboard_id <value>
Description
Show dashboard
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| 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 | Dashboard’s unique ID | b48e730a70e74f6aa3d2555000b5c22b |
| alerts | Alert information related to the dashboard | {} |
| created_at | Created date time | |
| created_by | Creator ID | user-xxxxxxxx |
| favorite_enabled | Whether it is a favorite dashboard | True |
| modified_at | Modified date time | |
| modified_by | Modifier ID | user-yyyyyyyy |
| name | Dashboard’s name | Production-Web-Servers |
| product_name | Associated resource type | ServiceWatch |
| resource_id | Associated resource ID | c8e41e595ad040a8abe57e2ffc109113 |
| resource_name | Associated resource name | Production-Web-Servers |
| resource_type | Associated resource type | dashboard |
| service_code | Associated service code | virtualserver |
| share_type | Sharing type | Private |
| srn | Service resource name (SRN) | srn:vs:kr-central-1:123456789012:instance/c8e41e595ad040a8abe57e2ffc109113 |
| type | Dashboard type | Custom |
| widgets | List of widgets included in the dashboard | [] |
34.5 - 1.0
scp-cli servicewatch dashboard show
--dashboard_id <value>
Description
Show dashboard
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| 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 | Dashboard’s unique ID | b48e730a70e74f6aa3d2555000b5c22b |
| alerts | Alert information related to the dashboard | {} |
| created_at | Created date time | |
| created_by | Creator ID | user-xxxxxxxx |
| favorite_enabled | Whether it is a favorite dashboard | True |
| modified_at | Modified date time | |
| modified_by | Modifier ID | user-yyyyyyyy |
| name | Dashboard’s name | Production-Web-Servers |
| product_name | Associated resource type | ServiceWatch |
| resource_id | Associated resource ID | c8e41e595ad040a8abe57e2ffc109113 |
| resource_name | Associated resource name | Production-Web-Servers |
| resource_type | Associated resource type | dashboard |
| share_type | Sharing type | Private |
| srn | Service resource name (SRN) | srn:vs:kr-central-1:123456789012:instance/c8e41e595ad040a8abe57e2ffc109113 |
| type | Dashboard type | Custom |
| widgets | List of widgets included in the dashboard | [] |
35 - ShowEventRule
35.1 - 1.4
scp-cli servicewatch eventrule show
--event_rule_id <value>
Description
Show the Event rule.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.4 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| event_rule_id required | string | Event rule ID | b73f95c698f540dab18860f72fafd03f |
Responses
| Name | Description | Example |
|---|---|---|
| event_rule | Event rule |
35.2 - 1.3
scp-cli servicewatch eventrule show
--event_rule_id <value>
Description
Show the Event rule.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.3 | 20270131 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| event_rule_id required | string | Event rule ID | b73f95c698f540dab18860f72fafd03f |
Responses
| Name | Description | Example |
|---|---|---|
| event_rule | Event rule |
35.3 - 1.2
scp-cli servicewatch eventrule show
--event_rule_id <value>
Description
Show the Event rule.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| event_rule_id required | string | Event rule ID | b73f95c698f540dab18860f72fafd03f |
Responses
| Name | Description | Example |
|---|---|---|
| event_rule | Event rule |
36 - ShowLogGroup
36.1 - 1.4
scp-cli servicewatch loggroup show
--log_group_id <value>
Description
Show the Log group.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.4 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| log_group_id required | string | Log group ID | bce52822147744b4afe0187164caa2e8 |
Responses
| Name | Description | Example |
|---|---|---|
| log_group | Log group |
36.2 - 1.3
scp-cli servicewatch loggroup show
--log_group_id <value>
Description
Show the Log group.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.3 | 20270131 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| log_group_id required | string | Log group ID | bce52822147744b4afe0187164caa2e8 |
Responses
| Name | Description | Example |
|---|---|---|
| log_group | Log group |
36.3 - 1.2
scp-cli servicewatch loggroup show
--log_group_id <value>
Description
Show the Log group.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| log_group_id required | string | Log group ID | bce52822147744b4afe0187164caa2e8 |
Responses
| Name | Description | Example |
|---|---|---|
| log_group | Log group |
37 - ShowLogStream
37.1 - 1.4
scp-cli servicewatch logstream show
--log_stream_id <value>
--log_group_id <value>
Description
Show the Log group log stream
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.4 | - |
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 |
37.2 - 1.3
scp-cli servicewatch logstream show
--log_stream_id <value>
--log_group_id <value>
Description
Show the Log group log stream
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.3 | 20270131 |
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 |
37.3 - 1.2
scp-cli servicewatch logstream show
--log_stream_id <value>
--log_group_id <value>
Description
Show the Log group log stream
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20261130 |
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 |