Governance & Audit > Resource Watcher > API Guide

You can call the RESTful API to Resource Watcher to set alarm for changes in the status of events and resources.

User Access Key & Secret Access Key

To use REST API, you have to first obtain User Access Key and Secret Access Key.
User Access Key and Secret Access Key can be issued from API Security Settings.
Put the mouse pointer to an account in the top right of console, then select API Security Settings from the drop-down menu that appears and click on Create User Access Key ID.
For security purposes, it is recommended to create both User Access Key and Secret Access Key.

[Figure 1] API Security Settings Location

[Figure 2] API Security Settings Page

[Figure 3] Create User Access Key and Secret Access Key

Check Public API URL & Appkey

Appkey is required to use RESTful API.
You can check the issued key information by clicking URL & Appkey on the right side of console.

[ Figure 4] URL & Appkey

REST API Guide

Common Response Body

For all API requests, HTTP response code responds with 200.
For detailed response results, refer to header item in Response Body.

Key	Type	Description
header	Header	Response header

• Header

Key	Type	Description
isSuccessful	boolean	success (true, false)
resultCode	int	response code. If succeeds 0, if fails return the error code
resultMessage	String	Response message. If succeeds "SUCCESS", if fails return the error message

{
  "header": {
    "isSuccessful": true,
    "resultCode": 0,
    "resultMessage": "SUCCESS"
  }
}

1. Alarm

Alarm API v2 is recommended to use.

1.1 Register Alarm

[Basic Information]

Method	URI
POST	/resource-watcher/v1.0/appkeys/{appKey}/event-alarms

Permission
ResourceWatcher:Alarms.Create

You can set alarms for events that occur in a resource.

• Event information to set is 3.1. Refer to the response results from the Event List lookup API.
  
• Alarm targets include members, alarm receiving groups, roles, and WebHook types, and you can set targets for each type
• Resource targets can be set to resource group/tag.
• If set to All events, you can receive alarm for all events occurring in a particular resource.
• If set to All resources, you can receive alarm for specific events regardless of resources.
• All events and All resources cannot be set together.

[Request Header]

Key	Value
X-TC-AUTHENTICATION-ID	User Access Key issued from console
X-TC-AUTHENTICATION-SECRET	Secret Access Key issued from console

[Path Variable]

Key	Value
appKey	Appkey issued from console

[Request Body]

Key	Type	Required	Description
alarm	Alarm	Yes	Alarm Information
alarmTargets	AlarmTarget[]	Yes	Alarm receiving target information
events	Event[]	No	Alarm target event list Do not set if want to receive all events that occur.
target	target	No	Target Resource Information Do not set if receiving an event regardless of resources.

• Alarm

Key	Type	Required	Description
alarmName	String	Yes	alarm name Can be registered maximum 255 characters
Description	String	No	Alarm Description Can be registered maximum 1,000 characters

• AlarmTarget

Key	Type	Required	Description
alarmTargetTypeCode	String	Yes	Alarm target type 1. UUID: Single Organization Member Target (NHN cloud member, IAM member) 2. ROLE: Role targets (organizational roles, project role groups, project roles) 3. ALARM_KEY: Alarm receiving group target (organization alarm receiving group, project alarm receiving group) 4. WEBHOOK: Webhook
alarmTarget	String	No	Alarm target information 1. UUID: Member UUID 2. ROLE: Role ID(ex. ADMIN) 3. ALARM_KEY: alarm receiving group ID 4. WEBHOOK: Do not enter
e-mail Alarm	String	No	Whether received email or not 1. Y: Mail Reception 2. N: Mail not received Do not enter WEBHOOK, ALARM_KEY
smsAlarm	String	No	Whether received SMS or not 1. Y: SMS Reception 2. N: SMS not received Do not enter WEBHOOK, ALARM_KEY
webhookUrl	String	No	Webhook URL address Have to start with http:// or https:// Alarm target typeWEBHOOK Enter when setting
webhookSecret	String	No	WebhookSecret Key Alarm target type WEBHOOK Enter when setting

• Event

Key	Type	Required	Description
productId	String	Yes	service ID
eventId	String	Yes	event ID

For values of productId, eventid, refer to 3.1 Event List lookup API Response Value

• Target

Key	Type	Required	Description
resourceGroupIds	String[]	No	Resource Group ID list
resourceTagIds	Long[]	No	Resource tag ID list

• Example)

{
  "alarm": {
    "alarmName": "",
    "description": ""
  },
  "alarmTargets": [
    {
      "alarmTarget": "",
      "alarmTargetTypeCode": "",
      "emailAlarm": "",
      "smsAlarm": "",
      "webhookSecret": "",
      "webhookUrl": ""
    }
  ],
  "events": [
    {
      "eventId": "",
      "productId": ""
    }
  ],
  "target": {
    "resourceGroupIds": [
      ""
    ],
    "resourceTagIds": [
      ""
    ]
  }
}

[Response Body]

Key	Type	Description
alarm	Alarm	Alarm Information
alarmTargetAlarmKeys	AlarmTargetAlarmKey[]	Alarm receiving target list
alarmTargetMemberProfiles	AlarmTargetMemberProfile[]	Alarm receiving target profile list
alarmTargetRoles	AlarmTargetRole[]	Alarm receiving target ROLE list
alarmTargets	AlarmTarget[]	Alarm receiving target list
events	Event[]	Alarm event list
target	Target	target resource information

• Alarm

Key	Type	Description
alarmId	String	Alarm ID
alarmName	String	Alarm name
alarmRule	AlarmRule	Alarm rule detailed information
alarmStatusCode	String	Alarm status code Type 1. STABLE: Enable 2. DISABLED: Deactivate 3. CLOSED: delete
appKey	String	Appkey information
cabAlarmKey	String	Alarm receiving group ID
delDatetime	Date	date and time of deletion
description	String	Alarm description
modDatetime	Date	date and time of modification
operatorUuid	String	last modified user UUID
regDatetime	Date	date and time of registration

• AlarmRule

Key	Type	Description
alarmRuleId	String	alarm rule ID
alarmRuleStatusCode	String	alarm rule status code Type 1. STABLE: Enable 2. DISABLED: Deactivate 3. CLOSED: delete
alarmRuleName	String	alarm rule name
alarmRuleDescription	String	alarm rule Description
resourceTypes	String[]	List of target resource type codes that alarm rules apply If empty value, it targets all resource types String type list

• AlarmTargetAlarmKey

Key	Type	Description
alarmKey	String	alarm Key
alarmGroupName	String	alarm receiving group name
alarmGroupDesc	String	alarm receiving group description

• AlarmTargetMemberProfile

Key	Type	Description
uuid	String	member UUID
memberType	String	member type Type 1. TOAST_CLOUD 2. IAM
name	String	member name
corporationName	String	corporation name
email	String	member Email
userId	String	member ID

• AlarmTargetRole

Key	Type	Description
type	String	role type
roleId	String	role ID
roleName	String	role name
description	String	role description

• AlarmTarget

Key	Type	Description
alarmTargetTypeCode	String	alarm Target Type Code Type 1. UUID: Organization member NHN CLOUD, IAM 2. ROLE: Organizational roles, project role groups, project roles 3. ALARM_KEY: organization alarm receiving group, project alarm receiving group 4. WEBHOOK: Webhook
alarmTarget	String	alarm Target information
emailAlarm	String	whether received email or not(Y, N)
smsAlarm	string	whether received SMS or not (Y, N)
webhookUrl	string	Webhook URL address
webhookSecret	string	Webhook secret key

• Event

Key	Type	Description
productId	String	product ID
eventId	String	event ID

• Target

Key	Type	Description
resourceGroups	ResourceGroup[]	Resource group lsit
resourceTags	ResourceTag[]	Resource tag list

• ResourceGroup

Key	Type	Description
resourceGroupId	String	resource group ID list
resourceGroupName	String	resource tag ID list

• ResourceTag

Key	Type	Description
tagId	Long	resource tag ID
tagName	String	resource tag name

• Example

{
  "header": {
    "isSuccessful": true,
    "resultCode": 0,
    "resultMessage": ""
  },
  "alarm": {
    "alarmId": "",
    "alarmName": "",
    "alarmRule": {
      "alarmRuleDescription": "",
      "alarmRuleId": "",
      "alarmRuleName": "",
      "alarmRuleStatusCode": "",
      "resourceTypes": [
        ""
      ]
    },
    "alarmStatusCode": "",
    "appKey": "",
    "cabAlarmKey": "",
    "delDatetime": "yyyy-MM-ddTHH:mm:SS",
    "description": "",
    "modDatetime": "yyyy-MM-ddTHH:mm:SS",
    "operatorUuid": "",
    "regDatetime": "yyyy-MM-ddTHH:mm:SS"
  },
  "alarmTargetAlarmKeys": [
    {
      "alarmGroupDesc": "",
      "alarmGroupName": "",
      "alarmKey": ""
    }
  ],
  "alarmTargetMemberProfiles": [
    {
      "corporationName": "",
      "email": "",
      "memberType": "",
      "name": "",
      "userId": "",
      "uuid": ""
    }
  ],
  "alarmTargetRoles": [
    {
      "description": "",
      "roleId": "",
      "roleName": "",
      "type": ""
    }
  ],
  "alarmTargets": [
    {
      "alarmTarget": "",
      "alarmTargetTypeCode": "",
      "emailAlarm": "",
      "smsAlarm": "",
      "webhookSecret": "",
      "webhookUrl": ""
    }
  ],
  "events": [
    {
      "eventId": "",
      "productId": ""
    }
  ],
  "target": {
    "resourceGroups": [
      {
        "resourceGroupId": "",
        "resourceGroupName": ""
      }
    ],
    "resourceTags": [
      {
        "tagId": 0,
        "tagName": ""
      }
    ]
  }
}

1.2 Lookup Event Alarm

[Basic Information]

Method	URI
GET	/resource-watcher/v1.0/appkeys/{appKey}/event-alarms/{alarmId}

Permission
ResourceWatcher:Alarms.Get

Lookup registered alrms.

[Request Header]

Key	Value
X-TC-AUTHENTICATION-ID	User Access Key issued by the console
X-TC-AUTHENTICATION-SECRET	Secret Access Key issued by the console

[Path Variable]

Key	Value
appKey	Appkey issued from the console
alarmId	ID of the alarm to look up

[Response Body]

• Note: 1.1) Same as Response in Create event alarm.

1.3 Lookup Event Alarm list

[Basic Information]

Method	URI
POST	/resource-watcher/v1.0/appkeys/{appKey}/event-alarms/search

Permission
ResourceWatcher:Alarms.List

Look up the list of registered event alarms. - You can look up the list of alarms that you want through search criteria in the request. - Paging is supported.

[Request Header]

Key	Value
X-TC-AUTHENTICATION-ID	User Access Key issued by the console
X-TC-AUTHENTICATION-SECRET	Secret Access Key issued by the console

[Path Variable]

Key	Value
appKey	Appkey issued from console

[Query Parameter]

Key	Value	Required
page	Page number to look up Default value: 0	No
size	Number of alarms to view Default value: 10	No
sort	What and how to sort Default value: modDatetime, DESC	No

[Request Body]

Key	Type	Required	Description
alarmIds	String[]	No	List of alarm IDs String type list
alarmNameAnyLike	String	No	Alarm Name (Search for all alamrs including input value)
alarmRuleIds	String[]	No	alarm rule ID list String type list
alarmStatusCodes	String[]	No	alarm status String type list Default value: STABLE, DISABLED Type 1. STABLE: Enable 2. DISABLED: Deactivate 3. CLOSED: Delete
descriptionAnyLike	String	No	Alarm description (Search for all alamrs including input value)
modDateFrom	Date	No	starting date and time of last modification
modDateTo	Date	No	ending date and time of last modification
operatorUuids	String[]	No	Last modifier UUID list String type list
resourceGroupIds	String[]	No	Resource group list String type list

{
  "alarmIds": [
    ""
  ],
  "alarmNameAnyLike": "",
  "alarmRuleIds": [
    ""
  ],
  "alarmStatusCodes": [
    ""
  ],
  "descriptionAnyLike": "",
  "modDateFrom": "yyyy-MM-ddTHH:mm:SS",
  "modDateTo": "yyyy-MM-ddTHH:mm:SS",
  "operatorUuids": [
    ""
  ],
  "resourceGroupIds": [
    ""
  ]
}

[Response Body]

Key	Type	Description
alarms	Alarm[]	alarm list
totalItems	Long	Total count

• Alarm

Key	Type	Description
alarmId	String	Alarm ID
alarmName	String	alarm Name
alarmRule	AlarmRule	alarm rule detailed information
alarmStatusCode	String	alarm status code Type 1. STABLE: Enable 2. DISABLED: Deactivate 3. CLOSED: delete
appKey	String	Appkey information
cabAlarmKey	String	alarm receiving group ID
description	String	alarm description
operatorUuid	String	last modified user UUID
delDatetime	Date	date and time of deletion
modDatetime	Date	date and time of modification
regDatetime	Date	date and time of registration

• AlarmRule

Key	Type	Description
alarmRuleId	String	alarm rule ID
alarmRuleStatusCode	String	alarm rule status code Type 1. STABLE: Enable 2. DISABLED: Deactivate 3. CLOSED: delete
alarmRuleName	String	alarm rule name
alarmRuleDescription	String	alarm rule Description
resourceTypes	String[]	List of target resource type codes that alarm rules apply If empty value, it targets all resource types String type list

• Example

{
  "header": {
    "isSuccessful": true,
    "resultCode": 0,
    "resultMessage": ""
  },
  "alarms": [
    {
      "alarmId": "",
      "alarmName": "",
      "alarmRule": {
        "alarmRuleDescription": "",
        "alarmRuleId": "",
        "alarmRuleName": "",
        "alarmRuleStatusCode": "",
        "resourceTypes": [
          ""
        ]
      },
      "alarmStatusCode": "",
      "appKey": "",
      "cabAlarmKey": "",
      "delDatetime": "yyyy-MM-ddTHH:mm:SS",
      "description": "",
      "modDatetime": "yyyy-MM-ddTHH:mm:SS",
      "operatorUuid": "",
      "regDatetime": "yyyy-MM-ddTHH:mm:SS"
    }
  ],
  "totalItems": 0
}

1.4. Modify Event Alarms

[Basic Information]

Method	URI
PUT	/resource-watcher/v1.0/appkeys/{appKey}/event-alarms/{alarmId}

Permission
ResourceWatcher:Alarms.Update

Modify registered alarms. - As all requests will be changed, you must send existing settings even if there are no changes.

[Request Header]

Key	Value
X-TC-AUTHENTICATION-ID	User Access Key issued by the console
X-TC-AUTHENTICATION-SECRET	Secret Access Key issued by the console

[Path Variable]

Key	Value
appKey	Appkey issued from console
alarmId	Alarm ID to modify

[Request Body]

• Note: 1.1) Same as Request Body in Create event alarm.

1.5. Delete Event Alarm

[Basic Information]

Method	URI
DELETE	/resource-watcher/v1.0/appkeys/{appKey}/event-alarms/{alarmId}

Permission
ResourceWatcher:Alarms.Delete

Delete Registered Alarm

[Request Header]

Key	Value
X-TC-AUTHENTICATION-ID	User Access Key issued by the console
X-TC-AUTHENTICATION-SECRET	Secret Access Key issued by the console

[Path Variable]

Key	Value
appKey	Appkey issued from console
alarmId	alarm ID to delete

[Response Body]

• Note: Same as Common Response Body.

1.6. Delete mutiple Event Alarm

[Basic Information]

Method	URI
DELETE	/resource-watcher/v1.0/appkeys/{appKey}/event-alarms

Permission
ResourceWatcher:Alarms.Delete

Delete multiple Registered Alarm

[Request Header]

Key	Value
X-TC-AUTHENTICATION-ID	User Access Key issued by the console
X-TC-AUTHENTICATION-SECRET	Secret Access Key issued by the console

[Path Variable]

Key	Value
appKey	Appkey issued from console

[Query Parameter]

Key	Value	Required
alarmIds	Alarm ID list to delete Must enter more than 1 value.	Yes

[Response Body]

• Note: Same as Common Response Body.

2. alarm history

2.1. Look up alarm history

[Basic Information]

Method	URI
GET	/resource-watcher/v1.0/appkeys/{appKey}/alarms/{alarmId}/alarm-history/{alarmHistoryId}

Permission
ResourceWatcher:AlarmHistories.Get

Look up the history of the registered alarm for one time.

[Request Header]

Key	Value
X-TC-AUTHENTICATION-ID	User Access Key issued by the console
X-TC-AUTHENTICATION-SECRET	Secret Access Key issued by the console

[Path Variable]

Key	Value
appKey	Appkey issued from console
alarmId	Alarm ID to lookup history
alarmHistoryId	alarm history ID to lookup

[Response Body]

Key	Type	Description
alarm	Alarm	alarm
alarmHistory	AlarmHistory	alarm history
alarmRule	AlarmRule	Scope ID

• Alarm

Key	Type	Description
alarmId	String	alarm ID
alarmName	String	alarm Name
description	String	alarm description

• AlarmHistory

Key	Type	Description
alarmHistoryId	String	alarm history ID
resource	Resource	resource information
event	Event	event information
alarmSendResultTypeCode	String	alarm sending result Type 1. SUCCESS: Success 2. FAILURE: Failed 3. SENDING: sending

• AlarmRule

Key	Type	Description
alarmRuleDescription	String	alarm rule description
alarmRuleId	String	alarm rule ID
alarmRuleName	String	alarm rule name

• Resource

Key	Type	Description
appKey	String	App Key
resourceKey	String	Resource Identification Key
orgId	String	Organization ID
projectId	String	Project ID
projectName	String	Project Name
productId	String	Product ID
resourceAppKey	String	Product App Key of the resource. AppKey
iaasTenantId	String	IaaS tenant ID
regionCode	String	region code
resourceId	String	resource ID
resourceName	String	resource name
resourceTypeCode	String	resource type
resourceCreationTypeCode	String	resource creation type Type 1. SYSTEM: Create a system 2. USER: Create Member
resourceStatusCode	String	Resource Status Code Type 1. STABLE: Normal 2. CLOSED: Delete
description	String	Resource description
cloudResourceName	String	NHN Cloud Resource Name of the resource
createDatetime	Date	Event occurrence time
regDatetime	Date	Registration time
modDatetime	Date	Modification time
delDatetime	Date	Delete time

• Event

Key	Type	Description
appKey	String	Appkey that event occured
alarmId	String	alarmID
eventId	String	event ID
eventSourceType	String	Subject type that made event occur
eventUser	EventUser	member that made event occur
eventTarget	EventTarget	target of event occurred
eventDatetime	String	time that event occurred
regDatetime	Date	date and time of event registration

• EventUser

Key	Type	Description
userIdNo	String	user’s UUID who made event occur
userId	String	user’s name who made event occur
userIp	String	user’s IP who made event occur
userAgent	String	user’s agent who made event occur

• EventTarget

Key	Type	Description
targetMembers	TargetMember[]	target member of the event occurred

• TargetMember

Key	Type	Description
idNo	String	target user’s UUID that event occurred
name	String	target user’s name that event occurred
userCode	String	target user’s ID that event occurred(For IAM member)
emailAddress	String	target user that event occurred

{
  "header": {
    "isSuccessful": true,
    "resultCode": 0,
    "resultMessage": ""
  },
  "alarm": {
    "alarmId": "",
    "alarmName": "",
    "description": ""
  },
  "alarmHistory": {
    "alarmHistoryId": "",
    "alarmSendResultTypeCode": "",
    "event": {
      "alarmId": "",
      "appKey": "",
      "eventDatetime": "yyyy-MM-ddTHH:mm:SS",
      "eventId": "",
      "eventSourceType": "",
      "eventTarget": {
        "targetMembers": [
          {
            "emailAddress": "",
            "idNo": "",
            "name": "",
            "userCode": ""
          }
        ]
      },
      "eventUser": {
        "userAgent": "",
        "userId": "",
        "userIdNo": "",
        "userIp": ""
      },
      "regDatetime": "yyyy-MM-ddTHH:mm:SS"
    },
    "resource": {
      "appKey": "",
      "cloudResourceName": "",
      "createDatetime": "yyyy-MM-ddTHH:mm:SS",
      "delDatetime": "yyyy-MM-ddTHH:mm:SS",
      "description": "",
      "iaasTenantId": "",
      "modDatetime": "yyyy-MM-ddTHH:mm:SS",
      "orgId": "",
      "productId": "",
      "projectId": "",
      "projectName": "",
      "regDatetime": "yyyy-MM-ddTHH:mm:SS",
      "regionCode": "",
      "resourceAppKey": "",
      "resourceCreationTypeCode": "",
      "resourceId": "",
      "resourceKey": "",
      "resourceName": "",
      "resourceStatusCode": "",
      "resourceTypeCode": ""
    }
  },
  "alarmRule": {
    "alarmRuleDescription": "",
    "alarmRuleId": "",
    "alarmRuleName": ""
  },
  "projectName": ""
}

2.2. Lookup Alarm History List

[Basic Information]

Method	URI
GET	/resource-watcher/v1.0/appkeys/{appKey}/alarms/{alarmId}/alarm-history

Permission
ResourceWatcher:AlarmHistories.List

Lookup all the history that registered alarm sent.

[Request Header]

Key	Value
X-TC-AUTHENTICATION-ID	User Access Key issued by the console
X-TC-AUTHENTICATION-SECRET	Secret Access Key issued by the console

[Path Variable]

Key	Value
appKey	Appkey issued from console
alarmId	alarm ID that lookup history

[Query Parameter]

Key	Value	Required
resourceKeys	list of resurce identification key Multiple input available	No
resourceNameAnyLike	list of resurce identification key	No
eventIds	event ID list Multiple input available	No
eventSourceTypes	event source list Multiple input available	No
projectIds	Project ID list Multiple input available	No
productIds	Product ID list Multiple input available	No
alarmSendResultTypeCodes	Alarm sending result list(SENDING, SUCCESS, FAILURE) Multiple input available	No
regDateFrom	Starting date and time of period to lookup yyyy-MM-ddTHH:mm:SS	No
regDateTo	Ending date and time of period to lookup yyyy-MM-ddTHH:mm:SS	No
page	Page unmber to lookup Default value: 0	No
size	Number of alarms to view Default value: 10	No
sort	Sorting target and method	No

[Response Body]

Key	Type	Description
alarmHistories	AlarmHistory[]	Alarm histoy list
totalItems	Long	total count

• AlarmHistory

Key	Type	Description
alarmHistoriesId	String	alarm history ID
resource	Resource	Resource information
event	Event	Event information
alarmSendResultTypeCode	String	Alarm sending results Type 1. SUCCESS: Success 2. FAILURE: Failed 3. SENDING: sending

• Resource

Key	Type	Description
appKey	String	App Key
resourceKey	String	Resource Identification Key
orgId	String	Organization ID
projectId	String	Project ID
projectName	String	Project Name
productId	String	Product ID
resourceAppKey	String	Product App Key of the resource. AppKey
iaasTenantId	String	IaaS tenant ID
regionCode	String	region code
resourceId	String	resource ID
resourceName	String	resource name
resourceTypeCode	String	resource type
resourceCreationTypeCode	String	resource creation type Type 1. SYSTEM: Create a system 2. USER: Create Member
resourceStatusCode	String	Resource Status Code Type 1. STABLE :normal 2. CLOSED :delete
description	String	resource description
cloudResourceName	String	NHN Cloud Resource Name of resource
createDatetime	Date	Event occurrence time
regDatetime	Date	Registration time
modDatetime	Date	Modification time
delDatetime	Date	Delete time

• Event

Key	Type	Description
appKey	String	Appkey that event occured
alarmId	String	alarm ID
eventId	String	event ID
eventSourceType	String	Subject type that made event occur
eventUser	EventUser	member that made event occur
eventTarget	EventTarget	target of event occurred
eventDatetime	String	time that event occurred
regDatetime	Date	date and time of event registration

• EventUser

Key	Type	Description
userIdNo	String	user’s UUID that made event occur
userId	String	user’s name that made event occur
userIp	String	user’s IP that made event occur
userAgent	String	user’s agent that made event occur

• EventTarget

Key	Type	Description
targetMembers	TargetMember[]	taregt membr for the event occurred

• TargetMember

Key	Type	Description
idNo	String	target User’s UUID for the event occurred
name	String	target User’s name for the event occurred
userCode	String	target User’s ID for the event occurred (For IAM member)
emailAddress	String	target member for the event occurred

{
  "header": {
    "isSuccessful": true,
    "resultCode": 0,
    "resultMessage": ""
  },
  "alarmHistories": [
    {
      "alarmHistoryId": "",
      "alarmSendResultTypeCode": "",
      "event": {
        "alarmId": "",
        "appKey": "",
        "eventDatetime": "yyyy-MM-ddTHH:mm:SS",
        "eventId": "",
        "eventSourceType": "",
        "eventTarget": {
          "targetMembers": [
            {
              "emailAddress": "",
              "idNo": "",
              "name": "",
              "userCode": ""
            }
          ]
        },
        "eventUser": {
          "userAgent": "",
          "userId": "",
          "userIdNo": "",
          "userIp": ""
        },
        "regDatetime": "yyyy-MM-ddTHH:mm:SS"
      },
      "resource": {
        "appKey": "",
        "cloudResourceName": "",
        "createDatetime": "yyyy-MM-ddTHH:mm:SS",
        "delDatetime": "yyyy-MM-ddTHH:mm:SS",
        "description": "",
        "iaasTenantId": "",
        "modDatetime": "yyyy-MM-ddTHH:mm:SS",
        "orgId": "",
        "productId": "",
        "projectId": "",
        "projectName": "",
        "regDatetime": "yyyy-MM-ddTHH:mm:SS",
        "regionCode": "",
        "resourceAppKey": "",
        "resourceCreationTypeCode": "",
        "resourceId": "",
        "resourceKey": "",
        "resourceName": "",
        "resourceStatusCode": "",
        "resourceTypeCode": ""
      }
    }
  ],
  "totalItems": 0
}

3. Event

3.1. Lookup Event list

[Basic Information]

Method	URI
GET	/resource-watcher/v1.0/appkeys/{appKey}/events

Look up the list of events that can be set in alarm. - Event is based on the event ID registered in CloudTrail. - Provides search features for events. - When searching by event name or product name, you can set lang to search in the language that matches the set value.

[Request Header]

Key	Value
lang	Language code Search conditions and response values are values corresponding to the language code (ko, en, ja, zh) Default value: ko

[Path Variable]

Key	Value
appKey	Appkey issued by the console

[Query Parameter]

Key	Value	Required
productIdList	List of product IDs to search for Multiple input available	No
productNameLike	Product name to search	No
eventNameLike	Event name to search	No
page	Page number to lookup Default value: 0	No
size	Number of alarms to view Default value: 10	No
sort	What and how to sort Default value : productName:ASC,eventName:ASC	No

[Response Body]

Key	Type	Description
events	Event[]	list of events
total Items	Long	total count

• Event

Key	Type	Description
eventId	String	Event ID
productId	String	Product ID
productName	String	Product name

{
  "header": {
    "isSuccessful": true,
    "resultCode": 0,
    "resultMessage": ""
  },
  "eventPage": "",
  "events": [
    {
      "eventId": "",
      "productId": "",
      "productName": ""
    }
  ],
  "totalItems": 0
}