All Products
Search
Document Center

CloudMonitor:DescribeSystemEventAttribute

Last Updated:Jul 26, 2024

Queries the details of a system event.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
cms:DescribeSystemEventAttributeget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ProductstringNo

The abbreviation of the service name.

Note You can call the DescribeSystemEventMetaList operation to query the abbreviations of service names.
oss
EventTypestringNo

The type of the system event.

Note You can call the DescribeSystemEventMetaList operation to query the types of system events.
Exception
NamestringNo

The name of the system event.

Note You can call the DescribeSystemEventMetaList operation to query the names of system events.
BucketIngressBandwidth
LevelstringNo

The level of the system event. Valid values:

  • CRITICAL: critical
  • WARN: warning
  • INFO: information
CRITICAL
StatusstringNo

The status of the system event.

Note You can call the DescribeSystemEventMetaList operation to query the statuses of system events.
normal
GroupIdstringNo

The ID of the application group.

12346
SearchKeywordsstringNo

The keywords that are used to search for the system event. Valid values:

  • If you want to search for the system event whose content contains a and b, set the value to a and b.
  • If you want to search for the system event whose content contains a or b, set the value to a or b.
cms
StartTimestringNo

The beginning of the time range to query.

The value must be a UNIX timestamp. It is the number of seconds that have elapsed since 00:00:00 UTC, January 1, 1970.

1552199984949
EndTimestringNo

The end of the time range to query.

The value must be a UNIX timestamp. It is the number of seconds that have elapsed since 00:00:00 UTC, January 1, 1970.

1552221584949
PageNumberintegerNo

The number of the page to return.

Valid values: 1 to 100000000.

Default value: 1.

1
PageSizeintegerNo

The number of entries to return on each page.

Valid values: 1 to 100.

Default value: 10

10

Response parameters

ParameterTypeDescriptionExample
object
Codestring

The HTTP status code.

Note The status code 200 indicates that the call is successful.
200
Messagestring

The message that is returned. If the call is successful, success is returned. If the call fails, an error message is returned.

success
RequestIdstring

The ID of the request.

60912C8D-B340-4253-ADE7-61ACDFD25CFC
Successstring

Indicates whether the call is successful. Valid values: True: The call is successful. false: The call fails.

true
SystemEventsarray<object>

The details of the event.

object
Statusstring

The status of the event.

normal
Timelong

The time when the event occurred. The value is a timestamp.

Unit: milliseconds.

1552199984000
GroupIdstring

The ID of the application group.

12345
Productstring

The abbreviation of the service name.

CloudMonitor
InstanceNamestring

The instance name.

instanceId1
ResourceIdstring

The resource ID.

xxxxx-1
Namestring

The event name.

Agent_Status_Stopped
Contentstring

The details of the event.

[{"product":"CloudMonitor","content":"{\"ipGroup\":\"112.126.XX.XX,10.163.XX.XX\",\"tianjimonVersion\":\"1.2.22\"}","groupId":"176,177,178,179,180,692,120812,1663836,96,2028302","time":"1552209568000","resourceId":"acs:ecs:cn-beijing:173651113438****:instance/i-25k35****","level":"CRITICAL","status":"stopped","instanceName":"cmssiteprobebj-6","name":"Agent_Status_Stopped","regionId":"cn-beijing"}]
Levelstring

The level of the event. Valid values:

  • CRITICAL
  • WARN
  • INFO
WARN
RegionIdstring

The region ID.

cn-hangzhou
Idstring

The event ID.

b936efc9-f621-4e8a-a6eb-076be40e****

Examples

Sample success responses

JSONformat

{
  "Code": "200",
  "Message": "success",
  "RequestId": "60912C8D-B340-4253-ADE7-61ACDFD25CFC",
  "Success": "true",
  "SystemEvents": {
    "SystemEvent": [
      {
        "Status": "normal",
        "Time": 1552199984000,
        "GroupId": "12345",
        "Product": "CloudMonitor",
        "InstanceName": "instanceId1",
        "ResourceId": "xxxxx-1",
        "Name": "Agent_Status_Stopped",
        "Content": "[{\"product\":\"CloudMonitor\",\"content\":\"{\\\"ipGroup\\\":\\\"112.126.XX.XX,10.163.XX.XX\\\",\\\"tianjimonVersion\\\":\\\"1.2.22\\\"}\",\"groupId\":\"176,177,178,179,180,692,120812,1663836,96,2028302\",\"time\":\"1552209568000\",\"resourceId\":\"acs:ecs:cn-beijing:173651113438****:instance/i-25k35****\",\"level\":\"CRITICAL\",\"status\":\"stopped\",\"instanceName\":\"cmssiteprobebj-6\",\"name\":\"Agent_Status_Stopped\",\"regionId\":\"cn-beijing\"}]",
        "Level": "WARN",
        "RegionId": "cn-hangzhou",
        "Id": "b936efc9-f621-4e8a-a6eb-076be40e****"
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
400ParameterInvalidIllegal parameters.-
403AccessForbiddenUser not authorized to operate on the specified resource.-
404ResourceNotFoundThe specified resource is not found.The specified resource is not found.
500InternalErrorThe request processing has failed due to some unknown error.-

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-12-07The Error code has changed. The response structure of the API has changedView Change Details