华为云用户手册

  • 响应参数 状态码:200 表11 响应Body参数 参数 参数类型 描述 widgets Array of BatchUpdateWidgetInfo objects 更新结果列表 表12 BatchUpdateWidgetInfo 参数 参数类型 描述 widget_id String 视图id 正则匹配:^wg([a-z]|[A-Z]|[0-9]){22}$ ret_status String 修改结果;成功: successful, 失败: error 枚举值: successful error error_msg String 如果失败则返回失败信息 状态码:400 表13 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 error_msg String 请求异常信息 request_id String 请求ID 状态码:401 表14 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 error_msg String 请求异常信息 request_id String 请求ID 状态码:500 表15 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 error_msg String 请求异常信息 request_id String 请求ID
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 发送的实体的MIME类型。默认使用application/json; charset=UTF-8。 默认取值: application/json; charset=UTF-8 X-Auth-Token 是 String 用户Token 表3 请求Body参数 参数 是否必选 参数类型 描述 [数组元素] 是 Array of UpdateWidgetInfo objects 待修改的监控视图列表 表4 UpdateWidgetInfo 参数 是否必选 参数类型 描述 group_id 否 String 视图分区id 正则匹配:^dg([a-z]|[A-Z]|[0-9]){22}|default$ widget_id 是 String 视图id 正则匹配:^wg([a-z]|[A-Z]|[0-9]){22}$ metrics 否 Array of WidgetMetric objects 指标列表 title 否 String 监控视图标题 正则匹配:^([\u4E00-\u9FFF]|[a-z]|[A-Z]|[0-9]|_|-|:|;|\(|\)|\.|~|(|))+$ threshold 否 Double 监控视图指标的阈值 取值范围: 0-1.7976931348623157E308 threshold_enabled 否 Boolean 阈值是否展示,true:展示,false:不展示 view 否 String 监控视图图表类型, bar条形图,line折线图,bar_chart柱状图,table表格,circular_bar环形柱状图,area_chart面积图 枚举值: bar line bar_chart table circular_bar area_chart metric_display_mode 否 String 指标展示类型,single 单指标展示,multiple 多指标展示 枚举值: single multiple properties 否 properties object 视图展示配置 location 否 location object 监控视图图表坐标 unit 否 String 单位 表5 WidgetMetric 参数 是否必选 参数类型 描述 namespace 是 String 服务维度 正则匹配:^([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_)*\.([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_)*$ dimensions 是 DimensionInfo object 维度信息列表 metric_name 是 String 多个指标名称,用逗号隔开 alias 否 Array of strings 监控视图的指标别名列表 extra_info 否 ExtraInfo object 指标信息 rollup_enable 否 Boolean 是否开启聚合 rollup_filter 否 String 聚合规则,last:最新值,max:最大值,min:最小值,average:平均值,sum:求和值 枚举值: last max min average sum rollup_dimension 否 String 聚合维度 last_week_compare_enable 否 Boolean 是否展示同比(上周同一时间)数据,true:展示,false:不展示 yesterday_compare_enable 否 Boolean 是否展示环比(昨天同一时间)数据,true:展示,false:不展示 metric_dimension 否 String 维度名称,多维度用逗号分隔,各服务支持的维度可参考:“服务维度名称” 正则匹配:^([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_|-){0,31}(,([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_|-){0,31}){0,3}$ top_num 否 Integer 展示数据数量 取值范围: 1-200 unit 否 String 单位 order 否 String 排序字段,asc正序,desc倒序 枚举值: asc desc topn_metric_name 否 String 资源的监控指标名称,必须以字母开头,只能包含0-9/a-z/A-Z/_,字符长度最短为1,最大为64;如:弹性云服务器中的监控指标cpu_util,表示弹性服务器的CPU使用率;文档数据库中的指标mongo001_command_ps,表示command执行频率;各服务的指标名称可查看:“服务指标名称”。 表6 DimensionInfo 参数 是否必选 参数类型 描述 name 是 String 维度名称,多维度用逗号分隔,各服务支持的维度可参考:“服务维度名称” 正则匹配:^([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_|-){0,31}(,([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_|-){0,31}){0,3}$ filter_type 是 String 资源类型, all_instances: 全部资源, specific_instances: 指定资源 枚举值: all_instances specific_instances values 否 Array of strings 维度值列表 表7 ExtraInfo 参数 是否必选 参数类型 描述 origin_metric_name 是 String 指标名称 正则匹配:^([a-z]|[A-Z]|[0-9]|_|-|~|\.|/|:)*$ metric_prefix 否 String 指标名称前缀 正则匹配:^([a-z]|[A-Z]|[0-9]|_|-|~|\.|/|:)*$ metric_type 否 String 指标类型 正则匹配:^([a-z]|[A-Z]|[0-9]|_|-|~|\.|/|:)*$ custom_proc_name 否 String 自定义进程名称 表8 properties 参数 是否必选 参数类型 描述 filter 否 String 聚合类型,目前只有TopN这一种类型,折线图不支持该参数 枚举值: topN topN 否 Integer Top值前N个;折线图时表示随机展示的时序数据条数 取值范围: 1-2147483647 默认取值: 100 order 否 String 排序字段,asc正序,desc倒序,折线图不支持该参数 枚举值: asc desc description 否 String 监控视图的描述信息 last_week_compare_enable 否 Boolean 是否展示同比(上周同一时间)数据,true:展示,false:不展示 yesterday_compare_enable 否 Boolean 是否展示环比(昨天同一时间)数据,true:展示,false:不展示 legend_location 否 String 图例位置标记,hide表示隐藏图例,right表示图例放在监控视图右侧,bottom表示图例放在监控视图底部,表格不支持该参数 枚举值: hide right bottom legend_values 否 Array of strings 当前时序数据需要在图例中展示的统计值名称列表,表格不支持该参数,条形图和柱状图仅支持选择当前值 枚举值: last max min avg sum thresholds 否 Array of ThresholdInfo objects 监控视图的阈值辅助线配置 is_all_compare_enable 否 Boolean 同比环比总开关是否生效;true:生效;false:不生效 表9 ThresholdInfo 参数 是否必选 参数类型 描述 threshold 是 Number 监控视图辅助线的阈值 取值范围: 0-2147483647 threshold_color 是 String 监控视图辅助线的颜色,"#B50E65"紫色,"#F23030"红色,"#FF8800"橙色,"#F2E70C"黄色 枚举值: #B50E65 #F23030 #FF8800 #F2E70C 表10 location 参数 是否必选 参数类型 描述 top 是 Integer 监控视图的上坐标 取值范围: 0-2147483647 left 是 Integer 监控视图的左坐标 取值范围: 0-9 width 是 Integer 监控视图图表宽度 取值范围: 3-12 height 是 Integer 监控视图图表高度 取值范围: 3-2147483647
  • 响应参数 状态码:204 No Content 状态码:400 表3 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 error_msg String 请求异常信息 request_id String 请求ID 状态码:401 表4 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 error_msg String 请求异常信息 request_id String 请求ID 状态码:500 表5 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 error_msg String 请求异常信息 request_id String 请求ID
  • 响应参数 状态码:201 表6 响应Body参数 参数 参数类型 描述 template_id String 告警模板的ID,以at开头,后跟字母、数字,长度最长为64 状态码:400 表7 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 error_msg String 请求异常信息 request_id String 请求ID 状态码:401 表8 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 error_msg String 请求异常信息 request_id String 请求ID 状态码:403 表9 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 error_msg String 请求异常信息 request_id String 请求ID 状态码:500 表10 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 error_msg String 请求异常信息 request_id String 请求ID
  • URI GET /v2/{project_id}/alarms 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户ID 正则匹配:^[a-zA-Z0-9-]{1,64}$ 表2 Query参数 参数 是否必选 参数类型 描述 alarm_id 否 String 告警规则ID 正则匹配:^al([0-9A-Za-z]){22}$ name 否 String 告警名称, 只能包含0-9/a-z/A-Z/_/-或汉字,长度1-128 正则匹配:^([\u4E00-\u9FFF]|[a-z]|[A-Z]|[0-9]|_|-)+$ namespace 否 String 查询服务的命名空间,各服务命名空间请参考“服务命名空间” 正则匹配:^((([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,多维度情况按字母升序排列并使用逗号分隔 正则匹配:^([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)$ product_name 否 String 产品层级跨纬规则查询时支持产品名称查询,一般由"服务命名空间,服务首层维度名称"组成,如"SYS.E CS ,instance_id" resource_level 否 String 产品层级跨纬规则查询时支持规则所属类型查询,resource_level取值为product即为产品层级跨纬规则,不填或者取值为dimension则为旧的规则类型 枚举值: product dimension 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)$
  • 响应参数 状态码:200 表4 响应Body参数 参数 参数类型 描述 one_click_alarm_ids Array of strings 成功删除的一键告警ID列表 状态码:400 表5 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 error_msg String 请求异常信息 request_id String 请求ID 状态码:401 表6 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 error_msg String 请求异常信息 request_id String 请求ID 状态码:403 表7 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 error_msg String 请求异常信息 request_id String 请求ID 状态码:500 表8 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 error_msg String 请求异常信息 request_id String 请求ID
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 发送的实体的MIME类型。默认使用application/json; charset=UTF-8。 默认取值: application/json; charset=UTF-8 X-Auth-Token 是 String 用户Token 表3 请求Body参数 参数 是否必选 参数类型 描述 one_click_alarm_ids 是 Array of strings 需要批量删除的一键告警ID列表
  • URI GET /v2/{project_id}/alarm-templates/{template_id}/association-alarms 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户ID template_id 是 String 告警模板的ID,以at开头,后跟字母、数字,长度最长为64 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 分页查询时查询的起始位置,表示从第几条数据开始,默认为0 取值范围: 0-10000 limit 否 Integer 查询结果条数的限制值,取值范围为[1,100],默认值为100 取值范围: 1-100
  • 响应参数 状态码:200 表4 响应Body参数 参数 参数类型 描述 alarms Array of alarms objects 告警规则列表 count Integer 告警规则列表总数 取值范围: 0-1000 表5 alarms 参数 参数类型 描述 alarm_id String 告警规则ID 正则匹配:^al([0-9A-Za-z]){22}$ name String 告警规则名称 正则匹配:^([\u4E00-\u9FFF]|[a-z]|[A-Z]|[0-9]|_|-)+$ description String 告警规则描述 状态码:400 表6 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 error_msg String 请求异常信息 request_id String 请求ID 状态码:401 表7 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 error_msg String 请求异常信息 request_id String 请求ID 状态码:403 表8 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 error_msg String 请求异常信息 request_id String 请求ID 状态码:500 表9 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 error_msg String 请求异常信息 request_id String 请求ID
  • 响应参数 状态码:200 表11 响应Body参数 参数 参数类型 描述 widget_ids Array of strings 批量创建监控视图返回结果 状态码:400 表12 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 error_msg String 请求异常信息 request_id String 请求ID 状态码:401 表13 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 error_msg String 请求异常信息 request_id String 请求ID 状态码:500 表14 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 error_msg String 请求异常信息 request_id String 请求ID
  • 请求示例 [ { "metrics" : [ { "namespace" : "SYS.ECS", "dimensions" : { "name" : "instance_id", "filter_type" : "specific_instances", "values" : [ "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" ] }, "metric_name" : "cpu_util", "alias" : [ "cpuutilalias" ], "extra_info" : { "origin_metric_name" : "cpu_util", "metric_prefix" : "cpu", "metric_type" : "type", "custom_proc_name" : "app.sh" } } ], "view" : "view", "metric_display_mode" : "single", "threshold" : 0.7, "threshold_enabled" : true, "title" : "widget_title", "properties" : { "filter" : "topN", "topN" : 100, "order" : "desc" }, "location" : { "left" : 0, "top" : 0, "width" : 4, "height" : 3 }, "unit" : "%" } ]
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 发送的实体的MIME类型。默认使用application/json; charset=UTF-8。 默认取值: application/json; charset=UTF-8 X-Auth-Token 是 String 用户Token 表3 请求Body参数 参数 是否必选 参数类型 描述 [数组元素] 否 Array of BaseWidgetInfo objects 监控视图信息 表4 BaseWidgetInfo 参数 是否必选 参数类型 描述 group_id 否 String 视图分区id 正则匹配:^dg([a-z]|[A-Z]|[0-9]){22}|default$ metrics 是 Array of WidgetMetric objects 指标列表 title 是 String 监控视图标题 正则匹配:^([\u4E00-\u9FFF]|[a-z]|[A-Z]|[0-9]|_|-|:|;|\(|\)|\.|~|(|))+$ threshold 否 Double 监控视图指标的阈值 取值范围: 0-1.7976931348623157E308 threshold_enabled 是 Boolean 阈值是否展示,true:展示,false:不展示 view 是 String 监控视图图表类型, bar条形图,line折线图,bar_chart柱状图,table表格,circular_bar环形柱状图,area_chart面积图 枚举值: bar line bar_chart table circular_bar area_chart metric_display_mode 是 String 指标展示类型,single 单指标展示,multiple 多指标展示 枚举值: single multiple properties 否 properties object 额外信息 location 是 location object 监控视图图表坐标 unit 否 String 单位 表5 WidgetMetric 参数 是否必选 参数类型 描述 namespace 是 String 服务维度 正则匹配:^([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_)*\.([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_)*$ dimensions 是 DimensionInfo object 维度信息列表 metric_name 是 String 多个指标名称,用逗号隔开 alias 否 Array of strings 监控视图的指标别名列表 extra_info 否 ExtraInfo object 指标信息 rollup_enable 否 Boolean 是否开启聚合 rollup_filter 否 String 聚合规则,last:最新值,max:最大值,min:最小值,average:平均值,sum:求和值 枚举值: last max min average sum rollup_dimension 否 String 聚合维度 last_week_compare_enable 否 Boolean 是否展示同比(上周同一时间)数据,true:展示,false:不展示 yesterday_compare_enable 否 Boolean 是否展示环比(昨天同一时间)数据,true:展示,false:不展示 metric_dimension 否 String 维度名称,多维度用逗号分隔,各服务支持的维度可参考:“服务维度名称” 正则匹配:^([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_|-){0,31}(,([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_|-){0,31}){0,3}$ top_num 否 Integer 展示数据数量 取值范围: 1-200 unit 否 String 单位 order 否 String 排序字段,asc正序,desc倒序 枚举值: asc desc topn_metric_name 否 String 资源的监控指标名称,必须以字母开头,只能包含0-9/a-z/A-Z/_,字符长度最短为1,最大为64;如:弹性云服务器中的监控指标cpu_util,表示弹性服务器的CPU使用率;文档数据库中的指标mongo001_command_ps,表示command执行频率;各服务的指标名称可查看:“服务指标名称”。 表6 DimensionInfo 参数 是否必选 参数类型 描述 name 是 String 维度名称,多维度用逗号分隔,各服务支持的维度可参考:“服务维度名称” 正则匹配:^([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_|-){0,31}(,([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_|-){0,31}){0,3}$ filter_type 是 String 资源类型, all_instances: 全部资源, specific_instances: 指定资源 枚举值: all_instances specific_instances values 否 Array of strings 维度值列表 表7 ExtraInfo 参数 是否必选 参数类型 描述 origin_metric_name 是 String 指标名称 正则匹配:^([a-z]|[A-Z]|[0-9]|_|-|~|\.|/|:)*$ metric_prefix 否 String 指标名称前缀 正则匹配:^([a-z]|[A-Z]|[0-9]|_|-|~|\.|/|:)*$ metric_type 否 String 指标类型 正则匹配:^([a-z]|[A-Z]|[0-9]|_|-|~|\.|/|:)*$ custom_proc_name 否 String 自定义进程名称 表8 properties 参数 是否必选 参数类型 描述 filter 否 String 聚合类型,目前只有TopN这一种类型,折线图不支持该参数 枚举值: topN topN 否 Integer Top前N个;折线图时为随机展示的时序数据条数 取值范围: 1-2147483647 默认取值: 100 order 否 String 排序字段,asc正序,desc倒序,折线图不支持该参数 枚举值: asc desc description 否 String 监控视图的描述信息 last_week_compare_enable 否 Boolean 是否展示同比(上周同一时间)数据,true:展示,false:不展示 yesterday_compare_enable 否 Boolean 是否展示环比(昨天同一时间)数据,true:展示,false:不展示 legend_location 否 String 图例位置标记,hide表示隐藏图例,right表示图例放在监控视图右侧,bottom表示图例放在监控视图底部,表格不支持该参数 枚举值: hide right bottom legend_values 否 Array of strings 当前时序数据需要在图例中展示的统计值名称列表,表格不支持该参数;条形图和柱状图仅支持配置当前值 枚举值: last max min avg sum thresholds 否 Array of ThresholdInfo objects 监控视图的阈值辅助线配置 is_all_compare_enable 否 Boolean 同比环比总开关是否生效;true:生效;false:不生效 表9 ThresholdInfo 参数 是否必选 参数类型 描述 threshold 是 Number 监控视图辅助线的阈值 取值范围: 0-2147483647 threshold_color 是 String 监控视图辅助线的颜色,"#B50E65"紫色,"#F23030"红色,"#FF8800"橙色,"#F2E70C"黄色 枚举值: #B50E65 #F23030 #FF8800 #F2E70C 表10 location 参数 是否必选 参数类型 描述 top 是 Integer 监控视图的上坐标 取值范围: 0-2147483647 left 是 Integer 监控视图的左坐标 取值范围: 0-9 width 是 Integer 监控视图图表宽度 取值范围: 3-12 height 是 Integer 监控视图图表高度 取值范围: 3-2147483647
  • URI POST /v2/{project_id}/dashboards/{dashboard_id}/widgets 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户ID 正则匹配:^[a-zA-Z0-9-]{1,64}$ dashboard_id 是 String 监控看板id,以db开头,包含22个字母和数字例:db16564943172807wjOmoLyn' 正则匹配:^db([a-z]|[A-Z]|[0-9]){22}$
  • 响应参数 状态码:204 No Content 状态码:400 表4 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 error_msg String 请求异常信息 request_id String 请求ID 状态码:401 表5 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 error_msg String 请求异常信息 request_id String 请求ID 状态码:500 表6 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 error_msg String 请求异常信息 request_id String 请求ID
  • URI PUT /v2/{project_id}/dashboards/{dashboard_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户ID 正则匹配:^[a-zA-Z0-9-]{1,64}$ dashboard_id 是 String 监控看板id,以db开头,包含22个字母和数字例:db16564943172807wjOmoLyn' 正则匹配:^db([a-z]|[A-Z]|[0-9]){22}$
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 发送的实体的MIME类型。默认使用application/json; charset=UTF-8。 默认取值: application/json; charset=UTF-8 X-Auth-Token 是 String 用户Token 表3 请求Body参数 参数 是否必选 参数类型 描述 dashboard_name 否 String 自定义监控看板名称 正则匹配:^([\u4E00-\u9FFF]|[a-z]|[A-Z]|[0-9]|_|-)+$ is_favorite 否 Boolean 监控看板是否标记收藏, true: 收藏, false: 未收藏 row_widget_num 是 Integer 监控视图展示模式,0表示自定义坐标,1代表每行一个 取值范围: 0-3 默认取值: 3 filter 否 String 表示指标聚合方式,average表示平均值,min表示最小值,max表示最大值,sum表示求合 枚举值: average min max sum period 否 Integer 表示指标聚合周期,1表示原始值,60表示一分钟,300表示5分钟,1200表示20分钟,3600表示1小时,14400表示4小时,86400表示1天 枚举值: 1 60 300 1200 3600 14400 86400 display_time 否 Integer 展示时间,0表示使用自定义时间展示, 5分钟,15分钟,30分钟,1小时,2小时,3小时,12小时,24小时,7天,30天 枚举值: 0 5 15 30 60 120 180 720 1440 10080 43200 refresh_time 否 Integer 刷新时间 0秒表示不刷新,10秒,1分钟,5分钟,20分钟 枚举值: 0 10 60 300 1200 from 否 Integer 开始时间 取值范围: 0-9999999999999 to 否 Integer 结束时间 取值范围: 0-9999999999999 screen_color 否 String 监控大屏背景颜色 enable_screen_auto_play 否 Boolean 监控大屏是否自动切换 time_interval 否 Integer 监控大屏自动切换时间间隔,10000代表10s,30000代表30s,60000代表1min 枚举值: 10000 30000 60000 enable_legend 否 Boolean 是否开启图例 full_screen_widget_num 否 Integer 大屏展示视图数量, 可以取得值必须与console页面可选值保持一致 取值范围: 0-65535
  • 响应参数 状态码:200 表5 响应Body参数 参数 参数类型 描述 group_id String 资源分组ID,以rg开头,后跟22位由字母或数字组成的字符串 template_ids Array of strings 关联的告警模板的ID列表 状态码:400 表6 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 error_msg String 请求异常信息 request_id String 请求ID 状态码:401 表7 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 error_msg String 请求异常信息 request_id String 请求ID 状态码:403 表8 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 error_msg String 请求异常信息 request_id String 请求ID 状态码:404 表9 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 error_msg String 请求异常信息 request_id String 请求ID 状态码:500 表10 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 error_msg String 请求异常信息 request_id String 请求ID
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 发送的实体的MIME类型。默认使用application/json; charset=UTF-8。 默认取值: application/json; charset=UTF-8 X-Auth-Token 是 String 用户Token 表3 请求Body参数 参数 是否必选 参数类型 描述 template_ids 是 Array of strings 告警模板编号列表,当ID列表为空时,将删除该资源分组已关联的告警模板所创建的告警规则 notification_enabled 是 Boolean 是否开启告警通知。true:开启,false:关闭。 alarm_notifications 否 Array of Notification objects 告警触发通知列表 ok_notifications 否 Array of Notification objects 告警恢复通知列表 notification_begin_time 否 String 告警通知开启时间 notification_end_time 否 String 告警通知关闭时间 effective_timezone 否 String 时区,形如:"GMT-08:00"、"GMT+08:00"、"GMT+0:00" enterprise_project_id 否 String 企业项目ID notification_manner 否 String NOTIFICATION_GROUP(通知组)/TOPIC_SUBSCRIPTION(主题订阅)/NOTIFICATION_POLICY(通知策略) 枚举值: NOTIFICATION_GROUP TOPIC_SUBSCRIPTION NOTIFICATION_POLICY notification_policy_ids 否 Array of strings 关联的通知策略ID列表 表4 Notification 参数 是否必选 参数类型 描述 type 是 String 通知类型。notification为 SMN 通知,contact为云账号联系人,contactGroup为通知组,autoscaling为AS通知。 枚举值: notification autoscaling groupwatch ecsRecovery contact contactGroup iecAction notification_list 是 Array of strings 告警状态发生变化时,被通知对象的列表。topicUrn可从SMN获取,具体操作请参考查询Topic列表。当type为notification时,notification_list列表不能为空;当type为autoscaling时,列表必须为[]。 说明:若alarm_action_enabled为true,对应的alarm_actions、ok_actions至少有一个不能为空。若alarm_actions、ok_actions同时存在时,notification_list值保持一致。
  • URI PUT /v2/{project_id}/resource-groups/{group_id}/alarm-templates/async-association 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户ID 正则匹配:^[a-zA-Z0-9-]{1,64}$ group_id 是 String 资源分组ID,以rg开头,后跟22位由字母或数字组成的字符串 正则匹配:^rg([a-z]|[A-Z]|[0-9]){22}$
  • 告警通知 当告警触发后,我们需要定义通知的渠道和对象,快速的将告警信息通过配置的渠道通知到运维人员。 当前 CES 支持以下三种方式来完成通知的配置。 通知策略(推荐):产品最新上线能力,通过通知策略可以完成告警的分级通知、简易排班。 通知组:通过在 云监控服务 上配置的通知群组,可以快速通知到指定运维人员。 主题订阅:通过在 消息通知 服务(SMN)配置的主题,快速将该消息推送至消息主题。 通知配置模块如下图所示。 通知策略模块如下图所示。
  • 背景信息 HTTP Request Header中的Referer字段值代表了当前页面的请求来源,CDN节点可以通过Referer跟踪来源,对来源进行识别和判断。 用户访问加速 域名 网站内容时,访问请求到达CDN节点后,CDN节点会根据配置的Referer黑白名单,对访问者的身份进行识别和过滤,符合规则的可以顺利访问到该内容。如果不符合规则,该访问请求将会被禁止,返回403禁止访问的错误信息。 图1 referer原理图
  • 配置示例 加速域名为www.example.com,该加速域名配置了referer白名单规则:包含空referer,白名单内容为www.test.com,如下图所示。 用户1:请求URL:https://www.example.com/file.html,该请求携带的referer字段值为空,CDN将会正常返回内容。 用户2:请求URL:https://www.example.com/file.html,该请求携带的referer字段值为:www.test.com,CDN将会正常返回内容。 用户3:请求URL:https://www.example.com/file.html,该请求携带的referer字段值为:www.abc.com,CDN节点将会返回403禁止访问的错误信息。 加速域名为www.example01.com,该加速域名配置了referer黑名单规则:包含空referer,黑名单内容为www.test01.com,如下图所示。 用户1:请求URL:https://www.example01.com/file.html,该请求携带的referer字段值为空,CDN节点将会返回403禁止访问的错误信息。 用户2:请求URL:https://www.example01.com/file.html,该请求携带的referer字段值为:www.test01.com,CDN节点将会返回403禁止访问的错误信息。 用户3:请求URL:https://www.example01.com/file.html,该请求携带的referer字段值为:www.bcd.com,CDN将会正常返回内容。
  • 适用场景 当您的业务因为某些地方性法规而无法对当地用户放开访问或者因业务原因不能对某些区域的用户开放时,可以使用区域访问控制来达到目的。CDN通过识别客户端IP来判断用户访问来源,工作原理如下: 您的域名www.example.com业务范围不包含W区域,并且在CDN控制台为W区域配置了黑名单。 CDN收到一个来自W区域的IP请求访问www.example.com,DNS将该请求解析至W区域的某个CDN节点。 节点检测当前IP没有权限下载您域名下的资源。 CDN向该用户返回HTTP 状态代码 403 (Forbidden)。
  • 配置示例 示例1:域名www.example.com配置了如下区域访问控制规则。 配置效果: 由于黑名单优先,所以此配置的结果是黑名单生效。中国大陆用户访问“/test”文件夹下的资源(例:www.example.com/test/abc.jpg)时命中黑名单,返回403状态码。 位于中国香港的用户访问“/test”文件夹下的资源(例:www.example.com/test/abc.jpg)时黑白名单均未命中,此时默认是拒绝访问,返回403状态码。 示例2:域名www.example.com配置了如下区域访问控制规则。 配置效果: 位于中国香港的用户访问“/test”文件夹下的资源(例:www.example.com/test/abc.jpg)时命中黑名单,返回403状态码。 位于中国大陆的用户访问“/test”文件夹下的资源(例:www.example.com/test/abc.jpg)时命中白名单,返回对应的资源给用户。 位于中国澳门的用户访问“/test”文件夹下的资源(例:www.example.com/test/abc.jpg)时黑白名单均未命中,此时默认是拒绝访问,返回403状态码。 示例3:域名www.example.com配置了如下区域访问控制规则。 配置效果: 位于中国香港的用户访问“/test/abc”文件夹下的资源(例:www.example.com/test/abc/1.jpg)时命中黑名单,返回403状态码。 位于中国大陆的用户访问“/test”文件夹下的资源(例:www.example.com/test/cat.jpg)时命中白名单,返回对应的资源给用户。 位于中国香港的用户访问“/test”文件夹下的资源(例:www.example.com/test/cat.jpg)时黑白名单均未命中,此时默认是拒绝访问,返回403状态码。 位于中国澳门的用户访问“/test”文件夹下的资源(例:www.example.com/test/cat.jpg)时黑白名单均未命中,此时默认是拒绝访问,返回403状态码。
  • 支持的区域 表2 支持配置的区域 大区 具体区域 亚洲 中国大陆、中国香港、中国澳门、中国台湾、阿拉伯联合酋长国、阿富汗、亚美尼亚、阿塞拜疆、孟加拉国、巴林、不丹、格鲁吉亚、印度尼西亚、以色列、印度、伊拉克、约旦、日本、吉尔吉斯斯坦、柬埔寨、大韩民国、科威特、哈萨克斯坦、老挝人民民主共和国、黎巴嫩、斯里兰卡、缅甸、蒙古、马尔代夫、马来西亚、尼泊尔、阿曼、菲律宾、巴基斯坦、巴勒斯坦、卡塔尔、沙特阿拉伯、新加坡、泰国、塔吉克斯坦、东帝汶、土库曼斯坦、土耳其、乌兹别克斯坦、越南、也门 欧洲 安道尔、阿尔巴尼亚、奥地利、波斯尼亚和黑塞哥维那、比利时、保加利亚、白俄罗斯、瑞士、塞浦路斯、捷克、丹麦、爱沙尼亚、西班牙、芬兰、法罗群岛、法国、大不列颠及北爱尔兰联合王国、希腊、克罗地亚、匈牙利、爱尔兰、冰岛、意大利、立陶宛、卢森堡、拉脱维亚、摩纳哥、摩尔多瓦共和国、黑山、北马其顿、马耳他、荷兰、挪威、波兰、葡萄牙、罗马尼亚、塞尔维亚、瑞典、斯洛文尼亚、斯洛伐克、圣马力诺 非洲 安哥拉、布基纳法索、布隆迪、贝宁、博茨瓦纳、刚果民主共和国、中非共和国、刚果、科特迪瓦、喀麦隆、吉布提、阿尔及利亚、埃及、厄立特里亚、埃塞俄比亚、加蓬、加纳、冈比亚、几内亚、赤道几内亚、几内亚比绍、肯尼亚、科摩罗、利比里亚、莱索托、利比亚、摩洛哥、马达加斯加、马里、毛里塔尼亚、毛里求斯、马拉维、莫桑比克、纳米比亚、尼日尔、尼日利亚、卢旺达、塞舌尔、塞拉利昂、塞内加尔、索马里、南苏丹、圣多美和普林西比、斯威士兰、乍得、多哥、突尼斯、坦桑尼亚联合共和国、乌干达、南非、赞比亚、津巴布韦 北美洲 安提瓜和巴布达、巴巴多斯、巴哈马、伯利兹、加拿大、哥斯达黎加、多米尼克、多米尼加共和国、格林纳达、洪都拉斯、海地、牙买加、圣基茨和尼维斯、圣卢西亚、墨西哥、尼加拉瓜、巴拿马、萨尔瓦多、特立尼达和多巴哥、美利坚合众国、圣文森特和格林纳丁斯 大洋洲 澳大利亚、库克群岛、斐济、密克罗尼西亚、基里巴斯、马绍尔群岛、瑙鲁、纽埃、新西兰、巴布亚新几内亚、所罗门群岛、托克劳、汤加、图瓦卢、瓦努阿图、萨摩亚 南美洲 阿根廷、玻利维亚、巴西、智利、哥伦比亚、厄瓜多尔、圭亚那、秘鲁、巴拉圭、苏里南、委内瑞拉
  • 背景信息 CDN支持HTTPS安全加速,您可以通过在CDN控制台配置加速域名的HTTPS证书,启用HTTPS加速服务,证书配置成功后,客户端可以使用HTTPS协议请求CDN节点。HTTP和HTTPS协议的区别如下: HTTP:HTTP协议以明文方式发送内容,不提供任何方式的 数据加密 ,如果攻击者截取了Web浏览器和网站服务器之间的传输报文,就可以直接读取其中的信息。 HTTPS:为了数据传输的安全,HTTPS在HTTP的基础上加入了SSL协议,SSL依靠证书来验证服务器的身份,并为浏览器和服务器之间的通信加密。
  • 注意事项 证书和加速域名需要匹配,您需要配置域名或泛域名对应的证书,泛域名证书配置请参见如何配置泛域名证书。 配置项停用后证书配置信息将会被清除,再次开启HTTPS配置需要重新配置证书相关信息。 如果您的证书发生了变更,需及时同步更新CDN控制台HTTPS配置项里面的证书信息。 自有证书请参考更新HTTPS证书完成证书更新。 SCM证书请参考配置HTTPS证书为域名配置最新的证书。 如果您需要实现全链路HTTPS加密,还需要将修改回源协议配置为HTTPS(源站服务器需要支持HTTPS协议)。 关闭HTTPS证书后,客户端HTTPS请求的SSL握手会失败,从而导致所有客户端HTTPS请求失败。
  • 访问控制配置概述 访问控制模块主要实现对访问者身份进行识别和过滤,限制部分用户访问,提高CDN的安全性,配置项包括referer防盗链、IP黑白名单、UA黑白名单、URL鉴权、远程鉴权、IP访问限频。 修改访问控制相关配置需要加速域名处于“已开启”或“配置中”状态,并且未被CDN锁定、禁用。 由于IP归属为运营商且不定期调整,华为云虽会定期更新IP地址库,也可能存在更新滞后的情况。因此可能导致部分访问控制功能偶尔误拦截或放行、客户端请求未调度到最佳节点等情况发生。 功能 说明 防盗链配置 配置referer黑白名单,通过设置的过滤策略,对访问者身份进行识别和过滤,实现限制访问来源的目的。 IP黑白名单配置 配置IP黑白名单,通过设置过滤策略,对用户请求IP地址进行过滤,从而限制访问来源。 配置User-Agent黑白名单 当您的网站需要对用户请求使用的代理过滤,从而限制访问来源时,可以在此项中进行配置。 区域访问控制 如果您因为业务需求,需要限制某些地理位置的用户访问,可以通过区域访问控制功能实现。 URL鉴权 配置URL鉴权功能,通过保护用户站点资源,防止资源被用户恶意下载盗用。 配置远程鉴权 当您想要CDN将用户请求转发到指定的鉴权服务器来完成鉴权,从而防止资源被用户恶意下载盗用时,可以在此项中进行配置。 配置IP访问限频 如果您想要通过限制单IP的单URL每秒访问单个节点的次数,实现CC攻击防御及防恶意盗刷防护,可以通过配置IP访问限频实现。 父主题: 访问控制
  • CDN回源机制 当源站存在多个IP地址时,CDN回源时采用负载均衡机制,详情如下: 一次回源请求最多访问两个高优先级源站IP,如果两个IP均回源失败,切换到低优先级源站IP,最多访问两个低优先级源站IP。一次用户请求CDN会进行四次回源尝试,如果四次均失败,此次用户请求失败。 回源失败:指连接超时、连接失败或者收到源站的5xx错误码。 当您的源站是域名,且解析到多个IP地址时,最多重试2个IP,如果访问两个IP均失败,则切换到下一个源站。
  • Serverless DLI DLI完全兼容Apache Spark、Apache Flink生态和接口,是集实时分析、离线分析、交互式分析为一体的Serverless大数据计算分析服务。线下应用可无缝平滑迁移上云,减少迁移工作量。采用批流融合高扩展性框架,为TB~EB级数据提供了更实时高效的多样性算力,可支撑更丰富的大数据处理需求。产品内核及架构深度优化,综合性能是传统MapReduce模型的百倍以上,SLA保障99.95%可用性。 与传统自建Hadoop集群相比,Serverless架构的DLI还具有以下优势: 表1 Serverless DLI与传统自建Hadoop集群对比的优势 优势 维度 数据湖探索 DLI 自建Hadoop系统 低成本 资金成本 按照实际扫描数据量或者CU时收费,可变成本,成本可节约50%。 长期占用资源,资源浪费严重,成本高。 弹性扩缩容能力 基于容器化Kubernetes,具有极致的弹性伸缩能力。 无。 免运维 运维成本 即开即用,Serverless架构。 需要较强的技术能力进行搭建、配置、运维。 高可用 具有跨AZ容灾能力。 无 高易用 学习成本 学习成本低,包含10年、上千个项目经验固化的调优参数。同时提供可视化智能调优界面。 学习成本高,需要了解上百个调优参数。 支持数据源 云上:OBS、RDS、DWS、 CSS 、MongoDB、Redis。 云下:自建数据库、MongoDB、Redis。 云上:OBS。 云下:HDFS。 生态兼容 DLV 、永洪BI、帆软。 大数据生态工具。 自定义镜像 支持,满足业务多样性。 无。 工作流调度 DataArts Studio -DLF调度。 自建大数据生态的调度工具,如Airflow。 企业级多租户 基于表的权限管理,可以精细化到列权限。 基于文件的权限管理。 高性能 性能 基于软硬件一体化的深度垂直优化。 大数据开源版本性能。
共100000条
提示

您即将访问非华为云网站,请注意账号财产安全