获取基础告警列表

最近更新时间: 2025-04-01 17:27:11

1. 接口描述

接口请求域名: monitor.api3.gsesgpucloud.com。

获取基础告警列表

默认接口请求频率限制:20次/秒。

接口更新时间:2020-09-25 15:17:37。

接口既验签名又鉴权。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数

参数名称 必选 允许NULL 类型 描述
Action String 公共参数,本接口取值:DescribeBasicAlarmList
Version String 公共参数,本接口取值:2018-07-24
Region String 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表
Module String 接口模块名,当前取值monitor
示例值:
StartTime Int64 起始时间,默认一天前的时间戳
示例值:
EndTime Int64 结束时间,默认当前时间戳
示例值:
Limit Int64 分页参数,每页返回的数量,取值1~100,默认20
示例值:
Offset Int64 分页参数,页偏移量,从0开始计数,默认0
示例值:
OccurTimeOrder String 根据发生时间排序,取值ASC或DESC
示例值:
ProjectIds Array of Int64 根据项目ID过滤
示例值:
ViewNames Array of String 根据策略类型过滤
示例值:
AlarmStatus Array of Int64 根据告警状态过滤
示例值:
ObjLike String 根据告警对象过滤
示例值:
InstanceGroupIds Array of Int64 根据实例组ID过滤
示例值:

3. 输出参数

参数名称 类型 描述
Alarms DescribeBasicAlarmListAlarms 告警列表
示例值:查看
Total Int64 总数
示例值:
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码

错误码 描述
InvalidParameterValue 无效的参数值。
InternalError 内部错误。
InvalidParameter 参数错误。
MissingParameter 缺少参数错误。
LimitExceeded 超过配额限制。