This is the multi-page printable view of this section. Click here to print.
Models
- 1: AgentDownloadLinkResponse
- 2: AlertPropertiesDTO
- 3: AlertsObjectDTO
- 4: AlertSummaryDTO
- 5: CustomLogAttributeDTO
- 6: CustomLogEventsCreateRequest
- 7: CustomLogEventsCreateResponse
- 8: CustomLogRecordDTO
- 9: CustomLogResourceDTO
- 10: CustomLogValueDTO
- 11: CustomResourceLogDTO
- 12: CustomScopeLogDTO
- 13: DashboardAlertWidgetDTO
- 14: DashboardBulkDeleteRequest
- 15: DashboardBulkDeleteResponse
- 16: DashboardCreationRequest
- 17: DashboardDetailResponse
- 18: DashboardDetailResponseV1Dot1
- 19: DashboardDTO
- 20: DashboardPageResponse
- 21: DashboardUpdateRequest
- 22: DimensionDTO
- 23: IndividualItemDTO
- 24: LogGroupsLogStreamsCollectCustomRequest
- 25: LogGroupsLogStreamsCollectCustomResponse
- 26: MetricAlert
- 27: MetricAlertDto
- 28: MetricAlertsDTO
- 29: MetricCustomMetaRequest
- 30: MetricCustomMetaResponse
- 31: MetricCustomRequest
- 32: MetricDataImageDto
- 33: MetricDataImageDtoV1Dot1
- 34: MetricDataImageRequest
- 35: MetricDataImageRequestV1Dot1
- 36: MetricDataRequest
- 37: MetricDataRequestV1Dot1
- 38: MetricDataResponse
- 39: MetricDataResponseDto
- 40: MetricDetailDto
- 41: MetricDetailDtoV1Dot1
- 42: MetricDimensionDto
- 43: MetricDimensionDtoV1Dot1
- 44: MetricDTO
- 45: MetricDtoV1Dot1
- 46: MetricLabelDto
- 47: MetricLabelNameDto
- 48: MetricListDto
- 49: MetricListDtoV1Dot1
- 50: MetricMetaDto
- 51: MetricNamespaceDto
- 52: MetricNamespaceDtoV1Dot1
- 53: MetricSearchRequest
- 54: MetricSearchRequestV1Dot1
- 55: MetricsMetricColumnDto
- 56: MetricsResponse
- 57: MetricsResponseV1Dot1
- 58: OtlpAttributeDto
- 59: OtlpAttributeValueDto
- 60: OtlpGaugeDto
- 61: OtlpMetricDto
- 62: OtlpNumberDataPointDto
- 63: OtlpResourceDto
- 64: OtlpResourceMetricDto
- 65: OtlpScopeDto
- 66: OtlpScopeMetricDto
- 67: OtlpSumDto
- 68: PropertiesDTO
- 69: PropertiesDtoV1Dot1
- 70: SearchOptionNamespaceDto
- 71: SearchOptionNamespaceDtoV1Dot1
- 72: TagDTO
- 73: UnitLogDto
- 74: WidgetDetailDTO
- 75: WidgetDetailDtoV1Dot1
- 76: WidgetDTO
1 - AgentDownloadLinkResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| download_link required | URL to download agent Example : download_link = 'https://object-store.private.{region}.{environment}.samsungsdscloud.com/account:swt-agent/1.0/ServiceWatch_Agent.zip' | string |
2 - AlertPropertiesDTO
| Name | Description | Schema | Default |
|---|---|---|---|
| metrics required | List of metrics included in the widget | array[MetricAlertsDTO] | |
| period optional | Query period (seconds) Example : 300 | any of [integer, null] | |
| stacked required | Whether the graph is stacked Example : False | boolean | |
| statistic_type optional | Statistical function Example : AVG | any of [string, null] | |
| title required | Widget title Example : Virtual Server | CPU Utilization | string | |
| view required | View type Example : line | string |
3 - AlertsObjectDTO
| Name | Description | Schema | Default |
|---|---|---|---|
| summary required | Alert summary | AlertSummaryDTO | |
| widgets optional | List of widgets containing alert information | any of [array[DashboardAlertWidgetDTO], null] |
4 - AlertSummaryDTO
| Name | Description | Schema | Default |
|---|---|---|---|
| high required | Number of high-severity alarms Example : 1 | integer | |
| low required | Number of low-severity alarms Example : 0 | integer | |
| medium required | Number of medium-severity alarms Example : 3 | integer |
5 - CustomLogAttributeDTO
| Name | Description | Schema | Default |
|---|---|---|---|
| key required | Key Example : | string | |
| value required | Value | CustomLogValueDTO |
6 - CustomLogEventsCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| resourceLogs required | Resource Logs | array[CustomResourceLogDTO] |
7 - CustomLogEventsCreateResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| status required | Status Example : success | string |
8 - CustomLogRecordDTO
| Name | Description | Schema | Default |
|---|---|---|---|
| body required | Body | CustomLogValueDTO | |
| timeUnixNano required | Unix nano time Example : 1762336464000000000 | integer |
9 - CustomLogResourceDTO
| Name | Description | Schema | Default |
|---|---|---|---|
| attributes required | Attributes Example : [{'key': 'log_stream_value', 'value': {'stringValue': 'a1e2f3045678901a2b3c4d5e6f7a8b81'}}, {'key': 'log_group_value', 'value': {'stringValue': 'b1e2f3045678901a2b3c4d5e6f7a8b81'}}, {'key': 'account_id', 'value': {'stringValue': 'c1e2f3045678901a2b3c4d5e6f7a8b81'}}] | array[CustomLogAttributeDTO] |
10 - CustomLogValueDTO
| Name | Description | Schema | Default |
|---|---|---|---|
| stringValue required | String Value: account_id, log_group_value, log_stream_value Example : level=info otlp test log | string |
11 - CustomResourceLogDTO
| Name | Description | Schema | Default |
|---|---|---|---|
| resource required | Resource | CustomLogResourceDTO | |
| scopeLogs required | Scope Log | array[CustomScopeLogDTO] |
12 - CustomScopeLogDTO
| Name | Description | Schema | Default |
|---|---|---|---|
| logRecords required | Log Records | array[CustomLogRecordDTO] |
13 - DashboardAlertWidgetDTO
| Name | Description | Schema | Default |
|---|---|---|---|
| properties required | Widget’s detailed properties | AlertPropertiesDTO |
14 - DashboardBulkDeleteRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| dashboard_ids required | List of dashboard IDs Example : ['b48e730a70e74f6aa3d2555000b5c22b', 'c48e730a70e74f6aa3d2555000b5c22b'] | array[string] |
15 - DashboardBulkDeleteResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| dashboard_names required | List of dashboard’s name Example : ['dash-abc', 'dash-def'] | array[string] |
16 - DashboardCreationRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| name required | Dashboard’s name Example : New-Monitoring-Dashboard | string | |
| widgets optional | List of widgets included in the dashboard | any of [array[WidgetDTO], null] |
17 - DashboardDetailResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| alerts optional | Alert information related to the dashboard | any of [AlertsObjectDTO, null] | |
| created_at required | Created date time Example : | string (date-time) | |
| created_by required | Creator ID Example : user-xxxxxxxx | string | |
| favorite_enabled required | Whether it is a favorite dashboard Example : True | boolean | |
| id required | Dashboard’s unique ID Example : b48e730a70e74f6aa3d2555000b5c22b | string | |
| modified_at optional | Modified date time Example : | any of [string (date-time), null] | |
| modified_by optional | Modifier ID Example : user-yyyyyyyy | any of [string, null] | |
| name required | Dashboard’s name Example : Production-Web-Servers | string | |
| product_name required | Associated resource type Example : ServiceWatch | string | |
| resource_id required | Associated resource ID Example : c8e41e595ad040a8abe57e2ffc109113 | string | |
| resource_name required | Associated resource name Example : Production-Web-Servers | string | |
| resource_type required | Associated resource type Example : dashboard | string | |
| share_type required | Sharing type Example : Private | string | |
| srn required | Service resource name (SRN) Example : srn:vs:kr-central-1:123456789012:instance/c8e41e595ad040a8abe57e2ffc109113 | string | |
| type required | Dashboard type Example : Custom | string | |
| widgets optional | List of widgets included in the dashboard | any of [array[WidgetDetailDTO], null] |
18 - DashboardDetailResponseV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| alerts optional | Alert information related to the dashboard | any of [AlertsObjectDTO, null] | |
| created_at required | Created date time Example : | string (date-time) | |
| created_by required | Creator ID Example : user-xxxxxxxx | string | |
| favorite_enabled required | Whether it is a favorite dashboard Example : True | boolean | |
| id required | Dashboard’s unique ID Example : b48e730a70e74f6aa3d2555000b5c22b | string | |
| modified_at optional | Modified date time Example : | any of [string (date-time), null] | |
| modified_by optional | Modifier ID Example : user-yyyyyyyy | any of [string, null] | |
| name required | Dashboard’s name Example : Production-Web-Servers | string | |
| product_name required | Associated resource type Example : ServiceWatch | string | |
| resource_id required | Associated resource ID Example : c8e41e595ad040a8abe57e2ffc109113 | string | |
| resource_name required | Associated resource name Example : Production-Web-Servers | string | |
| resource_type required | Associated resource type Example : dashboard | string | |
| share_type required | Sharing type Example : Private | string | |
| srn required | Service resource name (SRN) Example : srn:vs:kr-central-1:123456789012:instance/c8e41e595ad040a8abe57e2ffc109113 | string | |
| type required | Dashboard type Example : Custom | string | |
| widgets optional | List of widgets included in the dashboard | any of [array[WidgetDetailDtoV1Dot1], null] |
19 - DashboardDTO
| Name | Description | Schema | Default |
|---|---|---|---|
| created_at required | Created date time Example : | string (date-time) | |
| favorite_enabled required | Whether it is a favorite dashboard Example : True | boolean | |
| id required | Dashboard’s unique ID Example : b48e730a70e74f6aa3d2555000b5c22b | string | |
| modified_at required | Modified date time Example : | string (date-time) | |
| name required | Dashboard’s name Example : Production-Web-Servers | string | |
| type required | Dashboard type Example : Custom | string |
20 - DashboardPageResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | count Example : 20 | integer | |
| dashboards required | List of dashboards | array[DashboardDTO] | |
| page required | page Example : 0 | integer | |
| size required | size Example : 20 | integer | |
| sort optional | sort Example : ['created_at:asc'] | any of [array[string], null] |
21 - DashboardUpdateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| name optional | Dashboard’s name Example : Renamed-Dashboard | any of [string, null] | |
| widgets optional | List of widgets included in the dashboard | any of [array[WidgetDTO], null] |
22 - DimensionDTO
| Name | Description | Schema | Default |
|---|---|---|---|
| key required | Dimension Key Example : InstanceId | string | |
| value required | Dimension Value Example : 10bf5d24-0f20-4066-bb0b-de2b1d6ff502 | string |
23 - IndividualItemDTO
| Name | Description | Schema | Default |
|---|---|---|---|
| key required | Individual item’s key Example : bucket_id | string | |
| value required | Individual item’s value Example : 6870d9989ec3496c932de11b409ed9cc | object |
24 - LogGroupsLogStreamsCollectCustomRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| log_group_name required | Log group name Example : testlg01 | string | |
| log_stream_name required | Log stream name Example : testls01 | string |
25 - LogGroupsLogStreamsCollectCustomResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account ID Example : 1bcf39b344ac41cbaf0466ff0d2bebad | string | |
| log_group_value required | Log group value Example : fa6169af200b4d5db229aff384b2a028 | string | |
| log_stream_value required | Log stream value Example : 551513c5182b45beb22eadb634cdccfb | string | |
| requests_per_second required | Export log requests per second Example : 500 | integer |
26 - MetricAlert
| Name | Description | Schema | Default |
|---|---|---|---|
| id required | Example : | string | |
| name required | Example : | string |
27 - MetricAlertDto
| Name | Description | Schema | Default |
|---|---|---|---|
| id required | Alert ID Example : 0ad6da92-634a-4f8c-932e-9d650599ab1e | string | |
| name required | Alert Name Example : Alert1 | string |
28 - MetricAlertsDTO
| Name | Description | Schema | Default |
|---|---|---|---|
| alerts optional | List of Alerts | any of [array[MetricAlert], null] | |
| color required | Metric line color Example : #ff7f0e | string | |
| dimensions required | List of Dimensions | array[DimensionDTO] | |
| display_name required | Display name (label) of the metric Example : EC2-Prod-CPU | string | |
| individual_items optional | List of Individual Items Example : [{'key': 'BucketId', 'value': 'b-1234567890abcdef0'}] | any of [array[IndividualItemDTO], null] | |
| name required | Metric Name Example : CPUUtilization | string | |
| namespace_name required | Namespace Example : Virtual Server | string | |
| period required | Query period (seconds) Example : 300 | integer | |
| statistic_type required | Statistical function Example : AVG | string |
29 - MetricCustomMetaRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| metricMetas required | array[MetricMetaDto] | ||
| namespace required | Namespace Example : MyCustom/filestorage | string |
30 - MetricCustomMetaResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account ID of Metrics Example : d79a5194b1a44a858969eb94754d3ba1 | string | |
| max_data_points optional | Example : | integer | |
| unit_logs required | array[UnitLogDto] |
31 - MetricCustomRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| resource_metrics required | The resourceMetrics field holds a set of all metric data associated with a specific resource | array[OtlpResourceMetricDto] |
32 - MetricDataImageDto
| Name | Description | Schema | Default |
|---|---|---|---|
| color optional | Color Example : #0000ff | any of [string, null] | |
| dimensions required | List of Dimensions | array[MetricLabelDto] | |
| display_name optional | Metric Display Name Example : Virtual Server | VirtualServer001 | CPU Usage/Core[Basic] | any of [string, null] | |
| individual_items optional | List of Individual Items | any of [array[MetricLabelDto], null] | |
| name required | Metric Name Example : CPU Usage/Core[Basic] | string | |
| namespace_name required | Namespace Example : Virtual Server | string | |
| period optional | Statistic Period Example : 300 | any of [integer, null] | |
| statistic_type optional | Metric Statistics Type Example : AVG | any of [enum (AVG, SUM, MAX, MIN, CNT), null] |
33 - MetricDataImageDtoV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| color optional | Color Example : #0000ff | any of [string, null] | |
| dimensions required | List of Dimensions | array[MetricLabelDto] | |
| display_name optional | Metric Display Name Example : Virtual Server | VirtualServer001 | CPU Usage/Core[Basic] | any of [string, null] | |
| name required | Metric Name Example : CPU Usage/Core[Basic] | string | |
| namespace_name required | Namespace Example : Virtual Server | string | |
| period optional | Statistic Period Example : 300 | any of [integer, null] | |
| statistic_type optional | Metric Statistics Type Example : AVG | any of [enum (AVG, SUM, MAX, MIN, CNT), null] |
34 - MetricDataImageRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| end required | Metric End Time - Unix Timestamp Example : 1640995440Maximum : 4102444800 | integer | |
| height optional | Chart Image Height(pixels) Example : 400 | any of [integer, null] | 500 |
| metrics required | array[MetricDataImageDto] | ||
| period required | Statistic Period Example : 300 | integer | |
| start required | Metric Start Time - Unix Timestamp Example : 1640995200Maximum : 4102444800 | integer | |
| statistic_type required | Metric Statistics Type Example : AVG | enum (AVG, SUM, MAX, MIN, CNT) | |
| timezone optional | Timezone Example : UTC | any of [string, null] | UTC |
| title optional | Chart Title Example : Virtual Server Metric Chart | any of [string, null] | |
| width optional | Chart Image Width(pixels) Example : 600 | any of [integer, null] | 1400 |
35 - MetricDataImageRequestV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| end required | Metric End Time - Unix Timestamp Example : 1640995440Maximum : 4102444800 | integer | |
| height optional | Chart Image Height(pixels) Example : 400 | any of [integer, null] | 500 |
| metrics required | array[MetricDataImageDtoV1Dot1] | ||
| period required | Statistic Period Example : 300 | integer | |
| start required | Metric Start Time - Unix Timestamp Example : 1640995200Maximum : 4102444800 | integer | |
| statistic_type required | Metric Statistics Type Example : AVG | enum (AVG, SUM, MAX, MIN, CNT) | |
| timezone optional | Timezone Example : UTC | any of [string, null] | UTC |
| title optional | Chart Title Example : Virtual Server Metric Chart | any of [string, null] | |
| width optional | Chart Image Width(pixels) Example : 600 | any of [integer, null] | 1400 |
36 - MetricDataRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| end required | Metric End Time - Unix Timestamp Example : 1640995440Maximum : 4102444800 | integer | |
| metrics required | array[MetricDetailDto] | ||
| period required | Statistic Period Example : 300 | integer | |
| start required | Metric Start Time - Unix Timestamp Example : 1640995200Maximum : 4102444800 | integer | |
| statistic_type required | Metric Statistics Type Example : AVG | enum (AVG, SUM, MAX, MIN, CNT) |
37 - MetricDataRequestV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| end required | Metric End Time - Unix Timestamp Example : 1640995440Maximum : 4102444800 | integer | |
| metrics required | array[MetricDetailDtoV1Dot1] | ||
| period required | Statistic Period Example : 300 | integer | |
| start required | Metric Start Time - Unix Timestamp Example : 1640995200Maximum : 4102444800 | integer | |
| statistic_type required | Metric Statistics Type Example : AVG | enum (AVG, SUM, MAX, MIN, CNT) |
38 - MetricDataResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| metrics required | array[MetricDataResponseDto] |
39 - MetricDataResponseDto
| Name | Description | Schema | Default |
|---|---|---|---|
| display_name required | Metric Display Name Example : Virtual Server | VirtualServer001 | CPU Usage/Core[Basic] | string | |
| status required | Example : | string | |
| values required | List of Metric Series Values Example : [[1640995200, "45.5"]] | array[array[any of [integer, string]]] |
40 - MetricDetailDto
| Name | Description | Schema | Default |
|---|---|---|---|
| dimensions required | List of Dimensions | array[MetricLabelDto] | |
| display_name optional | Metric Display Name Example : Virtual Server | VirtualServer001 | CPU Usage/Core[Basic] | any of [string, null] | |
| individual_items optional | List of Individual Items | any of [array[MetricLabelDto], null] | |
| name required | Metric Name Example : CPU Usage/Core[Basic] | string | |
| namespace_name required | Namespace Example : Virtual Server | string | |
| period optional | Statistic Period Example : 300 | any of [integer, null] | |
| statistic_type optional | Metric Statistics Type Example : AVG | any of [enum (AVG, SUM, MAX, MIN, CNT), null] |
41 - MetricDetailDtoV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| dimensions required | List of Dimensions | array[MetricLabelDto] | |
| display_name optional | Metric Display Name Example : Virtual Server | VirtualServer001 | CPU Usage/Core[Basic] | any of [string, null] | |
| name required | Metric Name Example : CPU Usage/Core[Basic] | string | |
| namespace_name required | Namespace Example : Virtual Server | string | |
| period optional | Statistic Period Example : 300 | any of [integer, null] | |
| statistic_type optional | Metric Statistics Type Example : AVG | any of [enum (AVG, SUM, MAX, MIN, CNT), null] |
42 - MetricDimensionDto
| Name | Description | Schema | Default |
|---|---|---|---|
| columns required | array[MetricsMetricColumnDto] | ||
| key required | Dimension Key Example : InstanceId | string | |
| metrics required | array[MetricListDto] |
43 - MetricDimensionDtoV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| columns required | array[MetricsMetricColumnDto] | ||
| keys required | Dimension Key Example : InstanceId | array[string] | |
| metrics required | array[MetricListDtoV1Dot1] |
44 - MetricDTO
| Name | Description | Schema | Default |
|---|---|---|---|
| color required | Metric line color Example : #ff7f0e | string | |
| dimensions required | List of Dimensions | array[DimensionDTO] | |
| display_name required | Display name (label) of the metric Example : EC2-Prod-CPU | string | |
| individual_items optional | List of Individual Items Example : [{'key': 'BucketId', 'value': 'b-1234567890abcdef0'}] | any of [array[IndividualItemDTO], null] | |
| name required | Metric Name Example : CPUUtilization | string | |
| namespace_name required | Namespace Example : Virtual Server | string | |
| period required | Query period (seconds) Example : 300 | integer | |
| statistic_type required | Statistical function Example : AVG | string |
45 - MetricDtoV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| color required | Metric line color Example : #ff7f0e | string | |
| dimensions required | List of Dimensions | array[DimensionDTO] | |
| display_name required | Display name (label) of the metric Example : EC2-Prod-CPU | string | |
| name required | Metric Name Example : CPUUtilization | string | |
| namespace_name required | Namespace Example : Virtual Server | string | |
| period required | Query period (seconds) Example : 300 | integer | |
| statistic_type required | Statistical function Example : AVG | string |
46 - MetricLabelDto
| Name | Description | Schema | Default |
|---|---|---|---|
| key required | Key Example : VolumeID | string | |
| value required | Value Example : 45fbde15-cdd2-4891-be31-4a9de75fccda | string |
47 - MetricLabelNameDto
| Name | Description | Schema | Default |
|---|---|---|---|
| key required | Key Example : VolumeID | string | |
| value required | Value Example : 45fbde15-cdd2-4891-be31-4a9de75fccda | any of [string, null] |
48 - MetricListDto
| Name | Description | Schema | Default |
|---|---|---|---|
| alerts required | List of Alerts | any of [array[MetricAlertDto], null] | |
| default_collection_interval required | Metric’s Default Collection Interval Example : 5m | enum (NONE, 1m, 5m) | |
| detailed_collection_interval required | Metric’s Detailed Collection Interval Example : 1m | enum (NONE, 1m, 5m) | |
| dimensions required | List of Dimensions | array[MetricLabelDto] | |
| id required | Metric ID Example : d91097ac-0387-4e69-adb2-7b8d453b8db5 | string | |
| individual_items optional | List of Dimensions | any of [array[MetricLabelDto], null] | |
| name required | Metric Name Example : CPU Usage/Core[Basic] | string | |
| named_dimensions required | List of Dimensions | any of [array[MetricLabelNameDto], null] | |
| namespace_id required | Namespace ID Example : d583a229-9766-4eb8-96c4-ec389902ba3d | string | |
| namespace_name required | Namespace Example : Virtual Server | string | |
| primary required | Primary Metric Example : True | boolean | |
| recommended_stat_types required | List of Recommended Metric Statistics Example : ["AVG", "MAX"] | array[string] | |
| tags required | List of Tags | any of [array[TagDTO], null] | |
| unit required | Metric Unit Example : BYTE | string |
49 - MetricListDtoV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| alerts required | List of Alerts | any of [array[MetricAlertDto], null] | |
| default_collection_interval required | Metric’s Default Collection Interval Example : 5m | enum (NONE, 1m, 5m) | |
| detailed_collection_interval required | Metric’s Detailed Collection Interval Example : 1m | enum (NONE, 1m, 5m) | |
| dimensions required | List of Dimensions | array[MetricLabelDto] | |
| id required | Metric ID Example : d91097ac-0387-4e69-adb2-7b8d453b8db5 | string | |
| name required | Metric Name Example : CPU Usage/Core[Basic] | string | |
| named_dimensions required | List of Dimensions | any of [array[MetricLabelNameDto], null] | |
| namespace_id required | Namespace ID Example : d583a229-9766-4eb8-96c4-ec389902ba3d | string | |
| namespace_name required | Namespace Example : Virtual Server | string | |
| primary required | Primary Metric Example : True | boolean | |
| recommended_stat_types required | List of Recommended Metric Statistics Example : ["AVG", "MAX"] | array[string] | |
| tags required | List of Tags | any of [array[TagDTO], null] | |
| unit required | Metric Unit Example : BYTE | string |
50 - MetricMetaDto
| Name | Description | Schema | Default |
|---|---|---|---|
| descriptionEn required | Description of Metrics in English Example : filestorage volume total byte | any of [string, null] | |
| descriptionKo required | Description of Metrics in Korean Example : 파일스토리지 총 바이트 수 | any of [string, null] | |
| dimensions required | List of Dimension Keys Example : [['image_id']] | array[array[string]] | |
| metricName required | Metric Name Example : Custom_filestorage_volume_total_byte | string | |
| storageResolution optional | Storage Resolution Example : 60 | any of [integer, null] | |
| unit required | Metric Unit Example : Bytes | any of [enum (Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, Count/Minute, None), null] |
51 - MetricNamespaceDto
| Name | Description | Schema | Default |
|---|---|---|---|
| dimensions required | array[MetricDimensionDto] | ||
| id required | Namespace ID Example : d583a229-9766-4eb8-96c4-ec389902ba3d | string | |
| name required | Namespace Example : Virtual Server | string | |
| service_name required | Example : | string |
52 - MetricNamespaceDtoV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| dimensions required | array[MetricDimensionDtoV1Dot1] | ||
| id required | Namespace ID Example : d583a229-9766-4eb8-96c4-ec389902ba3d | string | |
| name required | Namespace Example : Virtual Server | string | |
| service_name required | Example : | string |
53 - MetricSearchRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| metric_name optional | Metric Name Example : CPU Usage/Core[Basic] | any of [string, null] | |
| namespaces optional | List of Namespace | any of [array[SearchOptionNamespaceDto], null] | |
| resource_id optional | Resource ID Example : 10bf5d24-0f20-4066-bb0b-de2b1d6ff502 | any of [string, null] | |
| resource_name optional | Resource Name Example : VirtualServer01 | any of [string, null] | |
| tags optional | List of Tags | any of [array[TagDTO], null] |
54 - MetricSearchRequestV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| metric_name optional | Metric Name Example : CPU Usage/Core[Basic] | any of [string, null] | |
| namespaces optional | List of Namespace | any of [array[SearchOptionNamespaceDtoV1Dot1], null] | |
| resource_id optional | Resource ID Example : 10bf5d24-0f20-4066-bb0b-de2b1d6ff502 | any of [string, null] | |
| resource_name optional | Resource Name Example : VirtualServer01 | any of [string, null] | |
| tags optional | List of Tags | any of [array[TagDTO], null] |
55 - MetricsMetricColumnDto
| Name | Description | Schema | Default |
|---|---|---|---|
| key required | Column Key Example : name | string | |
| name_en required | Column Name Example : 지표명 | string | |
| name_ko required | Column Name Example : 지표명 | string |
56 - MetricsResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | Count Example : 1 | integer | |
| namespaces required | array[MetricNamespaceDto] |
57 - MetricsResponseV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | Count Example : 1 | integer | |
| namespaces required | array[MetricNamespaceDtoV1Dot1] |
58 - OtlpAttributeDto
| Name | Description | Schema | Default |
|---|---|---|---|
| key required | Key value of an Attribute. Generally, Resource Attributes are configured to signify the entity or environment from which the metric data was collected. Data Point Attributes represent the name of the label. Example : | string | |
| value required | Value of Attribute. There are fields that correspond to multiple types, and only a single value may be sent. If more than one value is provided, only one will be accepted and the additional values will be dropped | OtlpAttributeValueDto |
59 - OtlpAttributeValueDto
| Name | Description | Schema | Default |
|---|---|---|---|
| array_value optional | Array-typed Value of Attribute Example : | any of [array[object], null] | |
| bool_value optional | Bool-typed Value of Attribute Example : | any of [boolean, null] | |
| byte_value optional | Byte-typed Value of Attribute Example : | any of [string (binary), null] | |
| double_value optional | Double-typed Value of Attribute Example : | any of [object, null] | |
| int_value optional | Int-typed Value of Attribute Example : | any of [integer, null] | |
| kvlist_value optional | Key-Value List-typed Value of Attribute Example : | any of [object, null] | |
| string_value optional | String-typed Value of Attribute Example : | any of [string, null] |
60 - OtlpGaugeDto
| Name | Description | Schema | Default |
|---|---|---|---|
| data_points required | The dataPoints field contains a list of the actual observed values for a specific metric, where each value has a timestamp and a metric value. The value of a data point must be represented as either asInt or asDouble, and only a single value may be sent. If more than one value is provided, only one will be accepted and the additional values will be dropped | array[OtlpNumberDataPointDto] |
61 - OtlpMetricDto
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | Description of Metric Example : The total number of bytes read successfully. | any of [string, null] | |
| gauge optional | The gauge field is a metric type that represents a single value at a specific point in time, used for measuring fluctuating values like current memory usage or CPU temperature. either sum or gauge must be specified. | any of [OtlpGaugeDto, null] | |
| name required | Name of Metric Example : node_disk_read_bytes_total | string | |
| sum optional | The sum field is a metric type that represents a cumulative value over time, used for measuring quantities that only increase, like the number of requests or bytes sent. either sum or gauge must be specified. | any of [OtlpSumDto, null] | |
| unit optional | Unit of Metric Example : Bytes | any of [string, null] |
62 - OtlpNumberDataPointDto
| Name | Description | Schema | Default |
|---|---|---|---|
| as_double optional | Double-typed value of the metric Example : 0.75 | any of [object, null] | |
| as_int optional | Int-typed value of the metric Example : 10 | any of [integer, null] | |
| attributes required | Labels of Metric | array[OtlpAttributeDto] | |
| start_time_unix_nano optional | Unix timestamp, expressed in nanoseconds, for the moment when the metric data began being measured (only used for sum, not for gauge) Example : 1753776789854000000 | any of [string, null] | |
| time_unix_nano required | Unix timestamp, expressed in nanoseconds, for the moment when the metric data was measured or when the measurement ended Example : 1753776789854000000 | integer |
63 - OtlpResourceDto
| Name | Description | Schema | Default |
|---|---|---|---|
| attributes required | Resource attributes of Metric | array[OtlpAttributeDto] |
64 - OtlpResourceMetricDto
| Name | Description | Schema | Default |
|---|---|---|---|
| resource required | The resource field holds attributes that describe the entity or environment from which the metric data originated | OtlpResourceDto | |
| scope_metrics required | The scopeMetrics field holds a set of all metric data associated with a specific instrumentation library/scope | array[OtlpScopeMetricDto] |
65 - OtlpScopeDto
| Name | Description | Schema | Default |
|---|---|---|---|
| name required | Name of the Collector that collected the metric Example : ServiceWatch-Agent | string | |
| version optional | Version of the Collector that collected the metric Example : 1.0.0 | any of [string, null] |
66 - OtlpScopeMetricDto
| Name | Description | Schema | Default |
|---|---|---|---|
| metrics required | The metrics field contains a list of the actual metric data generated by the scope, where each item represents a single metric. The metric type can only be gauge or sum, and you must send exactly one value. If more than one value is provided, only one will be accepted and the additional values will be dropped | array[OtlpMetricDto] | |
| scope required | The scope field identifies the instrumentation library or scope that generated the metrics, typically including its name and version | OtlpScopeDto |
67 - OtlpSumDto
| Name | Description | Schema | Default |
|---|---|---|---|
| aggregation_temporality required | Aggregation Temporality defines the time window over which metric measurements are aggregated, specifying if the reported value is the cumulative sum (2) or the incremental change (1, Delta) since the last report or unspecified (0). Example : 2 | integer | |
| data_points required | The dataPoints field contains a list of the actual observed values for a specific metric, where each value has a timestamp and a metric value. The value of a data point must be represented as either asInt or asDouble, and only a single value may be sent. If more than one value is provided, only one will be accepted and the additional values will be dropped | array[OtlpNumberDataPointDto] | |
| is_monotonic required | Whether the value is monotonic Example : True | boolean |
68 - PropertiesDTO
| Name | Description | Schema | Default |
|---|---|---|---|
| metrics required | List of metrics included in the widget | array[MetricDTO] | |
| period optional | Query period (seconds) Example : 300 | any of [integer, null] | |
| stacked required | Whether the graph is stacked Example : False | boolean | |
| statistic_type optional | Statistical function Example : AVG | any of [string, null] | |
| title required | Widget title Example : Virtual Server | CPU Utilization | string | |
| view required | View type Example : line | string |
69 - PropertiesDtoV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| metrics required | List of metrics included in the widget | array[MetricDtoV1Dot1] | |
| period optional | Query period (seconds) Example : 300 | any of [integer, null] | |
| stacked required | Whether the graph is stacked Example : False | boolean | |
| statistic_type optional | Statistical function Example : AVG | any of [string, null] | |
| title required | Widget title Example : Virtual Server | CPU Utilization | string | |
| view required | View type Example : line | string |
70 - SearchOptionNamespaceDto
| Name | Description | Schema | Default |
|---|---|---|---|
| dimensions required | List of Dimensions Example : ["resource_id"] | array[string] | |
| name required | Namespace Example : Virtual Server | string |
71 - SearchOptionNamespaceDtoV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| dimensions required | List of Dimensions Example : [["resource_id"]] | array[array[string]] | |
| name required | Namespace Example : Virtual Server | string |
72 - TagDTO
| Name | Description | Schema | Default |
|---|---|---|---|
| key required | Tag Key Example : key01 | string | |
| value required | Tag Value Example : value01 | string |
73 - UnitLogDto
| Name | Description | Schema | Default |
|---|---|---|---|
| code required | RESPONSE STATUS CODE of Metric Example : Success | string | |
| message required | Message about Updated Unit Info Example : [libvirt_domain_info_virtual_cpus] unit is updated from Count to Bytes | string |
74 - WidgetDetailDTO
| Name | Description | Schema | Default |
|---|---|---|---|
| dashboard_id required | Dashboard’s unique ID Example : b48e730a70e74f6aa3d2555000b5c22b | string | |
| height required | Widget’s height Example : 1 | integer | |
| id required | Widget’s unique ID Example : 75da70a1a4fb486ab0282cf90693ec3c | string | |
| order required | Widget’s order in the dashboard Example : 1 | integer | |
| properties required | Widget’s detailed properties | PropertiesDTO | |
| type required | Widget type Example : metric | string | |
| width required | Widget’s width Example : 1 | integer |
75 - WidgetDetailDtoV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| dashboard_id required | Dashboard’s unique ID Example : b48e730a70e74f6aa3d2555000b5c22b | string | |
| height required | Widget’s height Example : 1 | integer | |
| id required | Widget’s unique ID Example : 75da70a1a4fb486ab0282cf90693ec3c | string | |
| order required | Widget’s order in the dashboard Example : 1 | integer | |
| properties required | Widget’s detailed properties | PropertiesDtoV1Dot1 | |
| type required | Widget type Example : metric | string | |
| width required | Widget’s width Example : 1 | integer |
76 - WidgetDTO
| Name | Description | Schema | Default |
|---|---|---|---|
| height required | Widget’s height Example : 1 | integer | |
| order required | Widget’s order in the dashboard Example : 1 | integer | |
| properties required | Widget’s detailed properties | PropertiesDTO | |
| type required | Widget type Example : metric | string | |
| width required | Widget’s width Example : 1 | integer |