| Name | Description | Type | Notes |
|---|---|---|---|
| _create_time | Timestamp of resource creation | EpochMsTimestamp | Readonly Sortable |
| _create_user | ID of the user who created this resource | string | Readonly |
| _last_modified_time | Timestamp of last modification | EpochMsTimestamp | Readonly Sortable |
| _last_modified_user | ID of the user who last modified this resource | string | Readonly |
| _links | References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST. |
array of ResourceLink | Readonly |
| _protection | Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. |
string | Readonly |
| _revision | Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. |
int | |
| _schema | Schema for this resource | string | Readonly |
| _self | Link to this resource | SelfResourceLink | Readonly |
| _system_owned | Indicates system owned resource | boolean | Readonly |
| alarm_source | Source identifying entity that the Event instance applies to
If alarm_source_type = INTENT_PATH, this field will contain a list of intent paths for the entity that the event instance applies to. If alarm_source_type = ENTITY_ID, this field will contain a list with a single item identifying the entity id that the event instance applies to. |
array of string | Required Readonly |
| alarm_source_type | Alarm Source type of the Event Type of alarm source of the Event instance. Can be one of - INTENT_PATH, ENTITY_ID. |
AlarmSourceType | Required Readonly |
| description | Detailed description of Alarm Detailed description of Alarm. This is the same detailed description as the corresponding Event identified by feature_name.event_type. |
string | Required Readonly |
| display_name | Identifier to use when displaying entity in logs or GUI Defaults to ID if not set |
string | Maximum length: 255 Sortable |
| entity_id | The UUID of the entity that the Event instance applies to The entity that the Event instance applies to. Note entity_id may not be included in a response body. For example, the cpu_high Event may not return an entity_id. |
string | Readonly |
| entity_resource_type | The type of entity that the Event instance applies to The entity type that the Event instance applies to. |
string | Readonly |
| event_type | Name of event Name of Event, e.g. manager_cpu_usage_high, certificate_expired. |
string | Required Readonly |
| event_type_display_name | Display name of event type Display name of Event type. |
string | Required Readonly |
| feature_display_name | Display name of feature Display name of feature defining this Event. |
string | Required Readonly |
| feature_name | Feature defining this event Feature defining this Event, e.g. manager_health, certificates. |
string | Required Readonly |
| id | ID that uniquely identifies an Alarm ID that uniquely identifies an Alarm. |
string | Required Readonly |
| last_reported_time | Last reported time of event instance Indicates when the corresponding Event instance was last reported in milliseconds since epoch. |
EpochMsTimestamp | Readonly |
| node_display_name | Display name of node Display name of node that the event instance applies to. |
string | Readonly |
| node_id | The UUID of the node that the Event instance applies to The UUID of the node that the Event instance applies to. |
string | Required Readonly |
| node_ip_addresses | IP addresses of node IP addresses of node that the event instance applies to. |
array of string | Readonly |
| node_resource_type | The resource type of node that the Event instance applies to The resource type of node that the Event instance applies to eg. ClusterNodeConfig, HostNode, EdgeNode. |
string | Readonly |
| recommended_action | Recommended action for Alarm Recommended action for Alarm. This is the same action as the corresponding Event identified by feature_name.event_type. |
string | Required Readonly |
| reoccurrences_while_suppressed | The number of reoccurrences since this alarm has been SUPPRESSED The number of reoccurrences since this alarm has been SUPPRESSED. |
integer | Readonly |
| resolved_by | User ID of the user that set the status value to RESOLVED User ID of the user that set the status value to RESOLVED. This value can be SYSTEM to indicate that the system resolved the Alarm, for example when the system determines CPU usage is no longer high and the cpu_high Alarm is no longer applicable. This property is only returned when the status value is RESOLVED. |
string | Readonly |
| resolved_time | Time when Alarm was resolved Indicates when the Alarm was resolved in milliseconds since epoch. This property is only returned when the status value is RESOLVED. |
EpochMsTimestamp | Readonly |
| resource_type | Must be set to the value Alarm | string | |
| severity | Severity of the Alarm Severity of the Alarm.Can be one of - CRITICAL, HIGH, MEDIUM, LOW. |
MonitoringSeverity | Required Readonly |
| status | Status of the Alarm Indicate the status which the Alarm is in. |
MonitoringStatus | Required |
| summary | Summary description of Alarm Summary description of Alarm. This is the same summary description as the corresponding Event identified by feature_name.event_type. |
string | Required Readonly |
| suppress_duration | Duration in hours for which an Alarm is SUPPRESSED The time period between suppress_start_time and suppress_start_time + suppress_duration (specified in hours) an Alarm is SUPPRESSED. This property is only returned when the status value is SUPPRESSED. |
integer | |
| suppress_start_time | Time when Alarm was suppressed Indicates when the Alarm was suppressed in milliseconds since epoch. This property is only returned when the status value is SUPPRESSED. |
EpochMsTimestamp | Readonly |
| suppressed_by | User ID of the user that set the status value to SUPPRESSED User ID of the user that set the status value to SUPPRESSED. This property is only returned when the status value is SUPPRESSED. |
string | Readonly |
| tags | Opaque identifiers meaningful to the API user | array of Tag | Maximum items: 30 |