内容纲要
概要描述
第三方软件可以调用API来对Transwarp Manager管理的服务进行监控和告警,本文介绍通过rest api查询某个时间段内TDH集群产生的告警记录信息。
详细说明
API URL
/alerts?status={status}&start={startTimeStamp}&end={endTimeStamp}&severity={severity}&category={category}&clusterId={clusterId}&serviceId={serviceId}&nodeId={nodeId}
参数说明
- status:待查询告警的状态:ACTIVE查询活跃的告警;CLEARED查询解除的告警;缺省查询所有告警;
- startTimeStamp:开始时间戳,当status为ACTIVE时,请缺省该参数,当status不为ACTIVE时,不能为空,且必须是整数形式,表示查询该时间戳之前的告警;
- endTimeStamp:结束时间戳,当status为ACTIVE时,请缺省该参数,当status不为ACTIVE时,不能为空,且必须是整数形式,表示查询该时间戳之后的告警;
- severity:待查询告警的等级,缺省查询所有等级的告警,CRITICAL查询所有CRITICAL级别告警,WARNING查询所有WARNING级别告警,UNKNOWN查询所有UNKNOWN级别告警;
- category:待查询告警的分类,缺省查询所有分类的告警,METRICS查询指标相关的告警,HEALTH_CHECK查询健康检查相关的告警,FAILOVER查询故障切换相关的告警;
- clusterId:待查询告警所属的集群,缺省查询所有集群的告警,否则指定cluster的id查询指定集群的告警;
- serviceId:待查询告警所属的服务,缺省查询所有服务相关的告警,否则指定service的id查询指定服务的告警;
- nodeId:待查询告警所属的节点,缺省查询所有节点相关的告警,否则指定node的id查询指定节点的告警
使用样例
-
获取登录cookie信息
通过api获取alter信息时,需要先登录Manager,才可以,否则会提示认证的错:The resource requires authentication, which was not supplied with the request
以下命令中的 userName 是登录manager的用户名,userPassword 是对应用户的密码:
curl -v -X POST http://172.22.17.1:8180/api/users/login --data '{"userName":"admin","userPassword":"admin"}' -b cookies.txt -c cookies.txt
-
获取alter信息
示例为查询活跃的告警:
curl http://172.22.17.1:8180/api/alerts?status=ACTIVE -b cookies.txt