云监控服务 CES云监控服务 CES

计算
弹性云服务器 ECS
裸金属服务器 BMS
云手机 CPH
专属主机 DeH
弹性伸缩 AS
镜像服务 IMS
函数工作流 FunctionGraph
云耀云服务器 HECS
VR云渲游平台 CVR
特惠算力专区
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
弹性文件服务 SFS
存储容灾服务 SDRS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
专属企业存储服务
云存储网关 CSG
专属分布式存储服务 DSS
CDN与智能边缘
内容分发网络 CDN
智能边缘云 IEC
智能边缘平台 IEF
人工智能
AI开发平台ModelArts
华为HiLens
图引擎服务 GES
图像识别 Image
文字识别 OCR
自然语言处理 NLP
内容审核 Moderation
图像搜索 ImageSearch
医疗智能体 EIHealth
园区智能体 CampusGo
企业级AI应用开发专业套件 ModelArts Pro
人脸识别服务 FRS
对话机器人服务 CBS
视频分析服务 VAS
语音交互服务 SIS
知识图谱 KG
人证核身服务 IVS
IoT物联网
设备接入 IoTDA
设备管理 IoTDM(联通用户专用)
全球SIM联接 GSL
IoT开发者服务
IoT数据分析
车联网服务 IoV
路网数字化服务 DRIS
IoT边缘 IoTEdge
设备发放 IoTDP
开发与运维
软件开发平台 DevCloud
项目管理 ProjectMan
代码托管 CodeHub
流水线 CloudPipeline
代码检查 CodeCheck
编译构建 CloudBuild
部署 CloudDeploy
云测 CloudTest
发布 CloudRelease
移动应用测试 MobileAPPTest
CloudIDE
Classroom
开源镜像站 Mirrors
应用魔方 AppCube
云性能测试服务 CPTS
应用管理与运维平台 ServiceStage
视频
实时音视频 SparkRTC
视频直播 Live
视频点播 VOD
媒体处理 MPC
视频接入服务 VIS
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
资源管理服务 RMS
应用身份管理服务 OneAccess
区块链
区块链服务 BCS
可信跨链数据链接服务 TCDAS
智能协作
IdeaHub
开发者工具
SDK开发指南
API签名指南
DevStar
HCloud CLI
Terraform
Ansible
云生态
云市场
合作伙伴中心
华为云培训中心
其他
管理控制台
消息中心
产品价格详情
系统权限
我的凭证
客户关联华为云合作伙伴须知
公共问题
宽限期保留期
奖励推广计划
活动
容器
云容器引擎 CCE
云容器实例 CCI
容器镜像服务 SWR
应用编排服务 AOS
多云容器平台 MCP
基因容器 GCS
容器洞察引擎 CIE
云原生服务中心 OSC
容器批量计算 BCE
容器交付流水线 ContainerOps
应用服务网格 ASM
网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
数据库
云数据库 RDS
数据复制服务 DRS
文档数据库服务 DDS
分布式数据库中间件 DDM
云数据库 GaussDB (for openGauss)
云数据库 GaussDB(for MySQL)
云数据库 GaussDB NoSQL
数据管理服务 DAS
数据库和应用迁移 UGO
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
可信智能计算服务 TICS
推荐系统 RES
云搜索服务 CSS
数据可视化 DLV
数据湖治理中心 DGC
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
API网关 APIG
分布式缓存服务 DCS
分布式消息服务RocketMQ版
企业应用
域名注册服务 Domains
云解析服务 DNS
云速建站 CloudSite
网站备案
华为云WeLink
会议
隐私保护通话 PrivateNumber
语音通话 VoiceCall
消息&短信 MSGSMS
云管理网络
SD-WAN 云服务
边缘数据中心管理 EDCM
云桌面 Workspace
应用与数据集成平台 ROMA Connect
ROMA资产中心 ROMAExchange
API全生命周期管理 ROMA API
安全与合规
安全技术与应用
DDoS防护 ADS
Web应用防火墙 WAF
云防火墙 CFW
应用信任中心 ATC
企业主机安全 HSS
容器安全服务 CGS
云堡垒机 CBH
数据库安全服务 DBSS
数据加密服务 DEW
数据安全中心 DSC
云证书管理服务 CCM
SSL证书管理 SCM
漏洞扫描服务 VSS
态势感知 SA
威胁检测服务 MTD
管理检测与响应 MDR
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
专属云
专属计算集群 DCC
解决方案
高性能计算 HPC
SAP
游戏云
混合云灾备
价格
成本优化最佳实践
专属云商业逻辑
用户服务
帐号中心
费用中心
成本中心
资源中心
企业管理
工单管理
客户运营能力
国际站常见问题
支持计划
专业服务
合作伙伴支持计划
更新时间:2021/10/08 GMT+08:00
分享

查询告警历史

功能介绍

根据告警ID查询告警历史。

URI

GET /V1.0/{project_id}/alarm-histories

  • 参数说明
    表1 参数说明

    名称

    是否必选

    说明

    project_id

    项目ID。

    获取方式请参见获取项目ID

    group_id

    服务提供的资源分组功能。创建的资源分组ID,如:rg1603107497873DK4O2pXbn。

    alarm_id

    告警规则ID。如:al1603088932912v98rGl1al。

    alarm_name

    告警规则名称:如alarm-test01。

    alarm_status

    告警历史的状态。取值为ok、alarm、insufficient_data。ok为正常,alarm为告警,insufficient_data为数据不足。

    alarm_level

    告警历史的告警级别。值为1、2、3、4。其中1为紧急,2为重要,3为次要,4为提示。

    namespace

    资源命名空间,如弹性云服务器的资源命名空间为:SYS.ECS,各服务命名空间可查看支持监控的服务列表

    from

    查询告警历史的起始时间。UNIX时间戳,单位毫秒,如:1602501480905。from、to如果不进行赋值,则默认to是当前时间,from是当前时间减7天的时间戳。

    to

    查询告警历史的截止时间。UNIX时间戳,单位毫秒,from必须小于等于to。from、to如果不进行赋值,则默认to是当前时间,from是当前时间减7天的时间戳。

    start

    分页起始值,类型为integer,默认值为0。

    limit

    单次查询数据的条数限制。取值范围(0,100],默认值为100,用于限制结果数据条数。

  • 样例
    GET https://{云监控的endpoint}/V1.0/{project_id}/alarms/alarm-histories?limit=10&start=0&from=1602494921346&to=1603099721346&alarm_name=alarm-test01

请求消息

响应消息

  • 响应参数

    名称

    参数类型

    是否必选

    说明

    alarm_histories

    Array of objects

    一条或者多条告警历史详细信息

    meta_data

    MetaData object

    返回查询结果的总条数。

    表2 alarm_histories字段数据结构说明

    名称

    参数类型

    是否必选

    说明

    alarm_id

    String

    告警规则的ID,如:al1603131199286dzxpqK3Ez。

    alarm_name

    String

    告警规则的名称,如:alarm-test01。

    alarm_description

    String

    告警规则的描述。

    metric

    Metric object

    指标信息。

    condition

    Condition object

    告警规则设置的告警策略。

    alarm_level

    Integer

    告警历史的告警级别。值为1、2、3、4。其中1为紧急,2为重要,3为次要,4为提示。

    alarm_type

    String

    告警类型。仅针对事件告警的参数,枚举类型:值为EVENT.SYS或者EVENT.CUSTOM

    alarm_enabled

    Boolean

    告警规则是否被启用,值为true或者false。

    alarm_action_enabled

    Boolean

    告警规则的告警触发动作是否被启用,值为true或者false。

    alarm_actions

    Array of objects

    告警触发的动作。 结构如下: { "type": "notification", "notificationList": ["urn:smn:southchina:68438a86d98e427e907e0097b7e35d47:sd"] }

    type可取值如下:

    notification:通知。

    autoscaling:弹性伸缩。

    notificationList:告警状态发生变化时,被通知对象的列表。

    ok_actions

    Array of objects

    告警恢复触发的动作。 结构如下: { "type": "notification", "notificationList": ["urn:smn:southchina:68438a86d98e427e907e0097b7e35d47:sd"] }

    type可取值如下:

    notification:通知。

    notificationList:告警状态发生变化时,被通知对象的列表。

    insufficientdata_actions

    Array of objects

    数据不足触发的动作。结构如下:{ "type": "notification", "notificationList": ["urn:smn:southchina:68438a86d98e427e907e0097b7e35d47:sd"] }

    type可取值如下:

    notification:数据不足触发告警通知。

    notificationList:数据不足触发告警通知时,被通知对象的ID列表。

    update_time

    Long

    告警状态变更的时间。UNIX时间戳,单位毫秒,例如:1603131199000。

    enterprise_project_id

    String

    企业项目ID。 值为all_granted_eps时,表示所有企业项目;值为0时,表示默认的企业项目default。

    trigger_time

    Long

    计算出该条告警历史的时间。UNIX时间戳,单位毫秒,例如:1603131199469。

    alarm_status

    String

    告警历史的状态。取值为ok、alarm、insufficient_data。 ok为正常,alarm为告警,insufficient_data为数据不足。

    datapoints

    Array of objects

    计算出该条告警历史的监控数据上报时间和监控数值。

    additional_info

    AdditionalInfo object

    告警历史额外字段,仅针对事件监控告警场景所产生的告警历史信息。

    表3 metric字段数据结构说明

    名称

    参数类型

    是否必选

    说明

    dimensions

    Arrays of objects

    指标维度。

    metric_name

    String

    指标名称。必须以字母开头,只能包含0-9/a-z/A-Z/_,长度最短为1,最大为64。 具体指标名请参见支持监控的服务列表中查询出的指标名。

    namespace

    String

    指标命名空间。例如弹性云服务器命名空间格式为service.item,service和item必须是字符串,必须以字母开头,只能包含0-9/a-z/A-Z/_,总长度最短为3,最大为32。

    说明:

    当alarm_type为(EVENT.SYS| EVENT.CUSTOM)时允许为空。

    表4 dimensions字段数据结构说明

    名称

    参数类型

    是否必选

    说明

    name

    String

    监控维度名称,例如弹性云服务器的维度为instance_id。各服务维度请参考支持监控的服务列表,可参考维度中key字段。

    value

    String

    维度取值,例如弹性云服务器的ID。

    长度最短为1,最大为256。

    表5 alarm_actions字段数据结构说明

    名称

    参数类型

    是否必选

    说明

    type

    String

    告警通知类型,取值如下:
    • notification:通知。
    • autoscaling:弹性伸缩。

    notificationList

    Array of strings

    告警状态发生变化时,被通知对象的列表。

    说明:

    被通知对象的ID列表的参数类型为字符串,最多可以配置5个ID。

    表6 ok_actions字段数据结构说明

    名称

    参数类型

    是否必选

    说明

    type

    String

    告警通知类型,取值如下:
    • notification:通知。
    • autoscaling:弹性伸缩。

    notificationList

    Array of strings

    告警状态发生变化时,被通知对象的列表。

    说明:

    被通知对象的ID列表的参数类型为字符串,最多可以配置5个ID。

    表7 insufficientdata_actions字段数据结构说明

    名称

    参数类型

    是否必选

    说明

    type

    String

    告警通知类型,取值如下:
    • notification:通知。
    • autoscaling:弹性伸缩。

    notificationList

    Array of strings

    告警状态发生变化时,被通知对象的列表。

    说明:

    被通知对象的ID列表的参数类型为字符串,最多可以配置5个ID。

    表8 condition字段数据结构说明

    名称

    参数类型

    是否必选

    说明

    period

    Integer

    监控数据粒度。

    取值范围:

    • 1,实时数据
    • 300,5分钟粒度
    • 1200,20分钟粒度
    • 3600,1小时粒度
    • 14400,4小时粒度
    • 86400,1天粒度
    说明:

    当period设置为1时,表示以原始的指标数据判断告警。当alarm_type为(EVENT.SYS| EVENT.CUSTOM)时允许为0。

    filter

    String

    数据聚合方式,支持的聚合方式如下:

    • average:聚合周期内指标数据的平均值。
    • max:聚合周期内指标数据的最大值。
    • min:聚合周期内指标数据的最小值。
    • sum:聚合周期内指标数据的求和值。
    • variance:聚合周期内指标数据的方差。

    comparison_operator

    String

    告警阈值的比较条件,可以是>、=、<、>=、<=。

    value

    Double

    告警阈值,取值范围[0, Number.MAX_VALUE],Number.MAX_VALUE值为1.7976931348623157e+108。

    具体阈值取值请参见附录中各服务监控指标中取值范围,如支持监控的服务列表中ECS的CPU使用率cpu_util取值范围可配置80。

    unit

    String

    数据的单位,最大长度为32位

    count

    Integer

    触发告警连续发生次数,取值范围[1, 5]

    suppress_duration

    Integer

    发送告警的周期。值可为0、300、600、900、1800、3600、10800、21600、43200、86400。0表示只告警一次,300表示每5分钟告警一次,600表示每10分钟告警一次,900表示每15分钟告警一次,1800表示每30分钟告警一次,3600表示每1小时告警一次,10800表示每3小时告警一次,21600表示每6小时告警一次,43200表示每12小时告警一次,86400表示每1天告警一次。

    表9 datapoints字段数据结构说明

    名称

    参数类型

    是否必选

    说明

    time

    Long

    计算出该条告警历史的监控数据上报时间,UNIX时间戳,单位毫秒,如:1603131028000。

    value

    Double

    计算出该条告警历史的监控数值,如:7.019。

    表10 additional_info字段数据结构说明

    名称

    参数类型

    是否必选

    说明

    resource_id

    String

    该条告警历史对应的资源ID,如:22d98f6c-16d2-4c2d-b424-50e79d82838f。

    resource_name

    String

    该条告警历史对应的资源名称,如:ECS-Test01。

    event_id

    String

    该条告警历史对应的事件ID,如:ev16031292300990kKN8p17J。

    表11 meta_data字段数据结构说明

    名称

    参数类型

    是否必选

    说明

    total

    Integer

    结果总条数。

  • 响应样例
    {
     "alarm_histories": [
       {
         "alarm_id": "al1604473987569z6n6nkpm1",
         "alarm_name": "TC_CES_FunctionBaseline_Alarm_008",
         "alarm_description": "",
         "metric": {
           "namespace": "SYS.VPC",
           "dimensions": [
             {
               "name": "bandwidth_id",
               "value": "79a9cc0c-f626-4f15-bf99-a1f184107f88"
             }
           ],
           "metric_name": "downstream_bandwidth"
         },
         "condition": {
           "period": 1,
           "filter": "average",
           "comparison_operator": ">=",
           "value": 0,
           "count": 3
         },
         "alarm_level": 2,
         "alarm_type": "",
         "alarm_enabled": false,
         "alarm_action_enabled": false,
         "alarm_actions": [],
         "ok_actions": [],
         "insufficientdata_actions": [],
         "update_time": 1604473988000,
         "enterprise_project_id": "0",
         "trigger_time": 1604473987607,
         "alarm_status": "alarm",
         "datapoints": [
           {
             "time": 1604473860000,
             "value": 0
           },
           {
             "time": 1604473800000,
             "value": 0
           },
           {
             "time": 1604473740000,
             "value": 0
           }
         ],
         "additional_info": {
           "resource_id": "",
           "resource_name": "",
           "event_id": ""
         }
       },
       {
         "alarm_id": "al1604473978613MvlvlbVZD",
         "alarm_name": "alarm_merge",
         "alarm_description": "",
         "metric": {
           "namespace": "AGT.ECS",
           "dimensions": [
             {
               "name": "instance_id",
               "value": "22d98f6c-16d2-4c2d-b424-50e79d82838f"
             }
           ],
           "metric_name": "load_average5",
           "resource_group_id": "rg160447397837330303XQbK",
           "resource_group_name": "group1"
         },
         "condition": {
           "period": 1,
           "filter": "average",
           "comparison_operator": ">=",
           "value": 0,
           "count": 3
         },
         "alarm_level": 2,
         "alarm_type": "RESOURCE_GROUP",
         "alarm_enabled": false,
         "alarm_action_enabled": false,
         "alarm_actions": [],
         "ok_actions": [],
         "insufficientdata_actions": [],
         "update_time": 1604473979000,
         "enterprise_project_id": "0",
         "trigger_time": 1604473979070,
         "alarm_status": "insufficient_data",
         "datapoints": [],
         "additional_info": {
           "resource_id": "",
           "resource_name": "",
           "event_id": ""
         }
       }
     ],
     "meta_data": {
       "total": 2
     }
    }

返回值

  • 正常

    200

  • 异常

    返回值

    说明

    400 Bad Request

    请求错误。

    401 Unauthorized

    未提供认证信息,或认证信息错误。

    403 Forbidden

    请求页面被禁止访问。

    408 Request Timeout

    请求超出了服务器的等待时间。

    429 Too Many Requests

    当前请求过多。

    500 Internal Server Error

    请求未完成,服务异常。

    503 Service Unavailable

    系统暂时不可用,请求受限。

错误码

请参考返回错误码说明

分享:

    相关文档

    相关产品