Last updated: 2021-07-06 16:46:56

    1. API Description

    Domain name for API request:

    This API is used to get the platform event list.

    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:

    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: DescribeAccidentEventList.
    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 API component name. The value for the current API is monitor.
    StartTime No Integer Start time, which is the timestamp one day prior by default.
    EndTime No Integer End time, which is the current timestamp by default.
    Limit No Integer Number of parameters that can be returned on each page. Value range: 1 - 100. Default value: 20.
    Offset No Integer Parameter offset on each page. The value starts from 0 and the default value is 0.
    UpdateTimeOrder No String Sorting rule by UpdateTime. Valid values: asc and desc.
    OccurTimeOrder No String Sorting rule by OccurTime. Valid values: asc or desc. Sorting by UpdateTimeOrder takes priority.
    AccidentType.N No Array of Integer Filter by event type. The value 1 indicates service issues. The value 2 indicates other subscriptions.
    AccidentEvent.N No Array of Integer Filter by event. The value 1 indicates CVM storage issues. The value 2 indicates CVM network connection issues. The value 3 indicates that the CVM has an exception. The value 202 indicates that an ISP network jitter occurs.
    AccidentStatus.N No Array of Integer Filter by event status. The value 0 indicates that the event has been recovered. The value 1 indicates that the event has not been recovered.
    AccidentRegion.N No Array of String Filter by region where the event occurs. The value gz indicates Guangzhou. The value sh indicates Shanghai.
    AffectResource No String Filter by affected resource, such as ins-19a06bka.

    3. Output Parameters

    Parameter Name Type Description
    Alarms Array of DescribeAccidentEventListAlarms Platform event list.
    Note: This field may return null, indicating that no valid value was found.
    Total Integer Total number of platform events.
    Note: This field may return null, indicating that no valid value was found.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Getting platform event list

    This example shows you how to get the list of platform events.

    Input Example
    &<Common request parameters>

    Output Example

    "Response": {
      "Alarms": [
          "OccurTime": "2019-10-10T15:03:31+08:00",
          "BusinessID": 1,
          "AffectResource": "ins-19708ino",
          "EventStatus": 0,
          "Region": "gz",
          "UpdateTime": "2019-10-10T15:03:31+08:00",
          "AccidentTypeDesc": "The CVM instance is running exceptionally",
          "BusinessTypeDesc": "Service issue"
      "Total": 1,
      "RequestId": "test813c-45d8-459a-8978-aaasahuiaa"

    5. Developer Resources


    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
    InternalError Internal error.
    InvalidParameter Invalid parameter.
    InvalidParameterValue The parameter value is incorrect.
    LimitExceeded Quota limit is reached.
    UnsupportedOperation Unsupported operation.