1. Interface Description
Interface request domain name: monitor.api3.convergecloud.com.
This API is used to get the basic alarm list.
Default interface request rate limit: 20 times per second.
Interface update time: 2020-09-25 15:17:37.
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: DescribeBasicAlarmList |
| 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 current value 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: 1573660800 |
| EndTime | No | No | Int64 | End time. The default value is the current timestamp. Example: 1573919999 |
| Limit | No | No | Int64 | Pagination parameter. Number of returned results per page. Value range: 1-100. Default: 20. Example: 20 |
| Offset | No | No | Int64 | Pagination parameter. Page offset. It starts from 0 and the default value is 0. Example: 0 |
| OccurTimeOrder | No | No | String | Sorts by the occurrence time. Valid values: ASC, DESC. Example: DESC |
| ProjectIds | No | No | Array of Int64 | Filters by project ID. Example: ["0"] |
| ViewNames | No | No | Array of String | Filters by policy type. Example: ["cvm_device"] |
| AlarmStatus | No | No | Array of Int64 | Filters by alarm status. Example: ["1"] |
| ObjLike | No | No | String | Filters by alarm object. Example: 123 |
| InstanceGroupIds | No | No | Array of Int64 | Filters by instance group ID Example: [11233] |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| Alarms | Array of DescribeBasicAlarmListAlarms | List of alarms. Example:View |
| Total | Int64 | Total number. Example: 2 |
| 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. |
| MissingParameter | Missing parameter. |
| LimitExceeded | The quota limit has been reached. |