华为云用户手册

  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token 最小长度:1 最大长度:16384 表3 请求Body参数 参数 是否必选 参数类型 描述 resources 否 Array of Resource objects 资源信息 数组长度:1 - 1000 product_resources 否 Array of ProductResource objects 手动创建,选择资源层级为云产品时的资源详情 数组长度:1 - 50 表4 Resource 参数 是否必选 参数类型 描述 namespace 是 String 查询服务的命名空间,各服务命名空间请参考“服务命名空间” dimensions 是 Array of ResourceDimension objects 资源的维度信息 数组长度:1 - 4 表5 ResourceDimension 参数 是否必选 参数类型 描述 name 是 String 资源维度,如:弹性云服务器,则维度为instance_id;目前最大支持4个维度,各服务资源的指标维度名称可查看:“服务指标维度”。 正则匹配:^([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_|-){1,32}$ value 是 String 资源维度值,为资源的实例ID,如:4270ff17-aba3-4138-89fa-820594c39755。 正则匹配:^((([a-z]|[A-Z]|[0-9]){1}([a-z]|[A-Z]|[0-9]|_|-|\.)*)|\*){1,256}$ 表6 ProductResource 参数 是否必选 参数类型 描述 product_name 是 String 资源所属的云产品,一般由"服务命名空间,服务首层维度名称"组成,如"SYS.E CS ,instance_id" 最小长度:1 最大长度:128 namespace 是 String 查询服务的命名空间,各服务命名空间请参考“服务命名空间” 正则匹配:^([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_)*\.([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_)*$ product_instances 是 Array of ProductInstance objects 产品实例详情 数组长度:1 - 1000 表7 ProductInstance 参数 是否必选 参数类型 描述 first_dimension_name 是 String 资源首层维度,如:弹性云服务器,则维度为instance_id;”。 正则匹配:^([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_|-){1,32}$ first_dimension_value 是 String 资源首层维度值,为资源的实例ID,如:4270ff17-aba3-4138-89fa-820594c39755。 正则匹配:^((([a-z]|[A-Z]|[0-9]){1}([a-z]|[A-Z]|[0-9]|_|-|\.)*)|\*){1,256}$ resource_name 是 String 资源名称 最小长度:1 最大长度:128
  • URI POST /v2/{project_id}/resource-groups/{group_id}/resources/batch-create 表1 路径参数 参数 是否必选 参数类型 描述 group_id 是 String 资源分组ID,以rg开头,后跟22位由字母或数字组成的字符串 最小长度:2 最大长度:24 project_id 是 String 租户ID 最小长度:1 最大长度:64
  • AK/SK认证 AK/SK签名认证方式仅支持消息体大小在12MB以内,12MB以上的请求请使用Token认证。 AK/SK认证就是使用AK/SK对请求进行签名,在请求时将签名信息添加到消息头,从而通过身份认证。 AK(Access Key ID):访问密钥ID。与私有访问密钥关联的唯一标识符;访问密钥ID和私有访问密钥一起使用,对请求进行加密签名。 SK(Secret Access Key):私有访问密钥。与访问密钥ID结合使用,对请求进行加密签名,可标识发送方,并防止请求被修改。 使用AK/SK认证时,您可以基于签名算法使用AK/SK对请求进行签名,也可以使用专门的签名SDK对请求进行签名。详细的签名方法和SDK使用方法请参见API签名指南。 签名SDK只提供签名功能,与服务提供的SDK不同,使用时请注意。
  • Token认证 Token的有效期为24小时,需要使用一个Token鉴权时,可以先缓存起来,避免频繁调用。 Token在计算机系统中代表令牌(临时)的意思,拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头中,从而通过身份认证,获得操作API的权限。Token可通过调用获取用户Token接口获取。 调用本服务API需要项目级别的Token,即调用获取用户Token接口时,请求body中auth.scope的取值需要选择project,如下所示。 { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", // IAM 用户名 "password": "********", //IAM用户密码 "domain": { "name": "domainname" //IAM用户所属账号名 } } } }, "scope": { "project": { "name": "xxxxxxxx" //项目名称 } } } } 获取Token 后,再调用其他接口时,您需要在请求消息头中添加“X-Auth-Token”,其值即为Token。例如Token值为“ABCDEFG....”,则调用接口时将“X-Auth-Token: ABCDEFG....”加到请求消息头即可,如下所示。 1 2 3 GET https://iam.cn-north-1.myhuaweicloud.com/v3/auth/projects Content-Type: application/json X-Auth-Token: ABCDEFG.... 您还可以通过这个视频教程了解如何使用Token认证:https://bbs.huaweicloud.com/videos/101333。
  • 响应参数 状态码:200 表5 响应Body参数 参数 参数类型 描述 notification_enabled Boolean 是否开启告警通知 alarm_notifications Array of Notification objects 告警触发的动作 ok_notifications Array of Notification objects 告警恢复触发的动作 notification_begin_time String 告警通知开启时间 notification_end_time String 告警通知关闭时间 表6 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值保持一致。 数组长度:0 - 20 状态码:400 表7 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度:0 最大长度:256 error_msg String 请求异常信息 最小长度:0 最大长度:256 request_id String 请求ID 最小长度:0 最大长度:256 状态码:500 表8 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度:0 最大长度:256 error_msg String 请求异常信息 最小长度:0 最大长度:256 request_id String 请求ID 最小长度:0 最大长度:256
  • 请求示例 修改告警规则告警通知信息 { "notification_enabled" : true, "alarm_notifications" : [ { "type" : "", "notification_list" : [ ] } ], "ok_notifications" : [ { "type" : "", "notification_list" : [ ] } ], "notification_begin_time" : "00:00", "notification_end_time" : "23:59" }
  • 响应示例 状态码:200 修改告警规则告警通知信息成功 { "notification_enabled" : true, "alarm_notifications" : [ { "type" : "", "notification_list" : [ ] } ], "ok_notifications" : [ { "type" : "", "notification_list" : [ ] } ], "notification_begin_time" : "00:00", "notification_end_time" : "23:59" }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 发送的实体的MIME类型。默认使用application/json; charset=UTF-8。 缺省值:application/json; charset=UTF-8 最小长度:1 最大长度:64 X-Auth-Token 是 String 用户Token 最小长度:1 最大长度:16384 表3 请求Body参数 参数 是否必选 参数类型 描述 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 告警通知关闭时间 表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值保持一致。 数组长度:0 - 20
  • 响应示例 状态码:200 OK [ { "widget_id" : "wg1234567890123456789012", "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" : "%", "create_time" : 1111111111111 } ]
  • 响应参数 状态码:200 表4 响应Body参数 参数 参数类型 描述 widgets Array of WidgetInfoWithId objects 监控视图列表 数组长度:0 - 50 表5 WidgetInfoWithId 参数 参数类型 描述 widget_id String 视图id 正则匹配:^wg([a-z]|[A-Z]|[0-9]){22}$ group_id String 视图分区id 正则匹配:^dg([a-z]|[A-Z]|[0-9]){22}|default$ metrics Array of WidgetMetric objects 指标列表 数组长度:1 - 200 title String 监控视图标题 最小长度:1 最大长度:128 正则匹配:^([\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 单位 create_time Long 监控看板创建时间 最小值:1111111111111 最大值:9999999999999 表6 WidgetMetric 参数 参数类型 描述 namespace String 服务维度 最小长度:3 最大长度:32 正则匹配:^([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 监控视图的指标别名列表 最小长度:1 最大长度:128 数组长度:0 - 200 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 维度名称,多维度用逗号分隔,各服务支持的维度可参考:“服务维度名称” 最小长度:1 最大长度:131 正则匹配:^([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执行频率;各服务的指标名称可查看:“服务指标名称”。 表7 DimensionInfo 参数 参数类型 描述 name String 维度名称,多维度用逗号分隔,各服务支持的维度可参考:“服务维度名称” 最小长度:1 最大长度:131 正则匹配:^([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 维度值列表 最小长度:1 最大长度:1024 数组长度:0 - 200 表8 ExtraInfo 参数 参数类型 描述 origin_metric_name String 指标名称 最小长度:1 最大长度:4096 正则匹配:^([a-z]|[A-Z]|[0-9]|_|-|~|\.|/|:)*$ metric_prefix String 指标名称前缀 最小长度:1 最大长度:4096 正则匹配:^([a-z]|[A-Z]|[0-9]|_|-|~|\.|/|:)*$ metric_type String 指标类型 最小长度:1 最大长度:32 正则匹配:^([a-z]|[A-Z]|[0-9]|_|-|~|\.|/|:)*$ custom_proc_name String 自定义进程名称 最小长度:1 最大长度:250 表9 properties 参数 参数类型 描述 filter String 聚合类型,目前只有TopN这一种类型,折线图不支持该参数 枚举值: topN topN Integer Top前N个;折线图时为随机展示的时序数据条数 最小值:1 最大值:2147483647 缺省值:100 order String 排序字段,asc正序,desc倒序,折线图不支持该参数 枚举值: asc desc description String 监控视图的描述信息 最小长度:0 最大长度:200 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 当前时序数据需要在图例中展示的统计值名称列表,表格不支持该参数;条形图和柱状图仅支持配置当前值 数组长度:0 - 6 枚举值: last max min avg sum thresholds Array of ThresholdInfo objects 监控视图的阈值辅助线配置 数组长度:0 - 5 is_all_compare_enable Boolean 同比环比总开关是否生效;true:生效;false:不生效 表10 ThresholdInfo 参数 参数类型 描述 threshold Number 监控视图辅助线的阈值 最小值:0 最大值:2147483647 threshold_color String 监控视图辅助线的颜色,"#B50E65"紫色,"#F23030"红色,"#FF8800"橙色,"#F2E70C"黄色 枚举值: #B50E65 #F23030 #FF8800 #F2E70C 表11 location 参数 参数类型 描述 top Integer 监控视图的上坐标 最小值:0 最大值:2147483647 left Integer 监控视图的左坐标 最小值:0 最大值:9 width Integer 监控视图图表宽度 最小值:3 最大值:12 height Integer 监控视图图表高度 最小值:3 最大值:2147483647 状态码:400 表12 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度:0 最大长度:256 error_msg String 请求异常信息 最小长度:0 最大长度:256 request_id String 请求ID 最小长度:0 最大长度:256 状态码:401 表13 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度:0 最大长度:256 error_msg String 请求异常信息 最小长度:0 最大长度:256 request_id String 请求ID 最小长度:0 最大长度:256 状态码:500 表14 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度:0 最大长度:256 error_msg String 请求异常信息 最小长度:0 最大长度:256 request_id String 请求ID 最小长度:0 最大长度:256
  • 请求参数 表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
  • URI GET /v2/{project_id}/dashboards/{dashboard_id}/widgets 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户ID 最小长度:1 最大长度:64 正则匹配:^[a-zA-Z0-9-]{1,64}$ dashboard_id 是 String 监控看板id,以db开头,包含22个字母和数字例:db16564943172807wjOmoLyn' 数组长度:24 - 24 正则匹配:^db([a-z]|[A-Z]|[0-9]){22}$ 表2 Query参数 参数 是否必选 参数类型 描述 group_id 否 String 视图所在的分组id 正则匹配:^dg([a-z]|[A-Z]|[0-9]){22}|default$
  • 响应参数 状态码:200 表4 响应Body参数 参数 参数类型 描述 dashboards Array of DashBoardInfo objects 监控看板列表 数组长度:0 - 10 表5 DashBoardInfo 参数 参数类型 描述 dashboard_id String 监控看板id 正则匹配:^db([a-z]|[A-Z]|[0-9]){22} dashboard_name String 自定义监控看板名称 最小长度:1 最大长度:128 正则匹配:^([\u4E00-\u9FFF]|[a-z]|[A-Z]|[0-9]|_|-)+$ enterprise_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)$ creator_name String 监控看板的创建用户名 最小长度:1 最大长度:128 正则匹配:^([\u4E00-\u9FFF]|[a-z]|[A-Z]|[0-9]|_|-)+$ create_time Long 监控看板创建时间 最小值:1111111111111 最大值:9999999999999 widgets_num Integer 看板下的视图总数 最小值:0 最大值:50 namespace String 命名空间 最小长度:3 最大长度:32 正则匹配:^([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_)*\.([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_)*$ sub_product String 子产品标识 最小长度:1 最大长度:128 dashboard_template_id String 监控大盘模板id 正则匹配:^mb([a-z]|[A-Z]|[0-9]){22} row_widget_num Integer 监控视图展示模式,0表示自定义坐标,1代表每行一个 最小值:0 最大值:3 缺省值:3 is_favorite Boolean 监控看板是否标记收藏, true: 收藏, false: 未收藏 状态码: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 状态码:500 表8 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度:0 最大长度:256 error_msg String 请求异常信息 最小长度:0 最大长度:256 request_id String 请求ID 最小长度:0 最大长度:256
  • 响应示例 状态码:200 OK { "dashboards" : [ { "dashboard_id" : "dbxxxxxxxxxxxxxxxxxxxxxx", "dashboard_name" : "dashboard_name", "enterprise_id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "creator_name" : "creator_name", "create_time" : 1111111111111, "row_widget_num" : 3, "is_favorite" : false } ] }
  • URI GET /v2/{project_id}/dashboards 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户ID 最小长度:1 最大长度:64 正则匹配:^[a-zA-Z0-9-]{1,64}$ 表2 Query参数 参数 是否必选 参数类型 描述 enterprise_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|all_granted_eps)$ is_favorite 否 Boolean 指定企业项目下监控看板是否收藏,true:收藏,false:未收藏,填此参数时,enterprise_id必填 dashboard_name 否 String 监控看板名称 最小长度:1 最大长度:128 正则匹配:^([\u4E00-\u9FFF]|[a-z]|[A-Z]|[0-9]|_|-)+$ dashboard_id 否 String 监控看板id 正则匹配:^db([a-z]|[A-Z]|[0-9]){22} dashboard_type 否 String 监控看板类型, monitor_dashboard表示监控大盘,other表示自定义看板 枚举值: monitor_dashboard other
  • 响应参数 状态码:200 表3 响应Body参数 参数 参数类型 描述 one_click_alarms Array of one_click_alarms objects 一键告警列表 数组长度:1 - 1000 表4 one_click_alarms 参数 参数类型 描述 one_click_alarm_id String 一键告警ID namespace String 查询服务的命名空间,各服务命名空间请参考“服务命名空间” description String 一键告警描述,长度范围[0,256],该字段默认值为空字符串 enabled Boolean 开关 状态码:400 表5 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度:0 最大长度:256 error_msg String 请求异常信息 最小长度:0 最大长度:256 request_id String 请求ID 最小长度:0 最大长度:256 状态码:401 表6 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度:0 最大长度:256 error_msg String 请求异常信息 最小长度:0 最大长度:256 request_id String 请求ID 最小长度:0 最大长度:256 状态码:403 表7 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度:0 最大长度:256 error_msg String 请求异常信息 最小长度:0 最大长度:256 request_id String 请求ID 最小长度:0 最大长度:256 状态码:500 表8 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度:0 最大长度:256 error_msg String 请求异常信息 最小长度:0 最大长度:256 request_id String 请求ID 最小长度:0 最大长度:256
  • 请求参数 表2 请求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 表3 响应Body参数 参数 参数类型 描述 tags Array of Tag objects 租户标签列表 数组长度:0 - 20 表4 Tag 参数 参数类型 描述 key String 键;最大长度128个unicode字符。key不能为空。 最小长度:0 最大长度:128 values Array of strings 值列表;每个值最大长度255个unicode字符。如果values为空列表,则表示查询任意value 最小长度:0 最大长度:255 数组长度:0 - 20 状态码:404 表5 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度:0 最大长度:256 error_msg String 请求异常信息 最小长度:0 最大长度:256 request_id String 请求ID 最小长度:0 最大长度:256
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 发送的实体的MIME类型。默认使用application/json; charset=UTF-8。 缺省值:application/json; charset=UTF-8 最小长度:1 最大长度:64 X-Auth-Token 是 String 用户Token 最小长度:1 最大长度:16384
  • URI GET /v2/{project_id}/{resource_type}/tags 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户ID 最小长度:1 最大长度:64 正则匹配:^[a-zA-Z0-9-]{1,64}$ resource_type 是 String 资源类型。 CES -alarm:告警规则 最小长度:1 最大长度:32 枚举值: CES-alarm
  • 响应示例 状态码:200 OK { "dashboards" : [ { "dashboard_id" : "dbxxxxxxxxxxxxxxxxxxxxxx", "ret_status" : "successful" }, { "dashboard_id" : "dbXXXXXXXXXXXXXXXXXXXXXX", "ret_status" : "error", "error_msg" : "record not found" } ] }
  • 响应参数 状态码:200 表4 响应Body参数 参数 参数类型 描述 dashboards Array of BatchDeleteDashboardRespInfo objects 批量删除监控看板返回结果 数组长度:1 - 100 表5 BatchDeleteDashboardRespInfo 参数 参数类型 描述 dashboard_id String 监控看板id 正则匹配:^db([a-z]|[A-Z]|[0-9]){22} ret_status String 处理结果, successful: 成功, error: 失败 枚举值: successful error error_msg String 错误信息 最小长度:0 最大长度:128 状态码: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 状态码:500 表8 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度:0 最大长度:256 error_msg String 请求异常信息 最小长度:0 最大长度:256 request_id String 请求ID 最小长度:0 最大长度:256
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 发送的实体的MIME类型。默认使用application/json; charset=UTF-8。 缺省值:application/json; charset=UTF-8 最小长度:1 最大长度:64 X-Auth-Token 是 String 用户Token 最小长度:1 最大长度:16384 表3 请求Body参数 参数 是否必选 参数类型 描述 dashboard_ids 否 Array of strings 监控看板id列表 数组长度:1 - 30
  • 请求参数 表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
  • URI GET /v2/{project_id}/alarms/{alarm_id}/resources 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户ID 最小长度:1 最大长度:64 正则匹配:^[a-zA-Z0-9-]{1,64}$ alarm_id 是 String Alarm实例ID 正则匹配:al([a-z]|[A-Z]|[0-9]){22}$ 表2 Query参数 参数 是否必选 参数类型 描述 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 OK { "alarm_templates" : [ { "template_id" : "at1628592157541dB1klWgY6", "template_name" : "my_template", "template_type" : "custom", "create_time" : "2006-01-02T15:04:05.000Z", "template_description" : "hello world" } ], "count" : 100 }
  • URI GET /v2/{project_id}/alarm-templates 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户ID 最小长度:1 最大长度:64 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 分页查询时查询的起始位置,表示从第几条数据开始,默认为0 最小值:0 最大值:10000 limit 否 Integer 查询结果条数的限制值,取值范围为[1,100],默认值为100 最小值:1 最大值:100 namespace 否 String 查询服务的命名空间,各服务命名空间请参考“服务命名空间” 最小长度:3 最大长度:32 正则匹配:^([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_)*\.([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_)*$ dim_name 否 String 资源维度,必须以字母开头,多维度用","分割,只能包含0-9/a-z/A-Z/_/-,每个维度的最大长度为32 最小长度:1 最大长度:131 正则匹配:^([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}$ template_type 否 String 模板类型(system代表默认指标模板,custom代表自定义指标模板,system_event代表默认事件模板,custom_event代表自定义事件模板,system_custom_event代表全部事件模板),不传返回全部指标模板 枚举值: system custom system_event custom_event system_custom_event template_name 否 String 告警模板的名称,以字母或汉字开头,可包含字母、数字、汉字、_、-,长度范围[1,128],支持模糊匹配 最小长度:1 最大长度:128 正则匹配:^([\u4E00-\u9FFF]|[a-z]|[A-Z]|[0-9]|_|-|\(|\)|\.|\s)+$ product_name 否 String 支持按照产品名称粒度进行查询告警模板,产品名称一般由"服务命名空间,服务首层维度名称"组成,如"SYS.ECS,instance_id" 最小长度:0 最大长度:128
  • 响应参数 状态码:200 表4 响应Body参数 参数 参数类型 描述 alarm_templates Array of AlarmTemplates objects 告警模板列表 数组长度:0 - 100 count Integer 告警模板记录总数 最小值:0 最大值:9999999 表5 AlarmTemplates 参数 参数类型 描述 template_id String 告警模板的ID,以at开头,后跟字母、数字,长度最长为64 template_name String 告警模板的名称,以字母或汉字开头,可包含字母、数字、汉字、_、-,长度范围[1,128] template_type String 模板类型(custom代表默认自定义模板,system代表系统模板) 枚举值: system custom create_time String 告警模板的创建时间 template_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
  • 响应示例 状态码:200 OK { "count" : 1000, "resources" : [ { "status" : "health", "dimensions" : [ { "name" : "instance_id", "value" : "4270ff17-aba3-4138-89fa-820594c39755" } ] } ] }
  • 响应参数 状态码:200 表4 响应Body参数 参数 参数类型 描述 count Integer 资源总数 最小值:0 最大值:10000 resources Array of GetResourceGroupResources objects 资源分组资源列表 数组长度:0 - 100 表5 GetResourceGroupResources 参数 参数类型 描述 status String 资源健康状态,取值为health(已设置告警规则且无告警触发的资源)、unhealthy(已设置告警规则且有告警触发的资源)、no_alarm_rule(未关联告警规则) 枚举值: health unhealthy no_alarm_rule dimensions Array of ResourceDimension objects 资源的维度信息 数组长度:1 - 4 tags String 资源的tag信息,格式为key/value的json字符串,样例为"{"sss":"aaa"}" 最小长度:0 最大长度:10240 enterprise_project_id String 企业项目ID 最小长度:0 最大长度:128 表6 ResourceDimension 参数 参数类型 描述 name String 资源维度,如:弹性云服务器,则维度为instance_id;目前最大支持4个维度,各服务资源的指标维度名称可查看:“服务指标维度”。 正则匹配:^([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_|-){1,32}$ value String 资源维度值,为资源的实例ID,如:4270ff17-aba3-4138-89fa-820594c39755。 正则匹配:^((([a-z]|[A-Z]|[0-9]){1}([a-z]|[A-Z]|[0-9]|_|-|\.)*)|\*){1,256}$ 状态码:400 表7 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度:0 最大长度:256 error_msg String 请求异常信息 最小长度:0 最大长度:256 request_id String 请求ID 最小长度:0 最大长度:256 状态码:401 表8 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度:0 最大长度:256 error_msg String 请求异常信息 最小长度:0 最大长度:256 request_id String 请求ID 最小长度:0 最大长度:256 状态码:403 表9 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度:0 最大长度:256 error_msg String 请求异常信息 最小长度:0 最大长度:256 request_id String 请求ID 最小长度:0 最大长度:256 状态码:404 表10 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度:0 最大长度:256 error_msg String 请求异常信息 最小长度:0 最大长度:256 request_id String 请求ID 最小长度:0 最大长度:256 状态码:500 表11 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度:0 最大长度:256 error_msg String 请求异常信息 最小长度:0 最大长度:256 request_id String 请求ID 最小长度:0 最大长度:256
共100000条
提示

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