-
请求示例 创建名称为rg_test,且资源分组添加资源方式为TAG的资源分组。 {
"group_name" : "rg_test",
"enterprise_project_id" : "0",
"type" : "TAG",
"tags" : [ {
"key" : "key1",
"value" : "value1"
} ],
"association_ep_ids" : [ "d61d4705-5658-42f5-8e0c-70eb34d17b02" ]
}
-
响应参数 状态码:200 表14 响应Body参数 参数 参数类型 描述 group_id String 资源分组ID,以rg开头,后跟22位由字母或数字组成的字符串 状态码:400 表15 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 error_msg String 请求异常信息 request_id String 请求ID 状态码:401 表16 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 error_msg String 请求异常信息 request_id String 请求ID 状态码:403 表17 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 error_msg String 请求异常信息 request_id String 请求ID 状态码:500 表18 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 error_msg String 请求异常信息 request_id String 请求ID
-
请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 租户Token 表3 请求Body参数 参数 是否必选 参数类型 描述 group_name 是 String 资源分组的名称,只能为字母、数字、汉字、-、_,最大长度为128 正则匹配:^([\u4E00-\u9FFF]|[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)$ type 否 String 资源分组添加资源方式,取值只能为EPS(同步企业项目),TAG(标签动态匹配),NAME(实例名称),不传为手动添加 正则匹配:^(EPS|TAG|Manual|COMB|NAME)$ tags 否 Array of ResourceGroupTagRelation objects 标签动态匹配时的关联标签,type为TAG时必传 association_ep_ids 否 Array of strings 该资源分组内包含的资源来源的企业项目ID,type为EPS时必传 providers 否 String 云服务名称,格式为"dcs,ecs",支持的云服务providers请参考https://support.huaweicloud.com/api-rms/rms_06_0100.html enterprise_project_id_and_tags 否 Array of EnterpriseProjectIdAndTags objects 匹配企业项目或匹配标签参数 resources 否 Array of Resource objects 手动创建时的资源详情 product_resources 否 Array of ProductResource objects 手动创建,选择资源层级为云产品时的资源详情 instances 否 Array of Instance objects 实例名称匹配参数 product_names 否 String 创建资源层级为云产品时的云产品的取值,一般由"服务命名空间,服务首层维度名称"组成,如"SYS.E
CS ,instance_id"。多个云产品则用“;”隔开,如"SERVICE.BMS,instance_id;SYS.ECS,instance_id"。 resource_level 否 String 资源层级,资源生效范围。选择云产品,则云产品及其子层级均可进入该资源分组,选择子维度,则只生效具体的子维度 product 云产品 dimension 子维度 枚举值: product dimension comb_relation 否 CombRelation object 组合匹配参数 表4 ResourceGroupTagRelation 参数 是否必选 参数类型 描述 key 是 String TMS标签键规范。 operator 否 String tag操作符,含义是标签key与value的关系。 include表示包含 prefix表示前缀 suffix表示后缀 notInclude表示不包含 equal表示相等 当operator为equal,value为空字符串时表示为全部 all表示全部 枚举值: include prefix suffix notInclude equal all value 否 String TMS标签值规范。 表5 EnterpriseProjectIdAndTags 参数 是否必选 参数类型 描述 enterprise_project_id 否 String 企业项目ID 正则匹配:^([a-z]|[A-Z]|[0-9]|_|-)+$ tag 否 ResourceGroupTagRelation object 标签的匹配规则 表6 Resource 参数 是否必选 参数类型 描述 namespace 是 String 查询服务的命名空间,各服务命名空间请参考“服务命名空间” dimensions 是 Array of ResourceDimension objects 资源的维度信息 表7 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}$ 表8 ProductResource 参数 是否必选 参数类型 描述 product_name 是 String 资源所属的云产品,一般由"服务命名空间,服务首层维度名称"组成,如"SYS.ECS,instance_id" 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 产品实例详情 表9 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 资源名称 表10 Instance 参数 是否必选 参数类型 描述 product_name 是 String 云产品名称 logical_operator 是 String 逻辑运算符 ALL 所有条件匹配成功 ANY 任意条件匹配成功 枚举值: ALL ANY instance_names 是 Array of ResourceName objects 资源名称匹配参数数组 表11 ResourceName 参数 是否必选 参数类型 描述 resource_name 否 String 资源名称条件值 operator 是 String 实例操作符,含义是真实资源的名称与资源名称条件值的运算关系。 include表示包含 prefix表示前缀 suffix表示后缀 notInclude表示不包含 equal表示相等 all表示全部 枚举值: include prefix suffix notInclude equal all resource_name_is_ignore_case 否 Boolean 资源名称忽略大小写 表12 CombRelation 参数 是否必选 参数类型 描述 logical_operator 是 String 逻辑运算符 ALL 所有条件匹配成功 ANY 任意条件匹配成功 枚举值: ALL ANY conditions 是 Array of Condition objects 组合匹配资源分组的匹配条件 表13 Condition 参数 是否必选 参数类型 描述 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)$ instance_name 否 ResourceName object 资源名称 tag 否 ResourceGroupTagRelation object 标签的匹配规则
-
响应示例 状态码:200 查询成功 {
"dimensions" : [ {
"name" : "disk",
"value" : "2e84018fc8b4484b94e89aae212fe615",
"origin_value" : "vda"
}, {
"name" : "disk",
"value" : "6a1b2de69eeb9a037ea23de6b529394d",
"origin_value" : "vdc"
} ],
"count" : 10
}
-
响应参数 状态码:200 表4 响应Body参数 参数 参数类型 描述 dimensions Array of AgentDimension objects 维度信息 count Integer 维度信息总数 取值范围: 0-2147483647 表5 AgentDimension 参数 参数类型 描述 name String 维度名称,枚举类型,类型有: mount_point:挂载点, disk:磁盘, proc:进程, gpu:显卡, raid: RAID控制器 枚举值: mount_point disk proc gpu raid value String 维度值,32位字符串,如:2e84018fc8b4484b94e89aae212fe615 origin_value String 实际维度信息,字符串,如:vda。 状态码:400 表6 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 error_msg String 请求异常信息 request_id String 请求ID 状态码:404 表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
-
URI GET /v2/{project_id}/instances/{instance_id}/agent-dimensions 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户ID 正则匹配:^[a-zA-Z0-9-]{1,64}$ instance_id 是 String 资源ID,如:4270ff17-aba3-4138-89fa-820594c39755。 表2 Query参数 参数 是否必选 参数类型 描述 dim_name 是 String 维度名称,枚举类型,类型有: mount_point:挂载点, disk:磁盘, proc:进程, gpu:显卡, raid: RAID控制器, 枚举值: mount_point disk proc gpu raid dim_value 否 String 维度值,32位字符串,如:2e84018fc8b4484b94e89aae212fe615。 offset 否 Integer 分页偏移量 取值范围: 0-2147483647 默认取值: 0 正则匹配:^(0|[1-9][0-9]*)$ limit 否 Integer 分页大小 取值范围: 1-1000 默认取值: 1000 正则匹配:^([1-9]|[1-9][0-9]|[1-9][0-9][0-9]|1000)$
-
响应示例 状态码:200 OK {
"resource_groups" : [ {
"group_name" : "group1",
"create_time" : "2006-01-02T15:04:05.000Z",
"group_id" : "rg0123456789xxxx",
"enterprise_project_id" : "0",
"type" : "Manual"
}, {
"group_name" : "band",
"type" : "EPS",
"create_time" : "2006-01-02T15:04:05.000Z",
"group_id" : "rg0123456789xxxx",
"enterprise_project_id" : "d61d4705-5658-42f5-8e0c-70eb34d17b02"
}, {
"group_name" : "group2",
"type" : "TAG",
"create_time" : "2006-01-02T15:04:05.000Z",
"group_id" : "rg0123456789xxxx",
"enterprise_project_id" : "0"
} ],
"count" : 3
}
-
响应参数 状态码:200 表4 响应Body参数 参数 参数类型 描述 count Integer 资源分组总数 取值范围: 0-1000 resource_groups Array of OneResourceGroupResp objects 资源分组列表 表5 OneResourceGroupResp 参数 参数类型 描述 group_name String 资源分组的名称 正则匹配:^((([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)$ group_id String 资源分组ID,以rg开头,后跟22位由字母或数字组成的字符串 create_time DateTime 资源分组的创建时间 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)$ type String 资源添加/匹配方式,取值只能为EPS(匹配企业项目),TAG(匹配标签),NAME(匹配实例名称), COMB(组合匹配),Manual(手动添加) 枚举值: EPS TAG NAME COMB Manual status String 指标告警状态,取值为health(告警中)、unhealthy(已触发)、no_alarm_rule(未设置告警规则) 枚举值: health unhealthy no_alarm_rule event_status String 事件告警状态,取值为health(告警中)、unhealthy(已触发)、no_alarm_rule(未设置告警规则) 枚举值: health unhealthy no_alarm_rule resource_statistics resource_statistics object 资源数(告警中/已触发/资源总数) related_ep_ids Array of strings 当资源匹配规则为匹配企业项目时,指定的企业项目列表 association_alarm_templates Array of AssociationAlarmTemplate objects 关联的告警模板列表 表6 resource_statistics 参数 参数类型 描述 unhealthy Integer 告警中的资源数 取值范围: 0-9999999 total Integer 资源总数 取值范围: 0-9999999 event_unhealthy Integer 已触发的资源数 取值范围: 0-9999999 namespaces Integer 资源类型数 取值范围: 0-9999999 表7 AssociationAlarmTemplate 参数 参数类型 描述 template_id String 告警模板ID template_name String 告警模板名称 状态码:400 表8 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 error_msg String 请求异常信息 request_id String 请求ID 状态码:401 表9 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 error_msg String 请求异常信息 request_id String 请求ID 状态码:403 表10 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 error_msg String 请求异常信息 request_id String 请求ID 状态码:500 表11 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 error_msg String 请求异常信息 request_id String 请求ID
-
URI GET /v2/{project_id}/resource-groups 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户ID 表2 Query参数 参数 是否必选 参数类型 描述 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)$ group_name 否 String 资源分组名称,支持模糊查询 group_id 否 String 资源分组ID,以rg开头,后跟22位由字母或数字组成的字符串 offset 否 Integer 分页查询时查询的起始位置,表示从第几条数据开始,默认为0 取值范围: 0-10000 limit 否 Integer 分页查询时每页的条目数,取值[1,100],默认值为100 取值范围: 1-100 type 否 String 资源分组添加资源方式,取值只能为EPS(同步企业项目),TAG(标签动态匹配),Manual(手动添加),不传代表查询所有资源分组类型,COMB(智能添加-组合匹配),NAME(资源名称模糊匹配) 枚举值: EPS TAG Manual COMB NAME
-
响应示例 状态码: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",
"description" : "简单的示例",
"last_week_compare_enable" : false,
"yesterday_compare_enable" : false,
"legend_location" : "right",
"legend_values" : [ "max", "min" ],
"thresholds" : [ {
"threshold" : 90,
"threshold_color" : "#F23030"
} ]
},
"location" : {
"left" : 0,
"top" : 0,
"width" : 4,
"height" : 3
},
"unit" : "%",
"create_time" : 1111111111111
}
-
响应参数 状态码:200 表3 响应Body参数 参数 参数类型 描述 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 指标列表 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 单位 create_time Long 监控看板创建时间 取值范围: 1111111111111-9999999999999 表4 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执行频率;各服务的指标名称可查看:“服务指标名称”。 表5 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 维度值列表 表6 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 自定义进程名称 表7 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:不生效 表8 ThresholdInfo 参数 参数类型 描述 threshold Number 监控视图辅助线的阈值 取值范围: 0-2147483647 threshold_color String 监控视图辅助线的颜色,"#B50E65"紫色,"#F23030"红色,"#FF8800"橙色,"#F2E70C"黄色 枚举值: #B50E65 #F23030 #FF8800 #F2E70C 表9 location 参数 参数类型 描述 top Integer 监控视图的上坐标 取值范围: 0-2147483647 left Integer 监控视图的左坐标 取值范围: 0-9 width Integer 监控视图图表宽度 取值范围: 3-12 height Integer 监控视图图表高度 取值范围: 3-2147483647 状态码:400 表10 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 error_msg String 请求异常信息 request_id String 请求ID 状态码:401 表11 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 error_msg String 请求异常信息 request_id String 请求ID 状态码:500 表12 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 error_msg String 请求异常信息 request_id String 请求ID
-
响应参数 状态码:200 表8 响应Body参数 参数 参数类型 描述 succeed_count Integer 成功删除的资源数目 取值范围: 0-1000 状态码:400 表9 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 error_msg String 请求异常信息 request_id String 请求ID 状态码:404 表10 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 error_msg String 请求异常信息 request_id String 请求ID 状态码:500 表11 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 error_msg String 请求异常信息 request_id String 请求ID
-
请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token 表3 请求Body参数 参数 是否必选 参数类型 描述 resources 否 Array of Resource objects 当资源添加方式为手动创建、资源层级为子维度时,删除资源分组中的资源只需传递删除的资源信息 product_resources 否 Array of ProductResource objects 当资源添加方式为手动创建、资源层级为云产品时,删除资源分组中的资源只需传递删除的资源信息 表4 Resource 参数 是否必选 参数类型 描述 namespace 是 String 查询服务的命名空间,各服务命名空间请参考“服务命名空间” dimensions 是 Array of ResourceDimension objects 资源的维度信息 表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.ECS,instance_id" 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 产品实例详情 表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 资源名称
-
返回值 正常 200 异常 返回值 说明 400 Bad Request 请求错误。 401 Unauthorized 未提供认证信息,或认证信息错误。 403 Forbidden 请求页面被禁止访问。 408 Request Timeout 请求超出了服务器的等待时间。 429 Too Many Requests 当前请求过多。 500 Internal Server Error 请求未完成,服务异常。 503 Service Unavailable 系统暂时不可用,请求受限。
-
响应消息 响应参数 表2 响应参数 名称 参数类型 是否必选 说明 resource_groups Array of objects 否 一个或者多个资源分组信息。 详细参数说明请参见表3。 meta_data MetaData object 否 查询结果元数据统计个数。 详细参数说明请参见表5。 表3 resource_groups字段数据结构说明 名称 参数类型 是否必选 说明 group_name String 否 资源分组的名称,如:ResourceGroup-Test01。 group_id String 否 资源分组的ID,如:rg1603786526428bWbVmk4rP。 create_time Long 否 资源分组的创建时间,UNIX时间戳,单位毫秒。如:1603819753000。 relation_ids Array of Strings 否 企业项目ID列表。 type String 否 资源分组添加或匹配资源的方式。 枚举值: EPS:匹配企业项目。 TAG:匹配标签。 NAME:匹配实例名称。 COMB:组合匹配。 Manual:手动添加。 空值:手动添加。 最小长度:0 最大长度:32 resources Arrays of Resource objects 否 一组或者多个资源信息,默认为空。 数组长度:0 - 20 instance_statistics InstanceStatistics object 否 资源分组中的资源信息统计。 详细参数说明请参见表4。 status String 否 资源分组的当前状态。值可为health、unhealth、no_alarm_rule。health表示健康,unhealth表示不健康,no_alarm_rule表示未设置告警规则。 enterprise_project_id String 否 创建资源分组时关联的企业项目。默认值为0,表示企业项目为default。 表4 instance_statistics字段数据结构说明 名称 参数类型 是否必选 说明 unhealth Integer 否 该资源分组中当前处在告警状态的资源个数。 total Integer 否 该资源分组中资源的总个数。 type_statistics Integer 否 该资源分组中选择的资源类型个数。如资源分组添加了弹性云服务、弹性公网IP和带宽则值为2。 表5 meta_data字段数据结构说明 名称 参数类型 是否必选 说明 total Integer 否 结果总条数。 返回样例 {
"resource_groups": [
{
"group_name": "ResourceGroup-Test01",
"create_time": 1606374365000,
"group_id": "rg16063743652226ew93e64p",
"relation_ids": ["0"],
"instance_statistics": {
"unhealth": 2,
"total": 10,
"type_statistics": 1
},
"status": "unhealth",
"enterprise_project_id": "0",
"type": "TAG",
"resources": []
},
{
"group_name": "RS",
"create_time": 1606327955000,
"group_id": "rg1606327955657LRj1lrE4y",
"relation_ids": ["0"],
"instance_statistics": {
"unhealth": 0,
"total": 2,
"type_statistics": 1
},
"status": "no_alarm_rule",
"enterprise_project_id": "0",
"type": "TAG",
"resources": []
},
{
"group_name": "RS",
"create_time": 1606327947000,
"group_id": "rg1606327947514v9OWqAD3N",
"relation_ids": ["0"],
"instance_statistics": {
"unhealth": 0,
"total": 2,
"type_statistics": 1
},
"status": "no_alarm_rule",
"enterprise_project_id": "0",
"type": "TAG",
"resources": []
},
{
"group_name": "RS",
"create_time": 1606327946000,
"group_id": "rg1606327946625PYogr059N",
"relation_ids": ["0"],
"instance_statistics": {
"unhealth": 0,
"total": 2,
"type_statistics": 1
},
"status": "no_alarm_rule",
"enterprise_project_id": "0",
"type": "TAG",
"resources": []
},
{
"group_name": "ResourceGroupCorrect_2",
"create_time": 1606325669000,
"group_id": "rg1606325669900Rk4eKkLMZ",
"relation_ids": ["0"],
"instance_statistics": {
"unhealth": 0,
"total": 1,
"type_statistics": 1
},
"status": "no_alarm_rule",
"enterprise_project_id": "0",
"type": "TAG",
"resources": []
}
],
"meta_data": {
"total": 5
}
}