1. Interface Description
Interface request domain name: monitor.api3.convergecloud.com.
This API is used to get the platform event list.
Default interface request rate limit: 20 times per second.
Interface update time: 2020-03-01 17:38:44.
The interface is both signature verification and authentication.
2. Input Parameters
The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.
| Parameter name | Required | Allow NULL | Type | Description |
|---|---|---|---|---|
| Action | Yes | No | String | Public parameter, The value of this interface: DescribeAccidentEventList |
| Version | Yes | No | String | Public parameter, The value of this interface: 2018-07-24 |
| Region | No | No | String | Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface |
| Module | Yes | No | String | API module name. The value of the current API is "monitor". Example: monitor |
| StartTime | No | No | Int64 | Start time. The default value is the timestamp that is 1 day ago from this day. Example: 1734900808 |
| EndTime | No | No | Int64 | End time. The default value is the current timestamp. Example: 1734950808 |
| Limit | No | No | Int64 | Pagination parameter. Number of returned results per page. Value range: 1-100. Default: 20. Example: 10 |
| Offset | No | No | Int64 | Pagination parameter. Page offset. It starts from 0 and the default value is 0. Example: 0 |
| UpdateTimeOrder | No | No | String | Sorting rule by UpdateTime. Valid values: asc or desc. Example: desc |
| OccurTimeOrder | No | No | String | Sorting rule by OccurTime. Valid values: asc or desc. Sorting by UpdateTimeOrder takes priority. Example: desc |
| AccidentType | No | No | Array of Int64 | Filters by event type. The value 1 indicates service issues. The value 2 indicates other subscriptions. Example: 1 |
| AccidentEvent | No | No | Array of Int64 | Filters 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. Example: 1 |
| AccidentStatus | No | No | Array of Int64 | Filters by event status. The value 0 indicates that the event has been recovered. The value 1 indicates that the event has not been recovered. Example: 0 |
| AccidentRegion | No | No | Array of String | Filters by event region. Example: gz |
| AffectResource | No | No | String | Filters by affected resource, such as ins-19a06bka. Example: ins-19a06bka |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| Alarms | Array of DescribeAccidentEventListAlarms | List of platform events. Example:View |
| Total | Int64 | Total number of platform events. Example: 10 |
| RequestId | String | Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem. |
4. Error Code
The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.
| Error Code | Description |
|---|---|
| InvalidParameterValue | Invalid parameter value. |
| InternalError | Internal error. |
| InvalidParameter | Invalid parameter. |
| LimitExceeded | The quota limit has been reached. |