云服务器内容精选

  • 响应参数 状态码: 201 表8 响应Body参数 参数 参数类型 描述 alarm_id String 告警规则id,以al开头,包含22个数字或字母 状态码: 400 表9 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度:0 最大长度:256 error_msg String 请求异常信息 最小长度:0 最大长度:256 request_id String 请求ID 最小长度:0 最大长度:256 状态码: 500 表10 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度:0 最大长度:256 error_msg String 请求异常信息 最小长度:0 最大长度:256 request_id String 请求ID 最小长度:0 最大长度:256
  • 注意事项 按搜索分析创建告警规则功能目前在邀测中,暂不支持申请开通。 按SQL统计创建告警规则功能仅支持全部用户使用的局点有:华南-广州、华北-北京四、华北-乌兰察布二零一、华北-乌兰察布一、华东-上海一、华东-上海二、中国-香港、亚太-曼谷、亚太-新加坡,支持部分白名单用户使用的局点有:华北-北京一、西南-贵阳一、亚太-曼谷、华南-深圳、华北-乌兰察布一、华北-乌兰察布二零二,其他局点暂不支持该功能。
  • 告警规则后续操作 支持对单个告警规则进行如下操作: 修改告警规则:单击告警规则所在行后的按钮,根据表1修改具体参数,支持修改规则名称,修改完成后,鼠标悬浮在规则名称上,显示修改后的规则名称和原始名称。不支持修改首次创建的原始名称。 开启告警规则:单击告警规则所在行后的按钮(关闭告警规则后,才会显示开启按钮),开启告警规则。 关闭告警规则:单击告警规则所在行后的按钮(开启告警规则后,才会显示关闭按钮),关闭告警规则。 临时关闭告警规则:单击告警规则所在行后的按钮,设置临时关闭的截止时间。 复制告警规则:单击告警规则所在行后的按钮,复制告警规则。 删除告警规则:单击告警规则所在行后的按钮,单击“确定”删除该规则。 勾选多个告警规则后,支持对多个告警进行批量操作:开启、关闭、临时关闭、取消临时关闭、告警恢复开启、告警恢复关闭、删除、导出。
  • 返回值 正常 201 异常 返回值 说明 400 Bad Request 请求错误。 401 Unauthorized 未提供认证信息,或认证信息错误。 403 Forbidden 请求页面被禁止访问。 408 Request Timeout 请求超出了服务器的等待时间。 429 Too Many Requests 当前请求过多。 500 Internal Server Error 请求未完成,服务异常。 503 Service Unavailable 系统暂时不可用,请求受限。
  • URI GET /v2/{project_id}/alarms 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户ID 最小长度:1 最大长度:64 表2 Query参数 参数 是否必选 参数类型 描述 alarm_id 否 String 告警规则ID 正则匹配:^al([0-9A-Za-z]){22}$ name 否 String 告警名称, 只能包含0-9/a-z/A-Z/_/-或汉字,长度1-128 最小长度:1 最大长度:128 正则匹配:^([\u4E00-\u9FFF]|[a-z]|[A-Z]|[0-9]|_|-)+$ namespace 否 String 查询服务的命名空间,各服务命名空间请参考“服务命名空间” 最大长度:32 正则匹配:^((([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_)*\.([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_)*)|)$ resource_id 否 String 告警资源ID,多维度情况按字母升序排列并使用逗号分隔。 最大长度:700 正则匹配:^([a-z]|[A-Z]|[0-9]|_|-|:|,|\.|)+$ enterprise_project_id 否 String 企业项目ID 正则匹配:^((([a-z]|[0-9]){8}-([a-z]|[0-9]){4}-([a-z]|[0-9]){4}-([a-z]|[0-9]){4}-([a-z]|[0-9]){12})|0)$ offset 否 Integer 分页偏移量 最小值:0 最大值:10000 缺省值:0 正则匹配:^([0]|[1-9]|[1-9][0-9]|[1-9][0-9][0-9]|[1-9][0-9][0-9][0-9]|10000)$ limit 否 Integer 分页大小 最小值:1 最大值:100 缺省值:10 正则匹配:^([1-9]|[1-9][0-9]|100)$
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 否 String 发送的实体的MIME类型。默认使用application/json; charset=UTF-8。 缺省值:application/json; charset=UTF-8 最小长度:1 最大长度:64 X-Auth-Token 否 String 用户Token 最小长度:1 最大长度:16384
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 alarms Array of alarms objects 告警规则列表 数组长度:0 - 100 count Integer 告警规则列表总数 最小值:0 最大值:1000 表5 alarms 参数 参数类型 描述 alarm_id String 告警规则ID 正则匹配:^al([0-9A-Za-z]){22}$ name String 告警规则名称 最小长度:1 最大长度:128 正则匹配:^([\u4E00-\u9FFF]|[a-z]|[A-Z]|[0-9]|_|-)+$ description String 告警规则描述 最小长度:0 最大长度:256 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度:0 最大长度:256 error_msg String 请求异常信息 最小长度:0 最大长度:256 request_id String 请求ID 最小长度:0 最大长度:256 状态码: 401 表7 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度:0 最大长度:256 error_msg String 请求异常信息 最小长度:0 最大长度:256 request_id String 请求ID 最小长度:0 最大长度:256 状态码: 403 表8 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度:0 最大长度:256 error_msg String 请求异常信息 最小长度:0 最大长度:256 request_id String 请求ID 最小长度:0 最大长度:256 状态码: 500 表9 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度:0 最大长度:256 error_msg String 请求异常信息 最小长度:0 最大长度:256 request_id String 请求ID 最小长度:0 最大长度:256
  • URI GET /v2/{project_id}/alarm-templates/{template_id}/association-alarms 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户ID 最小长度:1 最大长度:64 template_id 是 String 告警模板的ID,以at开头,后跟字母、数字,长度最长为64 最小长度:2 最大长度:64 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 分页查询时查询的起始位置,表示从第几条数据开始,默认为0 最小值:0 最大值:10000 limit 否 Integer 查询结果条数的限制值,取值范围为[1,100],默认值为100 最小值:1 最大值:100
  • 告警规则后续操作 支持对单个告警规则进行如下操作: 修改告警规则:单击告警规则所在行后的按钮,根据表1修改具体参数,支持修改规则名称,修改完成后,鼠标悬浮在规则名称上,显示修改后的规则名称和原始名称。不支持修改首次创建的原始名称。 开启告警规则:单击告警规则所在行后的按钮(关闭告警规则后,才会显示开启按钮),开启告警规则。 关闭告警规则:单击告警规则所在行后的按钮(开启告警规则后,才会显示关闭按钮),关闭告警规则。 临时关闭告警规则:单击告警规则所在行后的按钮,设置临时关闭的截止时间。 复制告警规则:单击告警规则所在行后的按钮,复制告警规则。 删除告警规则:单击告警规则所在行后的按钮,单击“确定”删除该规则。 勾选多个告警规则后,支持对多个告警进行批量操作:开启、关闭、临时关闭、取消临时关闭、告警恢复开启、告警恢复关闭、删除、导出。
  • 概述 AOM提供告警规则设置功能。通过告警规则可对服务设置事件条件,对资源的指标设置阈值条件,或对资源的日志设置搜索分析、关键词统计以及SQL查询等条件。当服务的资源数据满足事件条件时产生事件类告警。当资源的指标数据满足阈值条件时产生阈值告警,当没有指标数据上报时产生数据不足事件。当资源的日志数据满足设置的告警条件,产生日志告警。 告警规则分为指标告警规则、事件告警规则、日志告警规则三种。通常情况下,通过指标和日志告警规则,实时监控环境中主机、组件等资源使用情况。当资源使用告警过多,告警通知过于频繁时,通过事件告警规则,简化告警通知,快速识别服务的某一类资源使用问题并及时解决。 系统支持创建的告警规则总计不能超过3000条。如果系统中的告警规则数量已达到上限,请删除不需要的告警规则后重新创建。 父主题: 告警规则
  • 配置事件类告警策略 用户可以针对业务中的各类重要事件或对云资源的操作事件设置事件告警,在发生异常时及时通知您采取措施。事件类告警策略包括事件名称、触发时间周期、触发类型、触发次数和告警频率五个必要组成部分。您可以根据以下指引配置事件类告警策略。 基本概念 参数 参数说明 取值样例 事件名称 各服务监控事件的名称。 开机失败 触发时间周期 触发时间周期的含义是当该事件在5分钟内被累计触发时,向您发送告警信息。 触发时间周期可选择在5分钟内、在20分钟内、在1小时内、在4小时内、在24小时内。 说明: 当触发类型为累计触发时,该参数可选。 在5分钟内 触发类型 触发类型分为触发和累计触发。系统默认为触发。 触发表示当事件发生时,立即发送告警信息。 累计触发表示当事件在触发时间周期内累计触发预设的次数后,才能发生告警信息。 累计触发 触发次数 事件发生在触发时间周期内累计触发的次数。 说明: 当触发类型为累计触发时,该参数可选。 2 告警频率 当告警产生时,告警以特定的频率重复通知。 告警频率可设置以下几种方式: 只告警一次、每5分钟告警一次、每10分钟告警一次、每15分钟告警一次、每30分钟告警一次、每1小时告警一次、每3小时告警一次、每6小时告警一次、每12小时告警一次、每1天告警一次。 说明: 当触发类型为累计触发时,该参数可选。 每5分钟告警一次 配置事件类告警策略示例 例如,事件名称为开机失败 、触发时间周期为在5分钟内,触发类型为累计触发 、触发次数为2、告警频率为每5分钟告警一次。 表示:在5分钟内,某台云服务器开始失败事件累计触发2次则每5分钟触发告警一次。 图2 事件类告警策略
  • 响应示例 状态码: 200 请求响应成功。 { "keywords_alarm_rule_id" : "" } 状态码: 400 BadRequest 非法请求 建议根据error_msg直接修改该请求。 { "error_code" : "LTS.2005", "error_msg" : "Alarm rule params validator error." } 状态码: 500 表明服务端能被请求访问到,但是服务内部出错。 { "error_code" : "LTS.2001", "error_msg" : "Failed to create alarm rule." }
  • 响应参数 状态码: 200 表8 响应Body参数 参数 参数类型 描述 keywords_alarm_rule_id String 告警规则id 最小长度:36 最大长度:36 状态码: 400 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 调用失败响应信息描述。 枚举值: Invalid projectId 状态码: 500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 调用失败响应信息描述。 枚举值: Invalid projectId
  • 响应示例 状态码: 200 请求响应成功。 { "sql_alarm_rules" : [ { "sql_alarm_rule_name" : "string", "is_css_sql" : false, "sql_alarm_rule_id" : "string", "sql_alarm_rule_description" : "string", "sql_requests" : [ { "log_stream_id" : "string", "log_stream_name" : "string", "log_group_id" : "string", "log_group_name" : "string", "sql" : "string", "sql_request_title" : "string", "search_time_range" : 0, "search_time_range_unit" : "minute" } ], "frequency" : { "type" : "CRON", "cron_expr" : "string", "hour_of_day" : 0, "day_of_week" : 0, "fixed_rate" : 0, "fixed_rate_unit" : "minute" }, "condition_expression" : "string", "topics" : [ { "name" : "string", "topic_urn" : "string", "display_name" : "string", "push_policy" : 0 } ], "sql_alarm_level" : "Info", "sql_alarm_send" : true, "domain_id" : "string", "create_time" : 0, "update_time" : 0, "template_name" : "消息模板名称", "status" : "RUNNING", "trigger_condition_count" : "1", "trigger_condition_frequency" : "1", "whether_recovery_policy" : false, "recovery_policy" : "3", "notification_frequency" : 5, "alarm_action_rule_name" : "" } ] } 状态码: 500 表明服务端能被请求访问到,但是服务内部出错。 { "error_code" : "LTS.2008", "error_msg" : "Find Alarm rule failed." }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 sql_alarm_rules Array of SqlAlarmRuleRespList objects SQL告警 表4 SqlAlarmRuleRespList 参数 参数类型 描述 sql_alarm_rule_name String SQL告警名称 最小长度:1 最大长度:64 is_css_sql Boolean 是否管道符sql查询 缺省值:false sql_alarm_rule_id String SQL告警规则id 最小长度:36 最大长度:36 sql_alarm_rule_description String SQL告警信息描述 最小长度:0 最大长度:64 sql_requests Array of SqlRequest objects SQL详细信息 frequency FrequencyRespBody object 告警统计周期 condition_expression String 条件表达式 最小长度:1 最大长度:1024 topics Array of Topics objects 主题信息 sql_alarm_level String 告警级别 枚举值: Info Minor Major Critical sql_alarm_send Boolean 是否发送 domain_id String domainId 最小长度:32 最大长度:32 create_time Long 创建时间(毫秒时间戳) 最小值:13 最大值:13 update_time Long 更新时间(毫秒时间戳) 最小值:13 最大值:13 template_name String 消息模板名称 status String 告警状态 枚举值: RUNNING 启用 STOPPING 停止 trigger_condition_count Integer 触发条件:触发周期;默认为1 trigger_condition_frequency Integer 触发条件:触发周期;默认为1 whether_recovery_policy Boolean 是否打开恢复通知;默认false recovery_policy Integer 恢复策略周期;默认为3 notification_frequency Integer 通知频率,单位(分钟) 枚举值: 0 5 10 15 30 60 180 360 alarm_action_rule_name String 告警行动规则名称 说明: alarm_action_rule_name和notification_save_rule可以选填一个,如果都填,优先选择alarm_action_rule_name 表5 SqlRequest 参数 参数类型 描述 is_time_range_relative Boolean 是时间范围相对 log_stream_id String 日志流id 最小长度:36 最大长度:36 log_stream_name String 日志流名称 最小长度:1 最大长度:64 log_group_id String 日志组id 最小长度:36 最大长度:36 log_group_name String 日志组名称 最小长度:1 最大长度:64 sql String sql语句 最小长度:1 最大长度:1024 sql_request_title String 图表名称 最小长度:1 最大长度:64 search_time_range Integer 查询执行任务时最近数据的时间范围(当search_time_range_unit为minute,则最大值为60;当search_time_range_unit为hour,则最大值为24) 最小值:1 最大值:60 search_time_range_unit String 查询时间单位 枚举值: minute hour 表6 FrequencyRespBody 参数 参数类型 描述 type String 时间类型。 枚举值: CRON HOURLY DAILY WEEKLY FIXED_RATE cron_expr String 当字段type为"CRON"时取该字段。 最小长度:1 最大长度:1024 hour_of_day Integer 当字段type为"DAILY"或者"WEEKLY"时取该字段。 day_of_week Integer 当字段type为"WEEKLY"时取该字段(周日~周六)。 fixed_rate Integer 当字段type为"FIXED_RATE"时取该字段(当fixed_rate_unit单位为minute,最大值60;当fixed_rate_unit单位为hour,最大值24)。 fixed_rate_unit String 时间单位枚举值: 枚举值: minute hour 表7 Topics 参数 参数类型 描述 name String 主题名称。 最小长度:1 最大长度:1024 topic_urn String Topic的唯一的资源标识。 最小长度:1 最大长度:1024 display_name String Topic的显示名,推送邮件消息时,作为邮件发件人显示。 最小长度:1 最大长度:1024 push_policy Integer 消息推送的策略。 最小值:1 最大值:1024 状态码: 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 调用失败响应信息描述。 枚举值: Invalid projectId