华为云用户手册

资源和成本规划 该解决方案主要部署如下资源，每月花费如下所示，具体请参考华为云官网价格详情，实际收费以账单为准： 表1 资源和成本规划 华为云服务 配置示例 每月花费 函数工作流 FunctionGraph 区域：华北-北京四 产品：函数 请求次数： 0-100万次： 0元/100万次 100万次以上 ： 1.33元/100万次 计量时间： 0-400,000 GB/秒： 0元/GB-秒 400,000 GB/秒以上 ：0.00011108元/GB-秒 0元 消息通知 服务（ SMN ） 中国短信推送 0个数~100个数（含）免费 100个数~100,000个数（含）0.045 元/条 100,000个数~300,000个数（含）0.04 元/条 300,000个数~500,000个数（含）0.039 元/条 500,000个数~1,000,000个数（含）0.038 元/条 1,000,000个数~3,000,000个数（含）0.037 元/条 大于3,000,000个数 0.036 元/条 / 合计 0+ 消息通知服务(SMN短信发送费用

方案架构 该方案基于华为云函数工作流FunctionGraph，来帮用户实现弹性云服务器 E CS （ModelArts Studio）定时批量启停的计划。 图1 方案架构图 该解决方案会部署如下资源： 通过函数工作流 FunctionGraph，创建两个函数，调用弹性云服务器 ECS（ModelArts Studio）的相关接口，实现定时批量启停弹性云服务器 ECS（ModelArts Studio）实例的计划。。 创建定时触发器 TIMER的计划事件功能，指定固定频率定期调用函数工作流代码，实现定时批量启停弹性云服务器 ECS（ModelArts Studio）实例的计划。 通过 统一身份认证 服务 IAM 的委托功能，将帐号Region内弹性云服务器 ECS（ModelArts Studio）的操作权限委托给函数工作流 FunctionGraph。 使用消息通知服务（SMN）为用户发送定时启动或停止ModelArts Studio服务情况的短信消息。

响应参数 状态码：200 表14 响应Body参数 参数 参数类型 描述 group_id String 资源分组ID，以rg开头，后跟22位由字母或数字组成的字符串 状态码：400 表15 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度：0 最大长度：256 error_msg String 请求异常信息 最小长度：0 最大长度：256 request_id String 请求ID 最小长度：0 最大长度：256 状态码：401 表16 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度：0 最大长度：256 error_msg String 请求异常信息 最小长度：0 最大长度：256 request_id String 请求ID 最小长度：0 最大长度：256 状态码：403 表17 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度：0 最大长度：256 error_msg String 请求异常信息 最小长度：0 最大长度：256 request_id String 请求ID 最小长度：0 最大长度：256 状态码：500 表18 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度：0 最大长度：256 error_msg String 请求异常信息 最小长度：0 最大长度：256 request_id String 请求ID 最小长度：0 最大长度：256

请求示例 创建名称为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" ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 租户Token 最小长度：1 最大长度：16384 表3 请求Body参数 参数 是否必选 参数类型 描述 group_name 是 String 资源分组的名称，只能为字母、数字、汉字、-、_，最大长度为128 最小长度：1 最大长度：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时必传 数组长度：1 - 50 association_ep_ids 否 Array of strings 该资源分组内包含的资源来源的企业项目ID，type为EPS时必传 数组长度：1 - 50 providers 否 String 云服务名称,格式为"dcs,ecs",支持的云服务providers请参考https://support.huaweicloud.com/api-rms/rms_06_0100.html 最小长度：0 最大长度：512 enterprise_project_id_and_tags 否 Array of EnterpriseProjectIdAndTags objects 匹配企业项目或匹配标签参数 数组长度：1 - 50 resources 否 Array of Resource objects 手动创建时的资源详情 数组长度：1 - 1000 product_resources 否 Array of ProductResource objects 手动创建，选择资源层级为云产品时的资源详情 数组长度：1 - 50 instances 否 Array of Instance objects 实例名称匹配参数 数组长度：1 - 50 product_names 否 String 创建资源层级为云产品时的云产品的取值，一般由"服务命名空间,服务首层维度名称"组成，如"SYS.ECS,instance_id"。多个云产品则用“;”隔开，如"SERVICE.BMS,instance_id;SYS.ECS,instance_id"。 最小长度：0 最大长度：10240 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 最小长度：1 最大长度：128 正则匹配：^([a-z]|[A-Z]|[0-9]|_|-)+$ tag 否 ResourceGroupTagRelation object 标签的匹配规则 表6 Resource 参数 是否必选 参数类型 描述 namespace 是 String 查询服务的命名空间，各服务命名空间请参考“服务命名空间” dimensions 是 Array of ResourceDimension objects 资源的维度信息 数组长度：1 - 4 表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" 最小长度：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 表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 资源名称 最小长度：1 最大长度：128 表10 Instance 参数 是否必选 参数类型 描述 product_name 是 String 云产品名称 最小长度：1 最大长度：16 logical_operator 是 String 逻辑运算符 ALL 所有条件匹配成功 ANY 任意条件匹配成功 枚举值： ALL ANY instance_names 是 Array of ResourceName objects 资源名称匹配参数数组 数组长度：1 - 10 表11 ResourceName 参数 是否必选 参数类型 描述 resource_name 否 String 资源名称条件值 最小长度：0 最大长度：128 operator 是 String 实例操作符，含义是真实资源的名称与资源名称条件值的运算关系。 include表示包含 prefix表示前缀 suffix表示后缀 notInclude表示不包含 equal表示相等 all表示全部 枚举值： include prefix suffix notInclude equal all 表12 CombRelation 参数 是否必选 参数类型 描述 logical_operator 是 String 逻辑运算符 ALL 所有条件匹配成功 ANY 任意条件匹配成功 枚举值： ALL ANY conditions 是 Array of Condition objects 组合匹配资源分组的匹配条件 数组长度：1 - 50 表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 标签的匹配规则

请求参数 表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 查询成功 { "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 维度信息 数组长度：0 - 2147483647 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 最小长度：32 最大长度：32 origin_value String 实际维度信息，字符串，如：vda。 最小长度：1 最大长度：1024 状态码：400 表6 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度：0 最大长度：256 error_msg String 请求异常信息 最小长度：0 最大长度：256 request_id String 请求ID 最小长度：0 最大长度：256 状态码：404 表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

URI GET /v2/{project_id}/instances/{instance_id}/agent-dimensions 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户ID 最小长度：1 最大长度：64 正则匹配：^[a-zA-Z0-9-]{1,64}$ instance_id 是 String 资源ID，如：4270ff17-aba3-4138-89fa-820594c39755。 最小长度：36 最大长度：36 表2 Query参数 参数 是否必选 参数类型 描述 dim_name 是 String 维度名称，枚举类型，类型有： mount_point：挂载点, disk：磁盘, proc：进程, gpu：显卡, raid: RAID控制器, 枚举值： mount_point disk proc gpu raid dim_value 否 String 维度值，32位字符串，如：2e84018fc8b4484b94e89aae212fe615。 最小长度：32 最大长度：32 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 资源分组列表 数组长度：0 - 100 表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位由字母或数字组成的字符串 最小长度：2 最大长度：24 create_time String 资源分组的创建时间 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（标签动态匹配）,Manual（手动添加） 枚举值： EPS TAG Manual 状态码：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}/resource-groups 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户ID 最小长度：1 最大长度：64 表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 资源分组名称，支持模糊查询 最小长度：1 最大长度：128 group_id 否 String 资源分组ID，以rg开头，后跟22位由字母或数字组成的字符串 最小长度：2 最大长度：24 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 指标列表 数组长度：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 表4 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执行频率；各服务的指标名称可查看：“服务指标名称”。 表5 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 表6 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 表7 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:不生效 表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 请求异常内部业务状态码 最小长度：0 最大长度：256 error_msg String 请求异常信息 最小长度：0 最大长度：256 request_id String 请求ID 最小长度：0 最大长度：256 状态码：401 表11 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度：0 最大长度：256 error_msg String 请求异常信息 最小长度：0 最大长度：256 request_id String 请求ID 最小长度：0 最大长度：256 状态码：500 表12 响应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

请求参数 表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.ECS,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

响应参数 状态码：200 表8 响应Body参数 参数 参数类型 描述 succeed_count Integer 成功删除的资源数目 最小值：0 最大值：1000 状态码：400 表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

URI POST /v2/{project_id}/resource-groups/{group_id}/resources/batch-delete 表1 路径参数 参数 是否必选 参数类型 描述 group_id 是 String 资源分组ID，以rg开头，后跟22位由字母或数字组成的字符串 最小长度：2 最大长度：24 project_id 是 String 租户ID 最小长度：1 最大长度：64

响应示例 状态码：200 批量查询通知屏蔽规则资源列表成功 { "resources" : [ { "namespace" : "SYS.ECS", "dimensions" : [ { "name" : "instance_id", "value" : "4270ff17-aba3-4138-89fa-820594c39755" } ] } ], "count" : 100 }

URI GET /v2/{project_id}/notification-masks/{notification_mask_id}/resources 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户ID 最小长度：1 最大长度：64 正则匹配：^[a-zA-Z0-9-]{1,64}$ notification_mask_id 是 String 屏蔽规则ID 最小长度：1 最大长度：64 正则匹配：^([a-z]|[A-Z]|[0-9]){1,64}$ 表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 缺省值：100 正则匹配：^([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参数 参数 参数类型 描述 resources Array of Resource objects 通知屏蔽资源列表 数组长度：1 - 100 count Integer 资源总数 最小值：0 最大值：100 表5 Resource 参数 参数类型 描述 namespace String 查询服务的命名空间，各服务命名空间请参考“服务命名空间” dimensions Array of ResourceDimension objects 资源的维度信息 数组长度：1 - 4 表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 状态码：500 表8 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度：0 最大长度：256 error_msg String 请求异常信息 最小长度：0 最大长度：256 request_id String 请求ID 最小长度：0 最大长度：256

响应参数 状态码：201 表4 响应Body参数 参数 参数类型 描述 dashboard_id String 监控看板id 正则匹配：^db([a-z]|[A-Z]|[0-9]){22} 状态码：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 状态码：500 表7 响应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_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)$ dashboard_id 否 String 监控看板id 正则匹配：^db([a-z]|[A-Z]|[0-9]){22} row_widget_num 否 Integer 监控视图展示模式，0表示自定义坐标，1代表每行一个 最小值：0 最大值：3 缺省值：3

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 notification_mask_ids Array of strings 删除成功的屏蔽规则ID 数组长度：1 - 100 状态码：400 表5 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度：0 最大长度：256 error_msg String 请求异常信息 最小长度：0 最大长度：256 request_id String 请求ID 最小长度：0 最大长度：256 状态码：404 表6 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度：0 最大长度：256 error_msg String 请求异常信息 最小长度：0 最大长度：256 request_id String 请求ID 最小长度：0 最大长度：256 状态码：500 表7 响应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参数 参数 是否必选 参数类型 描述 notification_mask_ids 是 Array of strings 屏蔽规则编号 数组长度：1 - 100

响应参数 状态码：200 表8 响应Body参数 参数 参数类型 描述 succeed_count Integer 成功添加的资源数目 最小值：0 最大值：1000 状态码：400 表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

请求参数 表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.ECS,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不同，使用时请注意。