PrevNext
search by keyword

Recent Pages

Documentation
Basic Cloud Monitor
    Documentation
    Download PDF

    DescribeAlarmEvents

    Last updated: 2021-07-06 16:35:55
    Download PDF

      1. API Description

      Domain name for API request: monitor.tencentcloudapi.com.

      This API is used to query the list of alarm events.

      A maximum of 20 requests can be initiated per second for this API.

      Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: monitor.ap-shanghai-fsi.tencentcloudapi.com

      We recommend you use API Explorer
      Try it
      API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

      2. Input Parameters

      The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

      Parameter Name Required Type Description
      Action Yes String Common parameter. The value used for this API: DescribeAlarmEvents.
      Version Yes String Common parameter. The value used for this API: 2018-07-24.
      Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
      Module Yes String Module name, which is fixed at "monitor"
      Namespace Yes String Alarm policy type such as cvm_device, which is obtained through the DescribeAllNamespaces API
      MonitorType No String Monitoring type, such as MT_QCE, which is set to default.

      3. Output Parameters

      Parameter Name Type Description
      Events Array of AlarmEvent Alarm event list
      RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

      4. Example

      Example1 Querying event list

      Input Example

      POST / HTTP/1.1
Host: monitor.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAlarmEvents
<Common request parameters>
{
  "Module": "monitor",
  "Namespace": "cvm_device",
  "MonitorType": "MT_QCE"
}

      Output Example

      {
"Response": {
  "RequestId": "92hg92hj1-2h352h25hj-2h235h",
  "Events": [
    {
      "EventName": "ping_unreachable",
      "Description": "Unreachable by ping",
      "Namespace": "cvm_device"
    }
  ]
}
}

      5. Developer Resources

      SDK

      TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

      Command Line Interface

      6. Error Code

      The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

      Error Code Description
      ResourceNotFound The resource is not found.
      UnsupportedOperation Unsupported operation.
      tencent
      Copyright © 2013-2021 Tencent Cloud. All Rights Reserved.
      Privacy PolicyLegalCookie Policy