com.actionsoft.sdk.local.api

接口 SLAAPI

public interface SLAAPI

SLA服务等级协议接口API。SLA（Service-Level Agreement）

方法概要

限定符和类型	方法和说明
int	countAlarmDataOfNoRead(java.lang.String instName) 查询管理员未读的告警日志数量
ResourceMetric	getMetric(java.lang.String metricId) SLA监控资源对象的指标定义
java.lang.String	getMetricName(java.lang.String metricId, java.lang.String lang) 获得SLA指标的多语言名称
java.util.List<ResourceMetric>	getMetrics() 全部SLA监控资源对象的指标定义
java.util.List<SLAAlarmEvent>	queryAlarmData(int firstRow, int rowCount) 查询前N条告警记录
java.util.List<SLAAlarmEvent>	queryAlarmData(java.lang.String instName, int firstRow, int rowCount) 查询前N条告警记录
java.util.List<SLAAlarmEvent>	queryAlarmDataByMetricId(java.lang.String metricId, int firstRow, int rowCount) 查询一个指标的前N条告警记录
java.util.List<SLAAlarmEvent>	queryAlarmDataByMetricId(java.lang.String instName, java.lang.String metricId, int firstRow, int rowCount) 查询一个指标的前N条告警记录
java.util.List<SLACollectionDataOfDay>	queryDayDataByMetricId(java.lang.String metricId) 查询一个SLA指标全部天维度的历史数据（只存储最近365天），可能多于365条
java.util.List<SLACollectionDataOfDay>	queryDayDataByMetricId(java.lang.String instName, java.lang.String metricId) 查询一个SLA指标全部天维度的历史数据（只存储最近365天），可能多于365条
java.util.List<SLACollectionDataOfDay>	queryDayDataByTime(java.lang.String time) 查找某时间点所有指标天单位的SLA指标值
java.util.List<SLACollectionDataOfHour>	queryHourDataByMetricId(java.lang.String metricId) 查询一个SLA指标全部小时维度的历史数据（只存储最近15天），可能多于360条
java.util.List<SLACollectionDataOfHour>	queryHourDataByMetricId(java.lang.String instName, java.lang.String metricId) 查询一个SLA指标全部小时维度的历史数据（只存储最近15天），可能多于360条
java.util.List<SLACollectionDataOfHour>	queryHourDataByTime(java.lang.String time) 查找某时间点所有指标1小时单位的SLA指标值
java.util.List<SLACollectionDataOfMinute>	queryMinuteDataByMetricId(java.lang.String metricId) 查询一个SLA指标全部分钟维度的历史数据（只存储最近24小时），可能多于288条
java.util.List<SLACollectionDataOfMinute>	queryMinuteDataByMetricId(java.lang.String instName, java.lang.String metricId) 查询一个SLA指标全部分钟维度的历史数据（只存储最近24小时），可能多于288条
java.util.List<SLACollectionDataOfMinute>	queryMinuteDataByTime(java.lang.String time) 查找某时间点所有指标5分钟单位的SLA指标值
void	registerAlarmListener(AlarmListener listener) 注册一个外部告警监听器，当告警规则被评估通过发出告警的同时，同步触发该接口。
void	throwAlarm(java.lang.String name, java.lang.String resourceId, int alarmLevel, java.lang.String metricId, java.lang.String appId, double value, java.lang.String detail) 生成一条告警信息
void	throwAlarm(java.lang.String name, java.lang.String resourceId, int alarmLevel, java.lang.String metricId, java.lang.String appId, double value, java.lang.String detail, java.lang.Object ext1) 生成一条告警信息
void	unRegisterAlarmListener(AlarmListener listener) 卸载一个外部的告警监听器

方法详细资料

throwAlarm

void throwAlarm(java.lang.String name,
                java.lang.String resourceId,
                int alarmLevel,
                java.lang.String metricId,
                java.lang.String appId,
                double value,
                java.lang.String detail)

生成一条告警信息

参数:

name - 告警名称(Id)

resourceId - 和告警关联的对象标志

alarmLevel - SLAConst.LEVEL_INFO/LEVEL_WARN/LEVEL_ERR

metricId - 所属指标

appId - 所在APP

value - 衡量值

detail - 详细信息

throwAlarm

void throwAlarm(java.lang.String name,
                java.lang.String resourceId,
                int alarmLevel,
                java.lang.String metricId,
                java.lang.String appId,
                double value,
                java.lang.String detail,
                java.lang.Object ext1)

生成一条告警信息

参数:

name - 告警名称(Id)

resourceId - 和告警关联的对象标志

alarmLevel - SLAConst.LEVEL_INFO/LEVEL_WARN/LEVEL_ERR

metricId - 所属指标

appId - 所在APP

value - 衡量值

detail - 详细信息

ext1 - 扩展信息

getMetric

ResourceMetric getMetric(java.lang.String metricId)

SLA监控资源对象的指标定义

参数:

metricId - 指标Id

返回:

如果未找到返回null

getMetrics

java.util.List<ResourceMetric> getMetrics()

全部SLA监控资源对象的指标定义

返回:

列表

getMetricName

java.lang.String getMetricName(java.lang.String metricId,
                               java.lang.String lang)

获得SLA指标的多语言名称

参数:

metricId - 指标Id

lang - 语言关键字

registerAlarmListener

void registerAlarmListener(AlarmListener listener)

注册一个外部告警监听器，当告警规则被评估通过发出告警的同时，同步触发该接口。开发者可通过实现自己的监听器对告警做处理（ 如向客户的IT基础设施发送AWS资源/服务告警日志， 或者根据告警级别发送短信）

参数:

listener - 开发者实现的监听器

另请参阅:

监听器接口

unRegisterAlarmListener

void unRegisterAlarmListener(AlarmListener listener)

卸载一个外部的告警监听器

参数:

listener - 开发者实现的监听器

另请参阅:

监听器接口

queryDayDataByMetricId

java.util.List<SLACollectionDataOfDay> queryDayDataByMetricId(java.lang.String metricId)

查询一个SLA指标全部天维度的历史数据（只存储最近365天），可能多于365条

参数:

metricId - 指标Id

返回:

按时间倒序的列表

queryDayDataByMetricId

java.util.List<SLACollectionDataOfDay> queryDayDataByMetricId(java.lang.String instName,
                                                              java.lang.String metricId)

查询一个SLA指标全部天维度的历史数据（只存储最近365天），可能多于365条

参数:

instName - AWS实例名

metricId - 指标Id

返回:

按时间倒序的列表

另请参阅:

PlatformAPI.getAWSServer().getInstanceName()获取当前AWS实例名

queryHourDataByMetricId

java.util.List<SLACollectionDataOfHour> queryHourDataByMetricId(java.lang.String metricId)

查询一个SLA指标全部小时维度的历史数据（只存储最近15天），可能多于360条

参数:

metricId - 指标Id

返回:

按时间倒序的列表

queryHourDataByMetricId

java.util.List<SLACollectionDataOfHour> queryHourDataByMetricId(java.lang.String instName,
                                                                java.lang.String metricId)

查询一个SLA指标全部小时维度的历史数据（只存储最近15天），可能多于360条

参数:

instName - AWS实例名

metricId - 指标Id

返回:

按时间倒序的列表

另请参阅:

PlatformAPI.getAWSServer().getInstanceName()获取当前AWS实例名

queryMinuteDataByMetricId

java.util.List<SLACollectionDataOfMinute> queryMinuteDataByMetricId(java.lang.String metricId)

查询一个SLA指标全部分钟维度的历史数据（只存储最近24小时），可能多于288条

参数:

metricId - 指标Id

返回:

按时间倒序的列表

queryMinuteDataByMetricId

java.util.List<SLACollectionDataOfMinute> queryMinuteDataByMetricId(java.lang.String instName,
                                                                    java.lang.String metricId)

查询一个SLA指标全部分钟维度的历史数据（只存储最近24小时），可能多于288条

参数:

instName - AWS实例名

metricId - 指标Id

返回:

按时间倒序的列表

另请参阅:

PlatformAPI.getAWSServer().getInstanceName()获取当前AWS实例名

queryDayDataByTime

java.util.List<SLACollectionDataOfDay> queryDayDataByTime(java.lang.String time)

查找某时间点所有指标天单位的SLA指标值

参数:

time - 采集时间

queryHourDataByTime

java.util.List<SLACollectionDataOfHour> queryHourDataByTime(java.lang.String time)

查找某时间点所有指标1小时单位的SLA指标值

参数:

time - 采集时间

queryMinuteDataByTime

java.util.List<SLACollectionDataOfMinute> queryMinuteDataByTime(java.lang.String time)

查找某时间点所有指标5分钟单位的SLA指标值

参数:

time - 采集时间

countAlarmDataOfNoRead

int countAlarmDataOfNoRead(java.lang.String instName)

查询管理员未读的告警日志数量

参数:

instName - AWS实例名

返回:

未读数

另请参阅:

PlatformAPI.getAWSServer().getInstanceName()获取当前AWS实例名

queryAlarmData

java.util.List<SLAAlarmEvent> queryAlarmData(int firstRow,
                                             int rowCount)

查询前N条告警记录

参数:

firstRow - 起始位置

rowCount - 条数

返回:

按时间倒序的列表

queryAlarmData

java.util.List<SLAAlarmEvent> queryAlarmData(java.lang.String instName,
                                             int firstRow,
                                             int rowCount)

查询前N条告警记录

参数:

instName - AWS实例名

firstRow - 起始位置

rowCount - 条数

返回:

按时间倒序的列表

另请参阅:

PlatformAPI.getAWSServer().getInstanceName()获取当前AWS实例名

queryAlarmDataByMetricId

java.util.List<SLAAlarmEvent> queryAlarmDataByMetricId(java.lang.String metricId,
                                                       int firstRow,
                                                       int rowCount)

查询一个指标的前N条告警记录

参数:

metricId - 指标Id

firstRow - 起始位置

rowCount - 条数

返回:

按时间倒序的列表

queryAlarmDataByMetricId

java.util.List<SLAAlarmEvent> queryAlarmDataByMetricId(java.lang.String instName,
                                                       java.lang.String metricId,
                                                       int firstRow,
                                                       int rowCount)

查询一个指标的前N条告警记录

参数:

instName - AWS实例名

metricId - 指标Id

firstRow - 起始位置

rowCount - 条数

返回:

按时间倒序的列表

另请参阅:

PlatformAPI.getAWSServer().getInstanceName()获取当前AWS实例名