Cloud Monitoring

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 응용 프로그램 인터페이스(Application Programming Interface, API)를 제공합니다.

본 가이드는 MONITORING 서비스에 대한 간략한 설명 및 API를 호출하는 방법을 제공합니다. API는 RESTful API 방식으로 제공되며, JSON 형식으로 응답합니다.

Version

VersionStatusSupported Until
1.0DEPRECATED20260223

OpenAPI URL

https://cloudmonitoring.{region}.{environment}.samsungsdscloud.com

Environment and Region List

environmentregion
skr-west1
skr-east1
gkr-south1
gkr-south2
gkr-south3
ekr-west1
ekr-east1

1 - APIs

1.1 - CreateEventPolicy

1.1.1 - 1.0

post /v1/cloudmonitorings/event/v2/event-policies

Description

Create Event Policy

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.020260701

Parameters

TypeNameDescriptionSchemaDefault
headerX-ResourceType
required
Resource Type
Example :
stringNone
bodybody
required

EventPolicyCreateRequest

Responses

HTTP CodeDescriptionSchema
200OKEventPolicyDetailResponse
201OK(Created)EventPolicyDetailResponse
400Invalid RequestNone
401Monitoring User Not FoundNone
403Unauthorized RequestNone
404Resource Not FoundNone

Example HTTP request

Request path

/v1/cloudmonitorings/event/v2/event-policies

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = cloudmonitoring 1.0"

Request body

{
    "eventPolicyRequest": {
        "disableYn": "N",
        "eventLevel": "WARNING",
        "eventMessagePrefix": "SCP",
        "eventOccurTimeZone": "GMT+9",
        "eventPolicyStatistics": {
            "eventPolicyStatisticsPeriod": 10,
            "eventPolicyStatisticsType": "MAX"
        },
        "eventThreshold": {
            "metricFunction": "delta",
            "rangeThreshold": {
                "maxComparisonOperator": "LT",
                "maxValue": 90,
                "minComparisonOperator": "GT",
                "minValue": 80
            },
            "singleThreshold": {
                "comparisonOperator": "LT",
                "value": 10
            },
            "thresholdType": "RANGE_VALUE"
        },
        "ftCount": 3,
        "isLogMetric": "N",
        "metricKey": "system.diskio.read.bytes",
        "metricName": "",
        "objectDisplayName": "dm0",
        "objectName": "dm0",
        "objectType": "SCP",
        "podObjectDisplayName": "dm0",
        "podObjectName": "dm0"
    },
    "notificationRecipients": [
        {
            "notificationMethods": [
                {
                    "eventLevel": "FATAL",
                    "notificationMethod": "",
                    "sendMethod": [
                        "MAIL"
                    ]
                }
            ],
            "recipientKey": "1347",
            "recipientType": "USER"
        }
    ],
    "productResourceId": "INSTANCE-c4Hsd27ttDaLw533X4B6Sp"
}

Example HTTP response

Response 200

{
    "asgYn": "",
    "attrListStr": "",
    "checkAsg": "",
    "createBy": "",
    "createById": "",
    "createdBy": "",
    "createdByName": "",
    "createdDt": "2026-02-11T06:41:19.229Z",
    "disableObject": "N",
    "disableYn": "",
    "displayEventRule": "SCP",
    "eventLevel": "WARNING",
    "eventMessagePrefix": "SCP",
    "eventOccurTimeZone": "GMT+9",
    "eventPolicyId": 7226,
    "eventPolicyStatistics": {
        "eventPolicyStatisticsPeriod": 10,
        "eventPolicyStatisticsType": "MAX"
    },
    "eventThreshold": {
        "metricFunction": "delta",
        "rangeThreshold": {
            "maxComparisonOperator": "LT",
            "maxValue": 90,
            "minComparisonOperator": "GT",
            "minValue": 80
        },
        "singleThreshold": {
            "comparisonOperator": "LT",
            "value": 10
        },
        "thresholdType": "RANGE_VALUE"
    },
    "ftCount": 3,
    "groupSummary": {
        "groupName": "",
        "groupResourceId": "",
        "groupSq": "",
        "productList": [
            {
                "productName": "",
                "productResourceId": "",
                "productSq": ""
            }
        ],
        "productTypeCode": "",
        "productTypeName": ""
    },
    "isLogMetric": "N",
    "metricDescription": "커널에서 사용한 CPU 시간의 백분율 (core 4개 모두를 100%사용하는 경우 : 400%)",
    "metricDescriptionEn": "Percentage of CPU time used in the kernel (if 100% of all 4 cores are used: 400%)",
    "metricKey": "system.cpu.system.pct",
    "metricName": "system.cpu.system.pct",
    "metricSummary": {
        "isLogMetric": "N",
        "isObjectExist": "Y",
        "metricDescription": "커널에서 사용한 CPU 시간의 백분율 (core 4개 모두를 100%사용하는 경우 : 400%)",
        "metricDescriptionEn": "Percentage of CPU time used in the kernel (if 100% of all 4 cores are used: 400%)",
        "metricKey": "system.cpu.system.pct",
        "metricName": "system.cpu.system.pct",
        "metricSetKey": "system.cpu",
        "metricSetName": "CPU",
        "metricType": "NUM",
        "metricUnit": "bytes",
        "productTargetType": "system.core.id 별",
        "productTargetTypeEn": "By system.core.id"
    },
    "metricType": "NUM",
    "metricUnit": "%",
    "modifiedBy": "",
    "modifiedByName": "",
    "modifiedDt": "2026-02-11T06:41:19.230Z",
    "objectDisplayName": "/tmp",
    "objectName": "/tmp",
    "objectType": "cluster",
    "objectTypeName": "cluster",
    "productInfoAttrs": [
        {
            "attrName": "type",
            "attrValue": "test"
        }
    ],
    "productName": "adad-002",
    "productResourceId": "INSTANCE-c4Hsd27ttDaLw533X4B6Sp",
    "productSq": 7234,
    "productSummary": {
        "agentState": "Running",
        "lbName": "lbName",
        "lbSize": "MEDIUM",
        "productIpAddress": "192.168.1.2",
        "productName": "VM-002",
        "productResourceId": "INSTANCE-c4Hsd27ttDaLw533X4B6Sp",
        "productSq": 8703,
        "productState": "Running",
        "productSubName": "productSubName",
        "productSubType": "replicaset",
        "productTypeCode": "VM",
        "productTypeName": "Virtual Server",
        "vpcName": "vpcName"
    },
    "productTargetType": "system.core.id 별",
    "productTargetTypeEn": "By system.core.id",
    "startDt": "2021-10-23T18:00:00Z",
    "updateBy": "",
    "updateById": "",
    "userNameList": [
        "userName",
        "userName"
    ],
    "userNameStr": "",
    "userNames": "N"
}

1.2 - DeleteEventPolicy

1.2.1 - 1.0

delete /v1/cloudmonitorings/event/v2/event-policies/{eventPolicyId}

Description

Delete Event policy

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.020260701

Parameters

TypeNameDescriptionSchemaDefault
patheventPolicyId
required
Event policy ID to delete - Event Policy ID can be viewed using @[ListEventPolicies].
Example : 7226
integerNone
headerX-ResourceType
required
Resource Type
Example :
stringNone

Responses

HTTP CodeDescriptionSchema
200OKNone
204OK(No Contents)None
400Invalid RequestNone
401Monitoring User Not FoundNone
403Unauthorized RequestNone
404Resource Not FoundNone

Example HTTP request

Request path

/v1/cloudmonitorings/event/v2/event-policies/{eventPolicyId}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = cloudmonitoring 1.0"

Example HTTP response

Response 200

1.3 - ListAccountEvents

1.3.1 - 1.0

get /v1/cloudmonitorings/event/v2/accounts/events

Description

Search Account Event List

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.020260701

Parameters

TypeNameDescriptionSchemaDefault
queryeventState
required
Event State
Example : ALL
stringNone
queryqueryStartDt
required
Query Start Date
Example : 2021-10-23T18:00:00.000Z
stringNone
queryqueryEndDt
required
Query End Date
Example : 2021-10-23T23:59:59.000Z
stringNone
querypage
optional
Page Number (default: 0)
Example : 0
integerNone
querysize
optional
Page Contents Size (default: 10)
Example : 10
integerNone
querysort
optional
Sorting Field List
array[string]None

Responses

HTTP CodeDescriptionSchema
200OKPageResponseOpenApiEventResponse
400Invalid RequestNone

Example HTTP request

Request path

/v1/cloudmonitorings/event/v2/accounts/events?eventState={eventState}&queryStartDt={queryStartDt}&queryEndDt={queryEndDt}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = cloudmonitoring 1.0"

Example HTTP response

Response 200

{
    "contents": [
        {
            "durationSecond": 100,
            "endDt": "2021-10-23T23:59:59Z",
            "eventId": "",
            "eventLevel": "FATAL",
            "eventMessage": "",
            "eventPolicyId": 7240,
            "eventState": "ACTIVE",
            "metricKey": "system.cpu.system.norm.pct",
            "metricName": "system.cpu.system.norm.pct",
            "objectDisplayName": "CPU0",
            "objectName": "CPU0",
            "objectType": "cluster",
            "objectTypeName": "cluster",
            "productResourceId": "INSTANCE-c4Hsd27ttDaLw533X4B6Sp",
            "productTargetType": "system.core.id 별",
            "productTargetTypeEn": "By system.core.id",
            "productTypeName": "Virtual Server",
            "startDt": "2021-10-23T18:00:00Z"
        }
    ],
    "isChanged": "",
    "returnCount": "",
    "returnPage": "",
    "sort": [
        ""
    ],
    "sortableFields": [
        ""
    ],
    "totalCount": ""
}

1.4 - ListAccountMember

1.4.1 - 1.0

get /v1/cloudmonitorings/product/v1/accounts/members

Description

Search members included in an Account.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.020260701

Parameters

TypeNameDescriptionSchemaDefault
querypage
optional
Page Number (default: 0)
Example : 0
integerNone
querysize
optional
Page Contents Size (default: 10)
Example : 10
integerNone
querysort
optional
Sorting Field List
array[string]None

Responses

HTTP CodeDescriptionSchema
200OKPageResponseJsonArrayProjectMemberResponseForOpenAPI
400Invalid RequestNone
401Monitoring User Not FoundNone
403Unauthorized RequestNone
404Resource Not FoundNone

Example HTTP request

Request path

/v1/cloudmonitorings/product/v1/accounts/members

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = cloudmonitoring 1.0"

Example HTTP response

Response 200

{
    "contents": [
        {
            "companyName": "삼성SDS",
            "createdBy": "469",
            "createdByEmail": "soonshin.lee@cloud.com",
            "createdByName": "이순신",
            "createdDt": "2021-08-06T10:23:41.547Z",
            "email": "kdhong@cloud.com",
            "lastAccessDt": "2022-11-06T10:23:41.547Z",
            "modifiedBy": "469",
            "modifiedByEmail": "soonshin.lee@cloud.com",
            "modifiedByName": "이순신",
            "modifiedDt": "2021-08-06T10:23:41.547Z",
            "organizationId": "",
            "positionName": "프로",
            "userGroupCount": "10",
            "userId": "1984",
            "userName": "홍길동"
        }
    ],
    "returnCount": 10,
    "returnPage": 1,
    "sort": [
        ""
    ],
    "sortableFields": [
        ""
    ],
    "totalCount": 100
}

1.5 - ListAccountResources

1.5.1 - 1.0

get /v1/cloudmonitorings/product/v2/accounts/products

Description

Search Resource included in an Account.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.020260701

Parameters

TypeNameDescriptionSchemaDefault
querypage
optional
Page Number (default: 0)
Example : 0
integerNone
querysize
optional
Page Contents Size (default: 10)
Example : 10
integerNone
querysort
optional
Sorting Field List
array[string]None
headerX-ResourceType
required
Resource Type
Example :
stringNone

Responses

HTTP CodeDescriptionSchema
200OKPageResponseAccountProductDto
400Invalid RequestNone
401Monitoring User Not FoundNone
403Unauthorized RequestNone
404Resource Not FoundNone

Example HTTP request

Request path

/v1/cloudmonitorings/product/v2/accounts/products

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = cloudmonitoring 1.0"

Example HTTP response

Response 200

{
    "contents": [
        {
            "accountId": "UqXgOSnoqOfKB0_LKO6xId",
            "endDt": "9999-12-31T23:59:59.999Z",
            "lastEventLevel": "WARNING",
            "poolName": "POOL-A8-C1DpGqRdQMlfNXdJxLb",
            "productIpAddress": "192.168.245.161",
            "productName": "VM-Server-01",
            "productResourceId": "INSTANCE-c4Hsd27ttDaLw533X4B6Sp",
            "productState": "Running",
            "productTypeCode": "VM",
            "productTypeName": "Virtual Server",
            "startDt": "2021-10-23T08:30:00Z"
        }
    ],
    "isChanged": "",
    "returnCount": "",
    "returnPage": "",
    "sort": [
        ""
    ],
    "sortableFields": [
        ""
    ],
    "totalCount": ""
}

1.6 - ListAddressBookMembers

1.6.1 - 1.0

get /v1/cloudmonitorings/product/v2/addrbooks/{addrbookId}/members

Description

Search address book members

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.020260701

Parameters

TypeNameDescriptionSchemaDefault
pathaddrbookId
required
Address book ID - Address book IDs can be obtained from @[ListAddressBooks].
Example :
integerNone
querypage
optional
Page Number (default: 0)
Example : 0
integerNone
querysize
optional
Page Contents Size (default: 10)
Example : 10
integerNone
querysort
optional
Sorting Field List
array[string]None

Responses

HTTP CodeDescriptionSchema
200OKPageResponseAlarmAddrBookMemberDto
400Invalid RequestNone
401Monitoring User Not FoundNone
403Unauthorized RequestNone
404Resource Not FoundNone

Example HTTP request

Request path

/v1/cloudmonitorings/product/v2/addrbooks/{addrbookId}/members

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = cloudmonitoring 1.0"

Example HTTP response

Response 200

{
    "contents": [
        {
            "userEmail": "kdhong@cloud.com",
            "userId": "1346",
            "userLanguage": "ko",
            "userMobileTelNo": "010-0000-0000",
            "userName": "홍길동",
            "userTimezone": "Asia/Seoul"
        }
    ],
    "isChanged": "",
    "returnCount": "",
    "returnPage": "",
    "sort": [
        ""
    ],
    "sortableFields": [
        ""
    ],
    "totalCount": ""
}

1.7 - ListAddressBooks

1.7.1 - 1.0

get /v1/cloudmonitorings/product/v2/users/addrbooks

Description

Search a list of address books created by user.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.020260701

Parameters

TypeNameDescriptionSchemaDefault
querypage
optional
Page Number (default: 0)
Example : 0
integerNone
querysize
optional
Page Contents Size (default: 10)
Example : 10
integerNone
querysort
optional
Sorting Field List
array[string]None

Responses

HTTP CodeDescriptionSchema
200OKPageResponseAlarmAddrBookDto
400Invalid RequestNone
401Monitoring User Not FoundNone
403Unauthorized RequestNone
404Resource Not FoundNone

Example HTTP request

Request path

/v1/cloudmonitorings/product/v2/users/addrbooks

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = cloudmonitoring 1.0"

Example HTTP response

Response 200

{
    "contents": [
        {
            "addrBookName": "contact name",
            "addrbookId": "74",
            "createdBy": "1984",
            "createdByName": "김삼성",
            "createdDt": "2021-10-23T22:00:00Z",
            "memberCount": 10
        }
    ],
    "isChanged": "",
    "returnCount": "",
    "returnPage": "",
    "sort": [
        ""
    ],
    "sortableFields": [
        ""
    ],
    "totalCount": ""
}

1.8 - ListEventPolicies

1.8.1 - 1.0

get /v1/cloudmonitorings/event/v2/event-policies

Description

Search Event Policies

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.020260701

Parameters

TypeNameDescriptionSchemaDefault
queryproductResourceId
required
Product Resource ID - Product Resource ID can be viewed using @[ListAccountResources].
Example : c94607c8-6a15-4e13-84f3-99cb77d478e3
stringNone
querymetricKey
optional
Metric Key - Metric Key can be viewed using @[ListMetrics].
Example : system.cpu.system.pct
stringNone
querypage
optional
Page Number (default: 0)
Example : 0
integerNone
querysize
optional
Page Contents Size (default: 10)
Example : 10
integerNone
querysort
optional
Sorting Field List
array[string]None
headerX-ResourceType
required
Resource Type
Example :
stringNone

Responses

HTTP CodeDescriptionSchema
200OKPageResponseEventPolicyResponse
400Invalid RequestNone
401Monitoring User Not FoundNone
403Unauthorized RequestNone
404Resource Not FoundNone

Example HTTP request

Request path

/v1/cloudmonitorings/event/v2/event-policies?productResourceId={productResourceId}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = cloudmonitoring 1.0"

Example HTTP response

Response 200

{
    "contents": [
        {
            "checkAsg": "",
            "createBy": "",
            "createById": "",
            "eventLevel": "WARNING",
            "eventMessagePrefix": "SCP",
            "eventOccurTimeZone": "GMT+9",
            "eventPolicyId": 7226,
            "eventPolicyStatistics": {
                "eventPolicyStatisticsPeriod": 10,
                "eventPolicyStatisticsType": "MAX"
            },
            "eventThreshold": {
                "metricFunction": "delta",
                "rangeThreshold": {
                    "maxComparisonOperator": "LT",
                    "maxValue": 90,
                    "minComparisonOperator": "GT",
                    "minValue": 80
                },
                "singleThreshold": {
                    "comparisonOperator": "LT",
                    "value": 10
                },
                "thresholdType": "RANGE_VALUE"
            },
            "ftCount": 3,
            "isLogMetric": "N",
            "metricDescription": "커널에서 사용한 CPU 시간의 백분율 (core 4개 모두를 100%사용하는 경우 : 400%)",
            "metricDescriptionEn": "Percentage of CPU time used in the kernel (if 100% of all 4 cores are used: 400%)",
            "metricKey": "system.cpu.system.pct",
            "metricName": "system.cpu.system.pct",
            "objectName": "cpu0",
            "productName": "VM-002",
            "productResourceId": "INSTANCE-c4Hsd27ttDaLw533X4B6Sp",
            "productSq": 7321,
            "productTargetType": "system.core.id 별",
            "productTargetTypeEn": "By system.core.id",
            "updateBy": "",
            "updateById": ""
        }
    ],
    "isChanged": "",
    "returnCount": "",
    "returnPage": "",
    "sort": [
        ""
    ],
    "sortableFields": [
        ""
    ],
    "totalCount": ""
}

1.9 - ListEventPolicyHistories

1.9.1 - 1.0

get /v1/cloudmonitorings/event/v2/event-policies/{eventPolicyId}/histories

Description

Search event policy histories

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.020260701

Parameters

TypeNameDescriptionSchemaDefault
patheventPolicyId
required
Event Policy ID to inquire - Event Policy ID can be viewed using @[ListEventPolicies].
Example : 7226
integerNone
queryqueryStartDt
required
Query Start Date
Example : 2021-10-23T18:00:00.000Z
stringNone
queryqueryEndDt
required
Query End Date
Example : 2021-10-23T23:59:59.000Z
stringNone
querypage
optional
Page Number (default: 0)
Example : 0
integerNone
querysize
optional
Page Contents Size (default: 10)
Example : 10
integerNone
querysort
optional
Sorting Field List
array[string]None
headerX-ResourceType
required
Resource Type
Example :
stringNone

Responses

HTTP CodeDescriptionSchema
200OKPageResponseEventPolicyHistoryResponse
400Invalid RequestNone
401Monitoring User Not FoundNone
403Unauthorized RequestNone
404Resource Not FoundNone

Example HTTP request

Request path

/v1/cloudmonitorings/event/v2/event-policies/{eventPolicyId}/histories?queryStartDt={queryStartDt}&queryEndDt={queryEndDt}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = cloudmonitoring 1.0"

Example HTTP response

Response 200

{
    "contents": [
        {
            "createBy": "",
            "createById": "",
            "disableObject": "N",
            "disableYn": "N",
            "eventLevel": "WARNING",
            "eventMessagePrefix": "SCP",
            "eventOccurTimeZone": "GMT+9",
            "eventPolicyHistoryId": 8759,
            "eventPolicyHistoryType": "U",
            "eventPolicyId": 7240,
            "eventPolicyStatistics": {
                "eventPolicyStatisticsPeriod": 10,
                "eventPolicyStatisticsType": "MAX"
            },
            "eventThreshold": {
                "metricFunction": "delta",
                "rangeThreshold": {
                    "maxComparisonOperator": "LT",
                    "maxValue": 90,
                    "minComparisonOperator": "GT",
                    "minValue": 80
                },
                "singleThreshold": {
                    "comparisonOperator": "LT",
                    "value": 10
                },
                "thresholdType": "RANGE_VALUE"
            },
            "ftCount": 3,
            "metricDescription": "커널에서 사용한 CPU 시간의 백분율 (core 4개 모두를 100%사용하는 경우 : 400%)",
            "metricDescriptionEn": "Percentage of CPU time used in the kernel (if 100% of all 4 cores are used: 400%)",
            "metricKey": "system.cpu.system.pct",
            "metricName": "system.cpu.system.pct",
            "metricUnit": "%",
            "modifiedBy": "",
            "modifiedByName": "",
            "modifiedDt": "2026-02-11T06:41:19.370Z",
            "notificationRecipientHistory": {
                "addrbookIds": [
                    ""
                ],
                "userIds": [
                    ""
                ],
                "userNames": [
                    ""
                ]
            },
            "objectDisplayName": "cpu0",
            "objectName": "cpu0",
            "objectType": "cluster",
            "productName": "VM-Server-01",
            "productResourceId": "INSTANCE-c4Hsd27ttDaLw533X4B6Sp",
            "productTargetType": "system.core.id 별",
            "productTargetTypeEn": "By system.core.id",
            "updateBy": "",
            "updateById": ""
        }
    ],
    "isChanged": "",
    "returnCount": "",
    "returnPage": "",
    "sort": [
        ""
    ],
    "sortableFields": [
        ""
    ],
    "totalCount": ""
}

1.10 - ListEventPolicyNotification

1.10.1 - 1.0

get /v1/cloudmonitorings/event/v2/event-policies/{eventPolicyId}/notifications

Description

Search Event Policy Notification

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.020260701

Parameters

TypeNameDescriptionSchemaDefault
querypage
optional
Page Number (default: 0)
Example : 0
integerNone
querysize
optional
Page Contents Size (default: 10)
Example : 10
integerNone
querysort
optional
Sorting Field List
array[string]None
patheventPolicyId
required
Event Policy ID to inquire - Event Policy ID can be viewed using @[ListEventPolicies].
Example : 7226
integerNone
headerX-ResourceType
required
Resource Type
Example :
stringNone

Responses

HTTP CodeDescriptionSchema
200OKPageResponseNotificationResponse
400Invalid RequestNone
401Monitoring User Not FoundNone
403Unauthorized RequestNone
404Resource Not FoundNone

Example HTTP request

Request path

/v1/cloudmonitorings/event/v2/event-policies/{eventPolicyId}/notifications

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = cloudmonitoring 1.0"

Example HTTP response

Response 200

{
    "contents": [
        {
            "addrbookAdditionalInfo": {
                "memberCount": 4,
                "userAdditionalInfo": [
                    {
                        "account_id": "",
                        "company_name": "",
                        "dst_offset": "",
                        "email": "",
                        "id": "",
                        "last_login_at": "",
                        "member_created_at": "",
                        "password_reuse_count": "",
                        "timezone": "",
                        "tz_id": "",
                        "user_name": "",
                        "utc_offset": ""
                    }
                ]
            },
            "notificationMethods": [
                {
                    "eventLevel": "FATAL",
                    "notificationMethod": "",
                    "sendMethod": [
                        "MAIL"
                    ]
                }
            ],
            "recipientKey": "1984",
            "recipientName": "홍길동",
            "recipientType": "USER",
            "userAdditionalInfo": {
                "account_id": "",
                "company_name": "",
                "dst_offset": "",
                "email": "",
                "id": "",
                "last_login_at": "",
                "member_created_at": "",
                "password_reuse_count": "",
                "timezone": "",
                "tz_id": "",
                "user_name": "",
                "utc_offset": ""
            }
        }
    ],
    "isChanged": "",
    "returnCount": "",
    "returnPage": "",
    "sort": [
        ""
    ],
    "sortableFields": [
        ""
    ],
    "totalCount": ""
}

1.11 - ListMetricPefData

1.11.1 - 1.0

post /v1/cloudmonitorings/product/v2/metric-data

Description

Search the performance values of the collected metrics. Up to 10 query conditions can be specified, and the maximum query period is 24 hours.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.020260701

Parameters

TypeNameDescriptionSchemaDefault
headerX-ResourceType
required
Resource Type
Example :
stringNone
bodybody
required

MetricDataSearchCriteriaOpenAPIV2

Responses

HTTP CodeDescriptionSchema
200OKListResponseMetricStatisticsDataDtoOpenAPIV2
201OK(Created)ListResponseMetricStatisticsDataDtoOpenAPIV2
400Invalid RequestNone
401Monitoring User Not FoundNone
403Unauthorized RequestNone
404Resource Not FoundNone

Example HTTP request

Request path

/v1/cloudmonitorings/product/v2/metric-data

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = cloudmonitoring 1.0"

Request body

{
    "ignoreInvalid": "Y",
    "metricDataConditions": [
        {
            "metricKey": "system.diskio.read.bytes",
            "objectType": "replicaset",
            "productResourceInfos": [
                {
                    "objectList": [
                        "kube-01",
                        "kube-02"
                    ],
                    "productResourceId": "INSTANCE-c4Hsd27ttDaLw533X4B6Sp"
                }
            ],
            "statisticsPeriod": 5,
            "statisticsTypeList": [
                "SUM",
                "MIN"
            ]
        }
    ],
    "queryEndDt": "2022-08-07T23:59:00.000Z",
    "queryStartDt": "2022-08-07T23:50:00.000Z"
}

Example HTTP response

Response 200

{
    "contents": [
        {
            "metricKey": "system.filesystem.used.bytes",
            "metricName": "system.filesystem.used.bytes",
            "metricType": "NUM",
            "metricUnit": "bytes",
            "objectDisplayName": "dm-1",
            "objectName": "dm-1",
            "objectType": "replicaset",
            "perfData": [
                {
                    "time": 1627378200000,
                    "value": "0.0766"
                }
            ],
            "productName": "VM-Server-01",
            "productResourceId": "INSTANCE-c4Hsd27ttDaLw533X4B6Sp",
            "statisticsPeriod": 5,
            "statisticsType": "SUM"
        }
    ],
    "totalCount": ""
}

1.12 - ListMetrics

1.12.1 - 1.0

get /v1/cloudmonitorings/product/v2/metrics

Description

View the list of metrics provided by Monitoring. You can view the full list of metrics or the list of metrics for each service type.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.020260701

Parameters

TypeNameDescriptionSchemaDefault
queryproductTypeCode
optional
Product type code - Product type codes can be obtained using @[ListServiceMonitoring]. If not specified, the entire metric list will be retrieved.
Example : VM
stringNone
queryobjectType
optional
Object Type - Only available for services that have subtypes, such as when the ‘productTypeCode’ is ‘Kubernetes’ or ‘Load Balancer’.
Example : node
stringNone
querypage
optional
Page Number (default: 0)
Example : 0
integerNone
querysize
optional
Page Contents Size (default: 10)
Example : 10
integerNone
querysort
optional
Sorting Field List
array[string]None

Responses

HTTP CodeDescriptionSchema
200OKPageResponseMetricInfoDto
400Invalid RequestNone
401Monitoring User Not FoundNone
403Unauthorized RequestNone
404Resource Not FoundNone

Example HTTP request

Request path

/v1/cloudmonitorings/product/v2/metrics

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = cloudmonitoring 1.0"

Example HTTP response

Response 200

{
    "contents": [
        {
            "disableObject": "N",
            "displayUnit": "",
            "fixedUnit": "sec",
            "isLogMetric": "N",
            "isObjectExist": "Y",
            "metricDescription": "커널에서 사용한 CPU 시간의 백분율 (core 4개 모두를 100%사용하는 경우 : 400%)",
            "metricDescriptionEn": "Percentage of CPU time used in the kernel (if 100% of all 4 cores are used: 400%)",
            "metricKey": "system.filesystem.used.bytes",
            "metricName": "FileSystem",
            "metricOrder": 1,
            "metricSetKey": "system.filesystem",
            "metricSetName": "FileSystem",
            "metricType": "NUM",
            "metricUnit": "bytes",
            "objectKeyName": "system.core.iowait.pct",
            "objectType": "N",
            "objectTypeNameEng": "N",
            "objectTypeNameLoc": "N",
            "perfTitle": "File System",
            "productTargetType": "system.core.id 별",
            "productTargetTypeEn": "By system.core.id",
            "productTypeCode": "VM",
            "productTypeName": "Virtual Server"
        }
    ],
    "isChanged": "",
    "returnCount": "",
    "returnPage": "",
    "sort": [
        ""
    ],
    "sortableFields": [
        ""
    ],
    "totalCount": ""
}

1.13 - ListResourceEvents

1.13.1 - 1.0

get /v1/cloudmonitorings/event/v2/events

Description

Search a list of events that occurred on a product resource.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.020260701

Parameters

TypeNameDescriptionSchemaDefault
queryproductResourceId
required
Product Resource ID - Product Resource ID can be viewed using @[ListAccountResources].
Example : INSTANCE-c4Hsd27ttDaLw533X4B6Sp
stringNone
querymetricKey
optional
Metric Key - Metric Key can be viewed using @[ListMetrics].
Example : system.cpu.system.pct
stringNone
queryeventState
required
Event State
Example : ALL
stringNone
queryqueryStartDt
required
Query Start Date
Example : 2021-10-23T18:00:00.000Z
stringNone
queryqueryEndDt
required
Query End Date
Example : 2021-10-23T23:59:59.000Z
stringNone
querypage
optional
Page Number (default: 0)
Example : 0
integerNone
querysize
optional
Page Contents Size (default: 10)
Example : 10
integerNone
querysort
optional
Sorting Field List
array[string]None
headerX-ResourceType
required
Resource Type
Example :
stringNone

Responses

HTTP CodeDescriptionSchema
200OKPageResponseOpenApiEventResponse
400Invalid RequestNone
403Unauthorized RequestNone
404Resource Not FoundNone

Example HTTP request

Request path

/v1/cloudmonitorings/event/v2/events?productResourceId={productResourceId}&eventState={eventState}&queryStartDt={queryStartDt}&queryEndDt={queryEndDt}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = cloudmonitoring 1.0"

Example HTTP response

Response 200

{
    "contents": [
        {
            "durationSecond": 100,
            "endDt": "2021-10-23T23:59:59Z",
            "eventId": "",
            "eventLevel": "FATAL",
            "eventMessage": "",
            "eventPolicyId": 7240,
            "eventState": "ACTIVE",
            "metricKey": "system.cpu.system.norm.pct",
            "metricName": "system.cpu.system.norm.pct",
            "objectDisplayName": "CPU0",
            "objectName": "CPU0",
            "objectType": "cluster",
            "objectTypeName": "cluster",
            "productResourceId": "INSTANCE-c4Hsd27ttDaLw533X4B6Sp",
            "productTargetType": "system.core.id 별",
            "productTargetTypeEn": "By system.core.id",
            "productTypeName": "Virtual Server",
            "startDt": "2021-10-23T18:00:00Z"
        }
    ],
    "isChanged": "",
    "returnCount": "",
    "returnPage": "",
    "sort": [
        ""
    ],
    "sortableFields": [
        ""
    ],
    "totalCount": ""
}

1.14 - ListService

1.14.1 - 1.0

get /v1/cloudmonitorings/product/v1/product-types

Description

Search a list of product types supported by monitoring.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.020260701

Parameters

TypeNameDescriptionSchemaDefault
queryproductCategoryCode
optional
Product type category - If not specified, the entire product type code will be retrieved.
Example : Compute
stringNone
querypage
optional
Page Number (default: 0)
Example : 0
integerNone
querysize
optional
Page Contents Size (default: 10)
Example : 10
integerNone
querysort
optional
Sorting Field List
array[string]None

Responses

HTTP CodeDescriptionSchema
200OKPageResponseProductTypeInfoDto
400Invalid RequestNone
401Monitoring User Not FoundNone
403Unauthorized RequestNone
404Resource Not FoundNone

Example HTTP request

Request path

/v1/cloudmonitorings/product/v1/product-types

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = cloudmonitoring 1.0"

Example HTTP response

Response 200

{
    "contents": [
        {
            "parentProductTypeName": "Compute",
            "productTypeCode": "VM",
            "productTypeName": "Virtual Server",
            "stateMetricKey": "vsphere.mxvm.runtime.state"
        }
    ],
    "isChanged": "",
    "returnCount": "",
    "returnPage": "",
    "sort": [
        ""
    ],
    "sortableFields": [
        ""
    ],
    "totalCount": ""
}

1.15 - SetEventPolicy

1.15.1 - 1.0

put /v1/cloudmonitorings/event/v2/event-policies/{eventPolicyId}

Description

Set Event Policy

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.020260701

Parameters

TypeNameDescriptionSchemaDefault
patheventPolicyId
required
Event policy ID to modify - Event Policy ID can be viewed using @[ListEventPolicies].
Example : 7226
integerNone
headerX-ResourceType
required
Resource Type
Example :
stringNone
bodybody
required

EventPolicyUpdateRequest

Responses

HTTP CodeDescriptionSchema
200OKEventPolicyDetailResponse
201OK(Created)EventPolicyDetailResponse
400Invalid RequestNone
401Monitoring User Not FoundNone
403Unauthorized RequestNone
404Resource Not FoundNone
500Internal Server ErrorNone

Example HTTP request

Request path

/v1/cloudmonitorings/event/v2/event-policies/{eventPolicyId}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = cloudmonitoring 1.0"

Request body

{
    "eventPolicyRequest": {
        "disableYn": "N",
        "eventLevel": "WARNING",
        "eventMessagePrefix": "SCP",
        "eventOccurTimeZone": "GMT+9",
        "eventPolicyStatistics": {
            "eventPolicyStatisticsPeriod": 10,
            "eventPolicyStatisticsType": "MAX"
        },
        "eventThreshold": {
            "metricFunction": "delta",
            "rangeThreshold": {
                "maxComparisonOperator": "LT",
                "maxValue": 90,
                "minComparisonOperator": "GT",
                "minValue": 80
            },
            "singleThreshold": {
                "comparisonOperator": "LT",
                "value": 10
            },
            "thresholdType": "RANGE_VALUE"
        },
        "ftCount": 3,
        "objectDisplayName": "cpu0",
        "objectName": "cpu0",
        "objectType": "cluster",
        "podObjectDisplayName": "cpu0",
        "podObjectName": "cpu0"
    },
    "notificationRecipients": [
        {
            "notificationMethods": [
                {
                    "eventLevel": "FATAL",
                    "notificationMethod": "",
                    "sendMethod": [
                        "MAIL"
                    ]
                }
            ],
            "recipientKey": "1347",
            "recipientType": "USER"
        }
    ]
}

Example HTTP response

Response 200

{
    "asgYn": "",
    "attrListStr": "",
    "checkAsg": "",
    "createBy": "",
    "createById": "",
    "createdBy": "",
    "createdByName": "",
    "createdDt": "2026-02-11T06:41:19.229Z",
    "disableObject": "N",
    "disableYn": "",
    "displayEventRule": "SCP",
    "eventLevel": "WARNING",
    "eventMessagePrefix": "SCP",
    "eventOccurTimeZone": "GMT+9",
    "eventPolicyId": 7226,
    "eventPolicyStatistics": {
        "eventPolicyStatisticsPeriod": 10,
        "eventPolicyStatisticsType": "MAX"
    },
    "eventThreshold": {
        "metricFunction": "delta",
        "rangeThreshold": {
            "maxComparisonOperator": "LT",
            "maxValue": 90,
            "minComparisonOperator": "GT",
            "minValue": 80
        },
        "singleThreshold": {
            "comparisonOperator": "LT",
            "value": 10
        },
        "thresholdType": "RANGE_VALUE"
    },
    "ftCount": 3,
    "groupSummary": {
        "groupName": "",
        "groupResourceId": "",
        "groupSq": "",
        "productList": [
            {
                "productName": "",
                "productResourceId": "",
                "productSq": ""
            }
        ],
        "productTypeCode": "",
        "productTypeName": ""
    },
    "isLogMetric": "N",
    "metricDescription": "커널에서 사용한 CPU 시간의 백분율 (core 4개 모두를 100%사용하는 경우 : 400%)",
    "metricDescriptionEn": "Percentage of CPU time used in the kernel (if 100% of all 4 cores are used: 400%)",
    "metricKey": "system.cpu.system.pct",
    "metricName": "system.cpu.system.pct",
    "metricSummary": {
        "isLogMetric": "N",
        "isObjectExist": "Y",
        "metricDescription": "커널에서 사용한 CPU 시간의 백분율 (core 4개 모두를 100%사용하는 경우 : 400%)",
        "metricDescriptionEn": "Percentage of CPU time used in the kernel (if 100% of all 4 cores are used: 400%)",
        "metricKey": "system.cpu.system.pct",
        "metricName": "system.cpu.system.pct",
        "metricSetKey": "system.cpu",
        "metricSetName": "CPU",
        "metricType": "NUM",
        "metricUnit": "bytes",
        "productTargetType": "system.core.id 별",
        "productTargetTypeEn": "By system.core.id"
    },
    "metricType": "NUM",
    "metricUnit": "%",
    "modifiedBy": "",
    "modifiedByName": "",
    "modifiedDt": "2026-02-11T06:41:19.230Z",
    "objectDisplayName": "/tmp",
    "objectName": "/tmp",
    "objectType": "cluster",
    "objectTypeName": "cluster",
    "productInfoAttrs": [
        {
            "attrName": "type",
            "attrValue": "test"
        }
    ],
    "productName": "adad-002",
    "productResourceId": "INSTANCE-c4Hsd27ttDaLw533X4B6Sp",
    "productSq": 7234,
    "productSummary": {
        "agentState": "Running",
        "lbName": "lbName",
        "lbSize": "MEDIUM",
        "productIpAddress": "192.168.1.2",
        "productName": "VM-002",
        "productResourceId": "INSTANCE-c4Hsd27ttDaLw533X4B6Sp",
        "productSq": 8703,
        "productState": "Running",
        "productSubName": "productSubName",
        "productSubType": "replicaset",
        "productTypeCode": "VM",
        "productTypeName": "Virtual Server",
        "vpcName": "vpcName"
    },
    "productTargetType": "system.core.id 별",
    "productTargetTypeEn": "By system.core.id",
    "startDt": "2021-10-23T18:00:00Z",
    "updateBy": "",
    "updateById": "",
    "userNameList": [
        "userName",
        "userName"
    ],
    "userNameStr": "",
    "userNames": "N"
}

1.16 - ShowEventNotificationStates

1.16.1 - 1.0

get /v1/cloudmonitorings/event/v2/events/{eventId}/notification-states

Description

Search Event Notification States

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.020260701

Parameters

TypeNameDescriptionSchemaDefault
patheventId
required
Event ID - Event ID can be viewed using @[ListResourceEvents].
Example :
stringNone
querypage
optional
Page Number (default: 0)
Example : 0
integerNone
querysize
optional
Page Contents Size (default: 10)
Example : 10
integerNone
querysort
optional
Sorting Field List
array[string]None
headerX-ResourceType
required
Resource Type
Example :
stringNone

Responses

HTTP CodeDescriptionSchema
200OKPageResponseEventNotificationResponse
400Invalid RequestNone
401Monitoring User Not FoundNone
403Unauthorized RequestNone
404Resource Not FoundNone

Example HTTP request

Request path

/v1/cloudmonitorings/event/v2/events/{eventId}/notification-states

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = cloudmonitoring 1.0"

Example HTTP response

Response 200

{
    "contents": [
        {
            "notificationStates": [
                {
                    "errorMsg": "SMS Send become Inactive.",
                    "sendDt": "2021-10-23T18:00:00Z",
                    "sendMethod": "MAIL",
                    "sendResult": "SUCCESS"
                }
            ],
            "user": "",
            "userEmail": "kdhong@cloud.com",
            "userId": "1984",
            "userMobileTelNo": "010-000-0000",
            "userNameNotification": "홍길동"
        }
    ],
    "isChanged": "",
    "returnCount": "",
    "returnPage": "",
    "sort": [
        ""
    ],
    "sortableFields": [
        ""
    ],
    "totalCount": ""
}

1.17 - ShowEventPolicy

1.17.1 - 1.0

get /v1/cloudmonitorings/event/v2/event-policies/{eventPolicyId}

Description

Show Event Policy

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.020260701

Parameters

TypeNameDescriptionSchemaDefault
patheventPolicyId
required
Event Policy ID to inquire - Event Policy ID can be viewed using @[ListEventPolicies].
Example : 7226
integerNone
headerX-ResourceType
required
Resource Type
Example :
stringNone

Responses

HTTP CodeDescriptionSchema
200OKEventPolicyDetailResponse
400Invalid RequestNone
401Monitoring User Not FoundNone
403Unauthorized RequestNone
404Resource Not FoundNone

Example HTTP request

Request path

/v1/cloudmonitorings/event/v2/event-policies/{eventPolicyId}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = cloudmonitoring 1.0"

Example HTTP response

Response 200

{
    "asgYn": "",
    "attrListStr": "",
    "checkAsg": "",
    "createBy": "",
    "createById": "",
    "createdBy": "",
    "createdByName": "",
    "createdDt": "2026-02-11T06:41:19.229Z",
    "disableObject": "N",
    "disableYn": "",
    "displayEventRule": "SCP",
    "eventLevel": "WARNING",
    "eventMessagePrefix": "SCP",
    "eventOccurTimeZone": "GMT+9",
    "eventPolicyId": 7226,
    "eventPolicyStatistics": {
        "eventPolicyStatisticsPeriod": 10,
        "eventPolicyStatisticsType": "MAX"
    },
    "eventThreshold": {
        "metricFunction": "delta",
        "rangeThreshold": {
            "maxComparisonOperator": "LT",
            "maxValue": 90,
            "minComparisonOperator": "GT",
            "minValue": 80
        },
        "singleThreshold": {
            "comparisonOperator": "LT",
            "value": 10
        },
        "thresholdType": "RANGE_VALUE"
    },
    "ftCount": 3,
    "groupSummary": {
        "groupName": "",
        "groupResourceId": "",
        "groupSq": "",
        "productList": [
            {
                "productName": "",
                "productResourceId": "",
                "productSq": ""
            }
        ],
        "productTypeCode": "",
        "productTypeName": ""
    },
    "isLogMetric": "N",
    "metricDescription": "커널에서 사용한 CPU 시간의 백분율 (core 4개 모두를 100%사용하는 경우 : 400%)",
    "metricDescriptionEn": "Percentage of CPU time used in the kernel (if 100% of all 4 cores are used: 400%)",
    "metricKey": "system.cpu.system.pct",
    "metricName": "system.cpu.system.pct",
    "metricSummary": {
        "isLogMetric": "N",
        "isObjectExist": "Y",
        "metricDescription": "커널에서 사용한 CPU 시간의 백분율 (core 4개 모두를 100%사용하는 경우 : 400%)",
        "metricDescriptionEn": "Percentage of CPU time used in the kernel (if 100% of all 4 cores are used: 400%)",
        "metricKey": "system.cpu.system.pct",
        "metricName": "system.cpu.system.pct",
        "metricSetKey": "system.cpu",
        "metricSetName": "CPU",
        "metricType": "NUM",
        "metricUnit": "bytes",
        "productTargetType": "system.core.id 별",
        "productTargetTypeEn": "By system.core.id"
    },
    "metricType": "NUM",
    "metricUnit": "%",
    "modifiedBy": "",
    "modifiedByName": "",
    "modifiedDt": "2026-02-11T06:41:19.230Z",
    "objectDisplayName": "/tmp",
    "objectName": "/tmp",
    "objectType": "cluster",
    "objectTypeName": "cluster",
    "productInfoAttrs": [
        {
            "attrName": "type",
            "attrValue": "test"
        }
    ],
    "productName": "adad-002",
    "productResourceId": "INSTANCE-c4Hsd27ttDaLw533X4B6Sp",
    "productSq": 7234,
    "productSummary": {
        "agentState": "Running",
        "lbName": "lbName",
        "lbSize": "MEDIUM",
        "productIpAddress": "192.168.1.2",
        "productName": "VM-002",
        "productResourceId": "INSTANCE-c4Hsd27ttDaLw533X4B6Sp",
        "productSq": 8703,
        "productState": "Running",
        "productSubName": "productSubName",
        "productSubType": "replicaset",
        "productTypeCode": "VM",
        "productTypeName": "Virtual Server",
        "vpcName": "vpcName"
    },
    "productTargetType": "system.core.id 별",
    "productTargetTypeEn": "By system.core.id",
    "startDt": "2021-10-23T18:00:00Z",
    "updateBy": "",
    "updateById": "",
    "userNameList": [
        "userName",
        "userName"
    ],
    "userNameStr": "",
    "userNames": "N"
}

1.18 - ShowResourceEvent

1.18.1 - 1.0

get /v1/cloudmonitorings/event/v2/events/{eventId}

Description

Show Resource Event

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.020260701

Parameters

TypeNameDescriptionSchemaDefault
patheventId
required
Event ID - Event ID can be viewed using @[ListResourceEvents].
Example :
stringNone
headerX-ResourceType
required
Resource Type
Example :
stringNone

Responses

HTTP CodeDescriptionSchema
200OKEventDetailResponse
400Invalid RequestNone
401Monitoring User Not FoundNone
403Unauthorized RequestNone
404Resource Not FoundNone

Example HTTP request

Request path

/v1/cloudmonitorings/event/v2/events/{eventId}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = cloudmonitoring 1.0"

Example HTTP response

Response 200

{
    "durationSecond": 100,
    "endDt": "2021-10-23T23:59:59Z",
    "eventId": "",
    "eventLevel": "FATAL",
    "eventMessage": "",
    "eventPolicyId": 7240,
    "eventPolicySummary": {
        "checkAsg": "",
        "createBy": "",
        "createById": "",
        "eventLevel": "WARNING",
        "eventMessagePrefix": "SCP",
        "eventOccurTimeZone": "GMT+9",
        "eventPolicyId": 7226,
        "eventPolicyStatistics": {
            "eventPolicyStatisticsPeriod": 10,
            "eventPolicyStatisticsType": "MAX"
        },
        "eventThreshold": {
            "metricFunction": "delta",
            "rangeThreshold": {
                "maxComparisonOperator": "LT",
                "maxValue": 90,
                "minComparisonOperator": "GT",
                "minValue": 80
            },
            "singleThreshold": {
                "comparisonOperator": "LT",
                "value": 10
            },
            "thresholdType": "RANGE_VALUE"
        },
        "ftCount": 3,
        "isLogMetric": "N",
        "metricDescription": "커널에서 사용한 CPU 시간의 백분율 (core 4개 모두를 100%사용하는 경우 : 400%)",
        "metricDescriptionEn": "Percentage of CPU time used in the kernel (if 100% of all 4 cores are used: 400%)",
        "metricKey": "system.cpu.system.pct",
        "metricName": "system.cpu.system.pct",
        "objectName": "cpu0",
        "productName": "VM-002",
        "productResourceId": "INSTANCE-c4Hsd27ttDaLw533X4B6Sp",
        "productSq": 7321,
        "productTargetType": "system.core.id 별",
        "productTargetTypeEn": "By system.core.id",
        "updateBy": "",
        "updateById": ""
    },
    "eventState": "ACTIVE",
    "metricKey": "system.cpu.system.norm.pct",
    "metricName": "system.cpu.system.norm.pct",
    "metricSummary": {
        "isLogMetric": "N",
        "isObjectExist": "Y",
        "metricDescription": "커널에서 사용한 CPU 시간의 백분율 (core 4개 모두를 100%사용하는 경우 : 400%)",
        "metricDescriptionEn": "Percentage of CPU time used in the kernel (if 100% of all 4 cores are used: 400%)",
        "metricKey": "system.cpu.system.pct",
        "metricName": "system.cpu.system.pct",
        "metricSetKey": "system.cpu",
        "metricSetName": "CPU",
        "metricType": "NUM",
        "metricUnit": "bytes",
        "productTargetType": "system.core.id 별",
        "productTargetTypeEn": "By system.core.id"
    },
    "objectDisplayName": "CPU0",
    "objectName": "CPU0",
    "objectType": "cluster",
    "objectTypeName": "Cluster",
    "productIpAddress": "192.168.1.2",
    "productName": "VM-002",
    "productResourceId": "INSTANCE-c4Hsd27ttDaLw533X4B6Sp",
    "productSummary": {
        "agentState": "Running",
        "lbName": "lbName",
        "lbSize": "MEDIUM",
        "productIpAddress": "192.168.1.2",
        "productName": "VM-002",
        "productResourceId": "INSTANCE-c4Hsd27ttDaLw533X4B6Sp",
        "productSq": 8703,
        "productState": "Running",
        "productSubName": "productSubName",
        "productSubType": "replicaset",
        "productTypeCode": "VM",
        "productTypeName": "Virtual Server",
        "vpcName": "vpcName"
    },
    "productTypeCode": "VM",
    "startDt": "2021-10-23T18:00:00Z"
}

2 - Models

2.1 - AccountProductDto

NameDescriptionSchemaDefault
accountId
required
프로젝트 아이디
Example : UqXgOSnoqOfKB0_LKO6xId
string
endDt
optional
상품 삭제 일시
Example : 9999-12-31T23:59:59.999Z
string (date-time)
lastEventLevel
optional
최종 이벤트 레벨
Example : WARNING
string
poolName
optional
풀 이름
Example : POOL-A8-C1DpGqRdQMlfNXdJxLb
string
productIpAddress
optional
상품 IP주소
Example : 192.168.245.161
string
productName
required
상품 이름
Example : VM-Server-01
string
productResourceId
required
상품 리소스 아이디
Example : INSTANCE-c4Hsd27ttDaLw533X4B6Sp
string
productState
required
상품 상태 - 유효한 값 : Running, Down
Example : Running
string
productTypeCode
required
상품 유형코드
Example : VM
string
productTypeName
required
상품 유형이름
Example : Virtual Server
string
startDt
required
상품 생성 일시
Example : 2021-10-23T08:30:00Z
string (date-time)

2.2 - AddrbookAdditionalInfo

NameDescriptionSchemaDefault
memberCount
required
멤버수
Example : 4
integer
userAdditionalInfo
optional

array[Member]

2.3 - AlarmAddrBookDto

NameDescriptionSchemaDefault
addrBookName
required
주소록 이름
Example : contact name
string
addrbookId
required
주소록 아이디
Example : 74
string
createdBy
required
생성자 아이디
Example : 1984
string
createdByName
required
생성자 이름
Example : 김삼성
string
createdDt
required
생성 일시
Example : 2021-10-23T22:00:00Z
string (date-time)
memberCount
required
멤버 수
Example : 10
integer

2.4 - AlarmAddrBookMemberDto

NameDescriptionSchemaDefault
userEmail
required
사용자 이메일
Example : kdhong@cloud.com
string
userId
required
사용자 리소스 아이디
Example : 1346
string
userLanguage
required
사용자 언어
Example : ko
string
userMobileTelNo
optional
사용자 휴대전화번호
Example : 010-0000-0000
string
userName
required
사용자 이름
Example : 홍길동
string
userTimezone
required
사용자 타임존
Example : Asia/Seoul
string

2.5 - EventDetailResponse

NameDescriptionSchemaDefault
durationSecond
required
이벤트 지속 시간 - 단위: 초
Example : 100
integer
endDt
optional
종료일시
Example : 2021-10-23T23:59:59Z
string (date-time)
eventId
required
이벤트 아이디
Example :
string
eventLevel
required
이벤트 레벨
Example : FATAL
string
eventMessage
required
이벤트 메시지
Example :
string
eventPolicyId
optional
이벤트 정책 아이디
Example : 7240
integer
eventPolicySummary
required

EventPolicyResponse
eventState
required
Event State
Example : ACTIVE
string
metricKey
required
메트릭 키
Example : system.cpu.system.norm.pct
string
metricName
optional
메트릭 이름
Example : system.cpu.system.norm.pct
string
metricSummary
required

MetricSummary
objectDisplayName
optional
오브젝트 이름
Example : CPU0
string
objectName
optional
오브젝트 이름
Example : CPU0
string
objectType
optional
개별항목 유형
Example : cluster
string
objectTypeName
optional
개별항목 유형 이름
Example : Cluster
string
productIpAddress
optional
상품 IP주소
Example : 192.168.1.2
string
productName
optional
상품 이름
Example : VM-002
string
productResourceId
required
상품 리소스 아이디
Example : INSTANCE-c4Hsd27ttDaLw533X4B6Sp
string
productSummary
required

ProductSummary
productTypeCode
optional
상품 유형 코드
Example : VM
string
startDt
required
시작일시
Example : 2021-10-23T18:00:00Z
string (date-time)

2.6 - EventNotificationResponse

NameDescriptionSchemaDefault
notificationStates
required
이벤트 알림 상태
array[NotificationStatus]
user
optional

Example :
object
userEmail
optional
사용자 이메일
Example : kdhong@cloud.com
string
userId
required
사용자 아이디
Example : 1984
string
userMobileTelNo
optional
사용자 휴대 전화번호
Example : 010-000-0000
string
userNameNotification
required
사용자 이름
Example : 홍길동
string

2.7 - EventPolicyCreateRequest

NameDescriptionSchemaDefault
eventPolicyRequest
required

EventPolicyInfo
notificationRecipients
optional
이벤트 알림 수신인 정보 - 알림 대상자 정보는 10개까지 지정할 수 있습니다.
array[NotificationRecipient]
productResourceId
required
Product Resource ID - Product Resource ID can be viewed using @[ListAccountResources].
Example : INSTANCE-c4Hsd27ttDaLw533X4B6Sp
string

2.8 - EventPolicyDetailResponse

NameDescriptionSchemaDefault
asgYn
optional

Example :
string
attrListStr
optional

Example :
string
checkAsg
optional

Example :
boolean
createBy
optional

Example :
object
createById
optional

Example :
string
createdBy
optional

Example :
string
createdByName
optional

Example :
string
createdDt
optional

Example : 2026-02-11T06:41:19.229Z
string (date-time)
disableObject
optional
swagger.event.eventPolicyResponse.disableObject.value
Example : N
string
disableYn
optional

Example :
string
displayEventRule
optional
swagger.event.eventResponse.displayEventRule.value
Example : SCP
string
eventLevel
required
이벤트 레벨
Example : WARNING
string
eventMessagePrefix
optional
이벤트 메시지 접두사
Example : SCP
string
eventOccurTimeZone
optional
swagger.event.eventPolicyResponse.eventOccurTimeZone.value
Example : GMT+9
string
eventPolicyId
required
이벤트 정책 아이디
Example : 7226
integer
eventPolicyStatistics
optional

EventPolicyStatistics
eventThreshold
required

EventThreshold
ftCount
required
결함허용 개수 - 설정한 조건에 맞는 값이 몇 번 반복해서 발생하면 이벤트를 발생시킬지 설정하는 값
Example : 3
integer
groupSummary
optional

GroupSummary
isLogMetric
required
로그 메트릭 여부
Example : N
string
metricDescription
optional
메트릭 설명
Example : 커널에서 사용한 CPU 시간의 백분율 (core 4개 모두를 100%사용하는 경우 : 400%)
string
metricDescriptionEn
optional
메트릭 설명
Example : Percentage of CPU time used in the kernel (if 100% of all 4 cores are used: 400%)
string
metricKey
required
메트릭 키
Example : system.cpu.system.pct
string
metricName
optional
메트릭 이름
Example : system.cpu.system.pct
string
metricSummary
required

MetricSummary
metricType
optional
메트릭 유형
Example : NUM
string
metricUnit
optional
메트릭 단위
Example : %
string
modifiedBy
optional

Example :
string
modifiedByName
optional

Example :
string
modifiedDt
optional

Example : 2026-02-11T06:41:19.230Z
string (date-time)
objectDisplayName
optional
오브젝트 이름
Example : /tmp
string
objectName
optional
오브젝트 이름
Example : /tmp
string
objectType
optional
개별항목 유형
Example : cluster
string
objectTypeName
optional
개별항목 유형 이름
Example : cluster
string
productInfoAttrs
optional
상품 정보 속성
Example : [{'attrName': 'type', 'attrValue': 'test'}]
array[ProductInfoAttr]
productName
optional
상품 이름
Example : adad-002
string
productResourceId
optional
상품 리소스 아이디
Example : INSTANCE-c4Hsd27ttDaLw533X4B6Sp
string
productSq
optional
상품 시퀀스
Example : 7234
integer
productSummary
required

ProductSummary
productTargetType
optional
메트릭 대상 유형
Example : system.core.id 별
string
productTargetTypeEn
optional
메트릭 대상 유형
Example : By system.core.id
string
startDt
optional
시작일시
Example : 2021-10-23T18:00:00Z
string (date-time)
updateBy
optional

Example :
object
updateById
optional

Example :
string
userNameList
optional
사용자 이름
Example : ['userName', 'userName']
array[string]
userNameStr
optional

Example :
string
userNames
optional
swagger.event.eventPolicyResponse.disableObject.value
Example : N
string

2.9 - EventPolicyHistoryResponse

NameDescriptionSchemaDefault
createBy
optional

Example :
object
createById
optional

Example :
string
disableObject
optional
swagger.event.eventPolicyResponse.disableObject.value
Example : N
string
disableYn
optional
swagger.event.eventPolicyResponse.disableObject.value
Example : N
string
eventLevel
required
이벤트 레벨
Example : WARNING
string
eventMessagePrefix
optional
이벤트 메시지 접두사
Example : SCP
string
eventOccurTimeZone
optional
swagger.event.eventPolicyResponse.eventOccurTimeZone.value
Example : GMT+9
string
eventPolicyHistoryId
required
이벤트 정책 이력 아이디
Example : 8759
integer
eventPolicyHistoryType
required
이벤트 정책 이력 유형 - C : 등록, U : 수정, D : 삭제
Example : U
string
eventPolicyId
optional
이벤트 정책 아이디
Example : 7240
integer
eventPolicyStatistics
optional

EventPolicyStatistics
eventThreshold
required

EventThreshold
ftCount
required
결함허용 개수
Example : 3
integer
metricDescription
optional
메트릭 설명
Example : 커널에서 사용한 CPU 시간의 백분율 (core 4개 모두를 100%사용하는 경우 : 400%)
string
metricDescriptionEn
optional
메트릭 설명
Example : Percentage of CPU time used in the kernel (if 100% of all 4 cores are used: 400%)
string
metricKey
required
메트릭 키
Example : system.cpu.system.pct
string
metricName
required
메트릭 이름
Example : system.cpu.system.pct
string
metricUnit
optional
메트릭 단위
Example : %
string
modifiedBy
optional

Example :
string
modifiedByName
optional

Example :
string
modifiedDt
optional

Example : 2026-02-11T06:41:19.370Z
string (date-time)
notificationRecipientHistory
optional

NotificationRecipientHistory
objectDisplayName
optional
오브젝트 이름
Example : cpu0
string
objectName
optional
오브젝트 이름
Example : cpu0
string
objectType
optional
개별항목 유형
Example : cluster
string
productName
required
상품 이름
Example : VM-Server-01
string
productResourceId
required
상품 리소스 아이디
Example : INSTANCE-c4Hsd27ttDaLw533X4B6Sp
string
productTargetType
optional
메트릭 대상 유형
Example : system.core.id 별
string
productTargetTypeEn
optional
메트릭 대상 유형
Example : By system.core.id
string
updateBy
optional

Example :
object
updateById
optional

Example :
string

2.10 - EventPolicyInfo

NameDescriptionSchemaDefault
disableYn
required
swagger.event.eventPolicyResponse.disableYn.value
Example : N
string
eventLevel
required
이벤트 레벨
Example : WARNING
string
eventMessagePrefix
optional
이벤트 메시지 접두사
Example : SCP
string
eventOccurTimeZone
optional
swagger.event.eventPolicyResponse.eventOccurTimeZone.value
Example : GMT+9
string
eventPolicyStatistics
optional

EventPolicyStatistics
eventThreshold
required

EventThreshold
ftCount
required
결함허용 개수 - 설정한 조건에 맞는 값이 몇 번 반복해서 발생하면 이벤트를 발생시킬지 설정하는 값
Example : 3
integer
isLogMetric
required
로그 메트릭 여부
Example : N
string
metricKey
required
메트릭 키
Example : system.diskio.read.bytes
string
metricName
optional

Example :
string
objectDisplayName
optional
오브젝트 이름
Example : dm0
string
objectName
optional
오브젝트 이름
Example : dm0
string
objectType
optional
개별항목 유형
Example : SCP
string
podObjectDisplayName
optional
swagger.event.eventPolicyResponse.podObjectDisplayName.value
Example : dm0
string
podObjectName
optional
swagger.event.eventPolicyResponse.podObjectName.value
Example : dm0
string

2.11 - EventPolicyInfoEditable

NameDescriptionSchemaDefault
disableYn
required
swagger.event.eventPolicyResponse.disableYn.value
Example : N
string
eventLevel
required
이벤트 레벨
Example : WARNING
string
eventMessagePrefix
optional
이벤트 메시지 접두사
Example : SCP
string
eventOccurTimeZone
optional
swagger.event.eventPolicyResponse.eventOccurTimeZone.value
Example : GMT+9
string
eventPolicyStatistics
optional

EventPolicyStatistics
eventThreshold
required

EventThreshold
ftCount
required
결함허용 개수 - 설정한 조건에 맞는 값이 몇 번 반복해서 발생하면 이벤트를 발생시킬지 설정하는 값
Example : 3
integer
objectDisplayName
optional
오브젝트 이름
Example : cpu0
string
objectName
optional
오브젝트 이름
Example : cpu0
string
objectType
optional
개별항목 유형
Example : cluster
string
podObjectDisplayName
optional
swagger.event.eventPolicyResponse.podObjectName.value
Example : cpu0
string
podObjectName
optional
swagger.event.eventPolicyResponse.podObjectName.value
Example : cpu0
string

2.12 - EventPolicyResponse

NameDescriptionSchemaDefault
checkAsg
optional

Example :
boolean
createBy
optional

Example :
object
createById
optional

Example :
string
eventLevel
required
이벤트 레벨
Example : WARNING
string
eventMessagePrefix
optional
이벤트 메시지 접두사
Example : SCP
string
eventOccurTimeZone
optional
swagger.event.eventPolicyResponse.eventOccurTimeZone.value
Example : GMT+9
string
eventPolicyId
required
이벤트 정책 아이디
Example : 7226
integer
eventPolicyStatistics
optional

EventPolicyStatistics
eventThreshold
required

EventThreshold
ftCount
required
결함허용 개수 - 설정한 조건에 맞는 값이 몇 번 반복해서 발생하면 이벤트를 발생시킬지 설정하는 값
Example : 3
integer
isLogMetric
required
로그 메트릭 여부
Example : N
string
metricDescription
optional
메트릭 설명
Example : 커널에서 사용한 CPU 시간의 백분율 (core 4개 모두를 100%사용하는 경우 : 400%)
string
metricDescriptionEn
optional
메트릭 설명
Example : Percentage of CPU time used in the kernel (if 100% of all 4 cores are used: 400%)
string
metricKey
required
메트릭 키
Example : system.cpu.system.pct
string
metricName
required
메트릭 이름
Example : system.cpu.system.pct
string
objectName
optional
오브젝트 이름
Example : cpu0
string
productName
required
상품 이름
Example : VM-002
string
productResourceId
required
상품 리소스 아이디
Example : INSTANCE-c4Hsd27ttDaLw533X4B6Sp
string
productSq
required
상품 시퀀스
Example : 7321
integer
productTargetType
optional
메트릭 대상 유형
Example : system.core.id 별
string
productTargetTypeEn
optional
메트릭 대상 유형
Example : By system.core.id
string
updateBy
optional

Example :
object
updateById
optional

Example :
string

2.13 - EventPolicyStatistics

NameDescriptionSchemaDefault
eventPolicyStatisticsPeriod
required
이벤트 정책 통계 기간 - 단위: 분
Example : 10
integer
eventPolicyStatisticsType
required
이벤트 정책 통계 유형
Example : MAX
string

2.14 - EventPolicyUpdateRequest

NameDescriptionSchemaDefault
eventPolicyRequest
required

EventPolicyInfoEditable
notificationRecipients
optional
이벤트 알림 수신인 정보
array[NotificationRecipient]

2.15 - EventThreshold

NameDescriptionSchemaDefault
metricFunction
optional
메트릭 함수 - 유효한 값: [delta] - 이벤트 발생 여부를 판단하기 위해 성능항목의 현재 값을 사용할지, 이전 값과 현재 값의 차이를 사용할지를 지정합니다. - 이전 값과 현재 값의 차이를 사용하고자 할 경우에만 delta로 지정합니다.
Example : delta
string
rangeThreshold
optional

RangeThreshold
singleThreshold
optional

SingleThreshold
thresholdType
required
임계치 유형 - 임계치를 범위로 지정할 경우에는 “RANGE_VALUE"를, 임계치를 단일값으로 지정할 경우에는 “SINGLE_VALUE” 지정해야 합니다.
Example : RANGE_VALUE
string

2.16 - GroupSummary

NameDescriptionSchemaDefault
groupName
optional

Example :
string
groupResourceId
optional

Example :
string
groupSq
optional

Example :
integer
productList
optional

array[ProductList]
productTypeCode
optional

Example :
string
productTypeName
optional

Example :
string

2.17 - ListResponseMetricStatisticsDataDtoOpenAPIV2

NameDescriptionSchemaDefault
contents
optional

array[MetricStatisticsDataDtoOpenAPIV2]
totalCount
optional

Example :
integer

2.18 - Member

NameDescriptionSchemaDefault
account_id
optional

Example :
string
company_name
optional

Example :
string
dst_offset
optional

Example :
string
email
optional

Example :
string
id
optional

Example :
string
last_login_at
optional

Example :
string
member_created_at
optional

Example :
string
password_reuse_count
optional

Example :
integer
timezone
optional

Example :
string
tz_id
optional

Example :
string
user_name
optional

Example :
string
utc_offset
optional

Example :
string

2.19 - MetricDataConditionOpenAPIV2

NameDescriptionSchemaDefault
metricKey
required
메트릭
Example : system.diskio.read.bytes
string
objectType
optional
개별항목 유형
Example : replicaset
string
productResourceInfos
required
상품 리소스 아이디 목록 - 상품 리소스 아이디는 50개까지 지정할 수 있습니다.
array[ProductResourceInfo]
statisticsPeriod
optional
통계 집계 주기 (단위: 분)
Example : 5
integer
statisticsTypeList
optional
통계 유형 - 유효한 값 : MIN, MAX, AVG, SUM
Example : ['SUM', 'MIN']
array[string]

2.20 - MetricDataSearchCriteriaOpenAPIV2

NameDescriptionSchemaDefault
ignoreInvalid
optional
유효하지 않은 값 제외 여부
Example : Y
string
metricDataConditions
required
메트릭 데이터 조건
array[MetricDataConditionOpenAPIV2]
queryEndDt
required
조회 종료 일시
Example : 2022-08-07T23:59:00.000Z
string
queryStartDt
required
조회 시작 일시
Example : 2022-08-07T23:50:00.000Z
string

2.21 - MetricInfoDto

NameDescriptionSchemaDefault
disableObject
optional
swagger.product.MetricInfoDto.disableObject.value
Example : N
string
displayUnit
optional

Example :
string
fixedUnit
optional
메트릭 단위 (고정)
Example : sec
string
isLogMetric
required
로그 메트릭 여부
Example : N
string
isObjectExist
required
개별항목 성능 존재 여부
Example : Y
string
metricDescription
optional
메트릭 설명
Example : 커널에서 사용한 CPU 시간의 백분율 (core 4개 모두를 100%사용하는 경우 : 400%)
string
metricDescriptionEn
optional
메트릭 설명
Example : Percentage of CPU time used in the kernel (if 100% of all 4 cores are used: 400%)
string
metricKey
required
메트릭 키
Example : system.filesystem.used.bytes
string
metricName
required
메트릭 이름
Example : FileSystem
string
metricOrder
optional
메트릭 순서
Example : 1
integer
metricSetKey
required
swagger.product.MetricInfoDto.metricSetKey.value
Example : system.filesystem
string
metricSetName
required
메트릭 세트 이름
Example : FileSystem
string
metricType
required
메트릭 유형
Example : NUM
string
metricUnit
optional
메트릭 단위
Example : bytes
string
objectKeyName
required
오브젝트 키 이름
Example : system.core.iowait.pct
string
objectType
optional
swagger.product.MetricInfoDto.disableObject.value
Example : N
string
objectTypeNameEng
optional
swagger.product.MetricInfoDto.disableObject.value
Example : N
string
objectTypeNameLoc
optional
swagger.product.MetricInfoDto.disableObject.value
Example : N
string
perfTitle
required
swagger.product.MetricInfoDto.perfTitle.value
Example : File System
string
productTargetType
optional
메트릭 대상 유형
Example : system.core.id 별
string
productTargetTypeEn
optional
메트릭 대상 유형
Example : By system.core.id
string
productTypeCode
required
상품 유형 코드
Example : VM
string
productTypeName
required
상품 유형 이름
Example : Virtual Server
string

2.22 - MetricStatisticsDataDtoOpenAPIV2

NameDescriptionSchemaDefault
metricKey
optional
메트릭 키
Example : system.filesystem.used.bytes
string
metricName
optional
메트릭 이름
Example : system.filesystem.used.bytes
string
metricType
optional
메트릭 유형
Example : NUM
string
metricUnit
optional
메트릭 단위
Example : bytes
string
objectDisplayName
optional
개별항목 출력 이름
Example : dm-1
string
objectName
optional
개별항목 이름
Example : dm-1
string
objectType
optional
개별항목 유형
Example : replicaset
string
perfData
optional
성능 데이터
Example : [{'time': 1627378200000, 'value': '0.0766'}]
array[object]
productName
optional
상품의 이름
Example : VM-Server-01
string
productResourceId
optional
상품 리소스 아이디
Example : INSTANCE-c4Hsd27ttDaLw533X4B6Sp
string
statisticsPeriod
required
통계 집계 주기 (단위: 분)
Example : 5
integer
statisticsType
required
통계 유형
Example : SUM
string

2.23 - MetricSummary

NameDescriptionSchemaDefault
isLogMetric
required
로그 메트릭 여부
Example : N
string
isObjectExist
required
오브젝트 존재여부
Example : Y
string
metricDescription
optional
메트릭 설명
Example : 커널에서 사용한 CPU 시간의 백분율 (core 4개 모두를 100%사용하는 경우 : 400%)
string
metricDescriptionEn
optional
메트릭 설명
Example : Percentage of CPU time used in the kernel (if 100% of all 4 cores are used: 400%)
string
metricKey
required
메트릭 키
Example : system.cpu.system.pct
string
metricName
required
메트릭 이름
Example : system.cpu.system.pct
string
metricSetKey
required
메트릭 셋 키
Example : system.cpu
string
metricSetName
required
메트릭 셋 이름
Example : CPU
string
metricType
required
메트릭 유형
Example : NUM
string
metricUnit
required
메트릭 단위
Example : bytes
string
productTargetType
optional
메트릭 대상 유형
Example : system.core.id 별
string
productTargetTypeEn
optional
메트릭 대상 유형
Example : By system.core.id
string

2.24 - NotificationMethod

NameDescriptionSchemaDefault
eventLevel
required
이벤트 레벨
Example : FATAL
string
notificationMethod
optional

Example :
string
sendMethod
required
전송 메소드 - 허용 값: MESSENGER, SMS, MAIL
Example : ['MAIL']
array[string]

2.25 - NotificationRecipient

NameDescriptionSchemaDefault
notificationMethods
required
알림 메소드
array[NotificationMethod]
recipientKey
required
수신인 키 - 수신인 키는 @[프로젝트 멤버 조회] 또는 @[사용자의 주소록 목록 조회]를 이용하여 조회합니다.
Example : 1347
string
recipientType
required
수신인 유형 - USER : 사용자, ADDRBOOK : 주소록
Example : USER
string

2.26 - NotificationRecipientHistory

NameDescriptionSchemaDefault
addrbookIds
optional
주소록 아이디
array[integer]
userIds
optional
사용자 아이디
array[string]
userNames
optional
사용자 이름
array[string]

2.27 - NotificationResponse

NameDescriptionSchemaDefault
addrbookAdditionalInfo
optional

AddrbookAdditionalInfo
notificationMethods
required
알림 메소드 정보
array[NotificationMethod]
recipientKey
required
수신인 키 - 수신인 키는 @[프로젝트 멤버 조회] 또는 @[사용자의 주소록 목록 조회]를 이용하여 조회합니다.
Example : 1984
string
recipientName
required
수신인 이름
Example : 홍길동
string
recipientType
required
수신인 유형 - USER : 사용자, ADDRBOOK : 주소록
Example : USER
string
userAdditionalInfo
optional

Member

2.28 - NotificationStatus

NameDescriptionSchemaDefault
errorMsg
optional
swagger.event.notificationStatus.errorMsg.value
Example : SMS Send become Inactive.
string
sendDt
optional
전송일시
Example : 2021-10-23T18:00:00Z
string (date-time)
sendMethod
optional
전송 메소드
Example : MAIL
string
sendResult
optional
전송 결과 - SUCCESS : 전송 성공 - FAIL : 전송을 시도했으나 전송 실패 - NOT SEND : 전송 메소드 미설정으로 전송 안함 - FILTERED : 알림 필터링 설정으로 전송 안함 - NO PERMISSION : 권한이 없어 전송 안함
Example : SUCCESS
string

2.29 - OpenApiEventResponse

NameDescriptionSchemaDefault
durationSecond
required
이벤트 지속 시간 - 단위: 초
Example : 100
integer
endDt
optional
종료일시
Example : 2021-10-23T23:59:59Z
string (date-time)
eventId
required
이벤트 아이디
Example :
string
eventLevel
required
이벤트 레벨
Example : FATAL
string
eventMessage
required
이벤트 메시지
Example :
string
eventPolicyId
required
이벤트 정책 아이디
Example : 7240
integer
eventState
required
Event State
Example : ACTIVE
string
metricKey
required
메트릭 키
Example : system.cpu.system.norm.pct
string
metricName
required
메트릭 이름
Example : system.cpu.system.norm.pct
string
objectDisplayName
optional
오브젝트 이름
Example : CPU0
string
objectName
optional
오브젝트 이름
Example : CPU0
string
objectType
optional
개별항목 유형
Example : cluster
string
objectTypeName
optional
개별항목 유형 이름
Example : cluster
string
productResourceId
required
상품 리소스 아이디
Example : INSTANCE-c4Hsd27ttDaLw533X4B6Sp
string
productTargetType
optional
메트릭 대상 유형
Example : system.core.id 별
string
productTargetTypeEn
optional
메트릭 대상 유형
Example : By system.core.id
string
productTypeName
required
상품 유형 이름
Example : Virtual Server
string
startDt
required
시작일시
Example : 2021-10-23T18:00:00Z
string (date-time)

2.30 - PageResponseAccountProductDto

NameDescriptionSchemaDefault
contents
optional

array[AccountProductDto]
isChanged
optional

Example :
boolean
returnCount
optional

Example :
integer
returnPage
optional

Example :
integer
sort
optional

array[string]
sortableFields
optional

array[string]
totalCount
optional

Example :
integer

2.31 - PageResponseAlarmAddrBookDto

NameDescriptionSchemaDefault
contents
optional

array[AlarmAddrBookDto]
isChanged
optional

Example :
boolean
returnCount
optional

Example :
integer
returnPage
optional

Example :
integer
sort
optional

array[string]
sortableFields
optional

array[string]
totalCount
optional

Example :
integer

2.32 - PageResponseAlarmAddrBookMemberDto

NameDescriptionSchemaDefault
contents
optional

array[AlarmAddrBookMemberDto]
isChanged
optional

Example :
boolean
returnCount
optional

Example :
integer
returnPage
optional

Example :
integer
sort
optional

array[string]
sortableFields
optional

array[string]
totalCount
optional

Example :
integer

2.33 - PageResponseEventNotificationResponse

NameDescriptionSchemaDefault
contents
optional

array[EventNotificationResponse]
isChanged
optional

Example :
boolean
returnCount
optional

Example :
integer
returnPage
optional

Example :
integer
sort
optional

array[string]
sortableFields
optional

array[string]
totalCount
optional

Example :
integer

2.34 - PageResponseEventPolicyHistoryResponse

NameDescriptionSchemaDefault
contents
optional

array[EventPolicyHistoryResponse]
isChanged
optional

Example :
boolean
returnCount
optional

Example :
integer
returnPage
optional

Example :
integer
sort
optional

array[string]
sortableFields
optional

array[string]
totalCount
optional

Example :
integer

2.35 - PageResponseEventPolicyResponse

NameDescriptionSchemaDefault
contents
optional

array[EventPolicyResponse]
isChanged
optional

Example :
boolean
returnCount
optional

Example :
integer
returnPage
optional

Example :
integer
sort
optional

array[string]
sortableFields
optional

array[string]
totalCount
optional

Example :
integer

2.36 - PageResponseJsonArrayProjectMemberResponseForOpenAPI

NameDescriptionSchemaDefault
contents
optional
Contents
array[ProjectMemberResponseForOpenAPI]
returnCount
optional
Return Count
Example : 10
integer
returnPage
optional
Return Page
Example : 1
integer
sort
optional
Sorting Field List
array[string]
sortableFields
optional
Sortable Field List
array[string]
totalCount
optional
Total Count
Example : 100
integer

2.37 - PageResponseMetricInfoDto

NameDescriptionSchemaDefault
contents
optional

array[MetricInfoDto]
isChanged
optional

Example :
boolean
returnCount
optional

Example :
integer
returnPage
optional

Example :
integer
sort
optional

array[string]
sortableFields
optional

array[string]
totalCount
optional

Example :
integer

2.38 - PageResponseNotificationResponse

NameDescriptionSchemaDefault
contents
optional

array[NotificationResponse]
isChanged
optional

Example :
boolean
returnCount
optional

Example :
integer
returnPage
optional

Example :
integer
sort
optional

array[string]
sortableFields
optional

array[string]
totalCount
optional

Example :
integer

2.39 - PageResponseOpenApiEventResponse

NameDescriptionSchemaDefault
contents
optional

array[OpenApiEventResponse]
isChanged
optional

Example :
boolean
returnCount
optional

Example :
integer
returnPage
optional

Example :
integer
sort
optional

array[string]
sortableFields
optional

array[string]
totalCount
optional

Example :
integer

2.40 - PageResponseProductTypeInfoDto

NameDescriptionSchemaDefault
contents
optional

array[ProductTypeInfoDto]
isChanged
optional

Example :
boolean
returnCount
optional

Example :
integer
returnPage
optional

Example :
integer
sort
optional

array[string]
sortableFields
optional

array[string]
totalCount
optional

Example :
integer

2.41 - ProductInfoAttr

NameDescriptionSchemaDefault
attrName
optional

Example :
string
attrValue
optional

Example :
string

2.42 - ProductList

NameDescriptionSchemaDefault
productName
optional

Example :
string
productResourceId
optional

Example :
string
productSq
optional

Example :
integer

2.43 - ProductResourceInfo

NameDescriptionSchemaDefault
objectList
optional
개별항목 목록
Example : ['kube-01', 'kube-02']
array[string]
productResourceId
required
상품 리소스 아이디
Example : INSTANCE-c4Hsd27ttDaLw533X4B6Sp
string

2.44 - ProductSummary

NameDescriptionSchemaDefault
agentState
required
상품 상태
Example : Running
string
lbName
optional
swagger.event.productSummary.lbName.value
Example : lbName
string
lbSize
optional
swagger.event.productSummary.lbSize.value
Example : MEDIUM
string
productIpAddress
optional
상품 IP주소
Example : 192.168.1.2
string
productName
required
상품 이름
Example : VM-002
string
productResourceId
required
상품 리소스 아이디
Example : INSTANCE-c4Hsd27ttDaLw533X4B6Sp
string
productSq
optional
상품 시퀀스
Example : 8703
integer
productState
required
상품 상태
Example : Running
string
productSubName
optional
swagger.event.productSummary.productSubName.value
Example : productSubName
string
productSubType
optional
swagger.event.productSummary.productSubType.value
Example : replicaset
string
productTypeCode
required
상품 유형 코드
Example : VM
string
productTypeName
required
상품 유형 이름
Example : Virtual Server
string
vpcName
optional
swagger.event.productSummary.vpcName.value
Example : vpcName
string

2.45 - ProductTypeInfoDto

NameDescriptionSchemaDefault
parentProductTypeName
required
부모 상품 이름
Example : Compute
string
productTypeCode
required
상품 코드
Example : VM
string
productTypeName
required
상품 이름
Example : Virtual Server
string
stateMetricKey
required
상태 메트릭 키
Example : vsphere.mxvm.runtime.state
string

2.46 - ProjectMemberResponseForOpenAPI

NameDescriptionSchemaDefault
companyName
optional
swagger.product.ProjectMemberDto.companyName.value
Example : 삼성SDS
string
createdBy
optional
swagger.product.ProjectMemberDto.createdBy.value
Example : 469
string
createdByEmail
optional
swagger.product.ProjectMemberDto.createdByEmail.value
Example : soonshin.lee@cloud.com
string
createdByName
optional
swagger.product.ProjectMemberDto.createdByName.value
Example : 이순신
string
createdDt
optional
swagger.product.ProjectMemberDto.userTimezone.value
Example : 2021-08-06T10:23:41.547Z
string
email
optional
swagger.product.ProjectMemberDto.userEmail.value
Example : kdhong@cloud.com
string
lastAccessDt
optional
swagger.product.ProjectMemberDto.lastAccessDt.value
Example : 2022-11-06T10:23:41.547Z
string
modifiedBy
optional
swagger.product.ProjectMemberDto.modifiedBy.value
Example : 469
string
modifiedByEmail
optional
swagger.product.ProjectMemberDto.modifiedByEmail.value
Example : soonshin.lee@cloud.com
string
modifiedByName
optional
swagger.product.ProjectMemberDto.modifiedByName.value
Example : 이순신
string
modifiedDt
optional
swagger.product.ProjectMemberDto.modifiedDt.value
Example : 2021-08-06T10:23:41.547Z
string
organizationId
optional
swagger.product.ProjectMemberDto.organizationId.value
Example :
string
positionName
optional
swagger.product.ProjectMemberDto.positionName.value
Example : 프로
string
userGroupCount
optional
swagger.product.ProjectMemberDto.userGroupCount.value
Example : 10
string
userId
optional
swagger.product.ProjectMemberDto.userId.value
Example : 1984
string
userName
optional
swagger.product.ProjectMemberDto.userName.value
Example : 홍길동
string

2.47 - RangeThreshold

NameDescriptionSchemaDefault
maxComparisonOperator
required
최대 비교 연산자
Example : LT
string
maxValue
required
최대 값
Example : 90
object
minComparisonOperator
required
최소 비교 연산자
Example : GT
string
minValue
required
최소 값
Example : 80
object

2.48 - SingleThreshold

NameDescriptionSchemaDefault
comparisonOperator
required
비교 연산자
Example : LT
string
value
required

Example : 10
object