华为云用户手册

返回值 正常 204 异常 返回值 说明 400 Bad Request 请求错误。 401 Unauthorized 未提供认证信息，或认证信息错误。 403 Forbidden 请求页面被禁止访问。 408 Request Timeout 请求超出了服务器的等待时间。 429 Too Many Requests 当前请求过多。 500 Internal Server Error 请求未完成，服务异常。 503 Service Unavailable 系统暂时不可用，请求受限。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 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 association_ep_ids Array of strings 该资源分组内包含的资源来源的企业项目ID，type为EPS时必传 数组长度：1 - 1 tags Array of ResourceGroupTagRelation objects 标签动态匹配时的关联标签,type为TAG时该字段不为空 数组长度：1 - 10 表4 ResourceGroupTagRelation 参数 参数类型 描述 key String 键 最小长度：1 最大长度：36 value String 值 最小长度：1 最大长度：42 状态码： 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 状态码： 404 表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 { "group_name" : "band", "type" : "TAG", "tags" : [ { "key" : "Resource", "value" : "VPC" }, { "key" : "Usage", "value" : "Tmp" } ], "create_time" : "2006-01-02T15:04:05.000Z", "group_id" : "rg0123456789xxxx", "enterprise_project_id" : "0" }

请求示例 { "group_name" : "Resource-Group-Test01", "resources" : [ { "namespace" : "SYS.E CS ", "dimensions" : [ { "name" : "instance_id", "value" : "063a83da-a2b5-4630-ab6b-9b4fcfc261ea" } ] }, { "namespace" : "SYS.ECS", "dimensions" : [ { "name" : "instance_id", "value" : "518ace88-abde-46bf-829b-0d1f0f2fb2e9" } ] } ] }

返回值 正常 201 异常 返回值 说明 400 Bad Request 请求错误。 401 Unauthorized 未提供认证信息，或认证信息错误。 403 Forbidden 请求页面被禁止访问。 408 Request Timeout 请求超出了服务器的等待时间。 429 Too Many Requests 当前请求过多。 500 Internal Server Error 请求未完成，服务异常。 503 Service Unavailable 系统暂时不可用，请求受限。

请求消息 请求参数 表2 请求参数 名称 类型 是否必选 说明 group_name String 是 资源分组的名称，长度为1-128，只能包含0-9/a-z/A-Z/_/-或汉字。如：ResourceGroup-Test01。 resources Array of objects 是 创建的资源分组选择一个或者多个资源。 详细参数说明请参见表3。 表3 resources字段数据结构说明 名称 参数类型 是否必选 说明 namespace String 是 资源命名空间，如弹性云服务器的资源命名空间为：SYS.ECS，各服务命名空间可查看支持监控的服务列表。 dimensions Arrays of objects 是 一个或者多个资源维度。 详细参数说明请参见表4。 表4 dimensions字段数据结构说明 名称 参数类型 是否必选 说明 name String 是 资源维度，例如弹性云服务器维度为：instance_id，各资源的维度可查看支持监控的服务列表。 value String 是 资源维度值，为资源的实例ID。如：4270ff17-aba3-4138-89fa-820594c39755。

响应示例 状态码： 200 OK { "invocations" : [ { "invocation_id" : "invocationxxx001", "instance_id" : "instancexxx001", "instance_name" : "xxxx", "instance_type" : "ECS", "intranet_ips" : [ "10.xxx.xx.1" ], "elastic_ips" : [ "1.xx.xx.1" ], "invocation_type" : "INSTALL", "invocation_status" : "RUNNING", "invocation_target" : "telescope", "current_version" : "2.5.1", "target_version" : "2.6.1", "create_time" : 1678070008306, "update_time" : 1678070008306 } ], "count" : 1 }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 invocations Array of InvocationInfo objects 任务列表 数组长度：0 - 100 count Long 任务列表总量 最小值：0 最大值：9999999999999 表5 InvocationInfo 参数 参数类型 描述 invocation_id String 任务id 正则匹配：^([0-9A-Za-z]){1}([0-9A-Za-z]|_|-)*$ instance_id String 主机id 正则匹配：^[a-zA-Z0-9-]{1,64}$ instance_name String 主机名称 最小长度：1 最大长度：128 instance_type String 主机类型，ECS弹性云服务器，BMS裸金属服务器 枚举值： ECS BMS intranet_ips Array of strings 内网ip列表 数组长度：0 - 10 elastic_ips Array of strings 弹性公网ip列表 数组长度：0 - 10 invocation_type String 任务类型(INSTALL 安装，UPDATE升级，ROLLBACK回滚，RETRY重试) 枚举值： INSTALL UPDATE ROLLBACK RETRY invocation_status String 任务状态，PENDING 待执行，RUNNING 运行中，TIMEOUT 超时，FAILED 失败，SUCCEEDED 成功，CANCELED 取消，ROLLBACKED已回退 枚举值： PENDING RUNNING TIMEOUT FAILED SUCCEEDED CANCELED ROLLBACKED invocation_target String 任务对象，目前仅支持telescope 枚举值： telescope create_time Long 任务创建时间 最小值：1111111111111 最大值：9999999999999 update_time Long 任务更新时间 最小值：1111111111111 最大值：9999999999999 current_version String 当前版本 最小长度：1 最大长度：64 target_version String 目标版本 最小长度：1 最大长度：64 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 正则匹配：^(taskmgr\.[0-9]{4})$ error_msg String 错误信息 最小长度：1 最大长度：256 状态码： 401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 正则匹配：^(taskmgr\.[0-9]{4})$ error_msg String 错误信息 最小长度：1 最大长度：256 状态码： 403 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 正则匹配：^(taskmgr\.[0-9]{4})$ error_msg String 错误信息 最小长度：1 最大长度：256 状态码： 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 正则匹配：^(taskmgr\.[0-9]{4})$ error_msg String 错误信息 最小长度：1 最大长度：256

URI GET /v3/{project_id}/agent-invocations 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id 最小长度：1 最大长度：64 正则匹配：^[a-z0-9]+$ 表2 Query参数 参数 是否必选 参数类型 描述 instance_id 否 String 主机id 正则匹配：^[a-zA-Z0-9-]{1,64}$ instance_type 否 String 主机类型，ECS弹性云服务器，BMS裸金属服务器 枚举值： ECS BMS invocation_id 否 String 任务id 正则匹配：^([0-9A-Za-z]){1}([0-9A-Za-z]|_|-)*$ invocation_type 否 String 任务类型, INSTALL安装, UPDATE升级, ROLLBACK回退，RETRY重试 枚举值： INSTALL UPDATE ROLLBACK RETRY invocation_target 否 String 任务对象，目前仅支持telescope 缺省值：telescope 枚举值： telescope offset 否 Long 分页偏移量 最小值：0 最大值：9999999999999 缺省值：0 limit 否 Integer 分页大小 最小值：1 最大值：100 缺省值：100

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 alarm_policy_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 状态码： 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 状态码： 404 表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

请求参数 表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参数 参数 是否必选 参数类型 描述 alarm_policy_ids 是 Array of strings 需要批量启停的告警规则策略的ID列表 数组长度：1 - 100 enabled 是 Boolean 开关

URI PUT /v2/{project_id}/one-click-alarms/{one_click_alarm_id}/alarms/{alarm_id}/policies/action 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户ID 最小长度：1 最大长度：64 正则匹配：^[a-zA-Z0-9-]{1,64}$ one_click_alarm_id 是 String 一键告警ID 最小长度：1 最大长度：64 alarm_id 是 String 告警规则ID 最小长度：24 最大长度：24

返回值 正常 201 异常 返回值 说明 400 Bad Request 请求错误。 401 Unauthorized 未提供认证信息，或认证信息错误。 403 Forbidden 请求页面被禁止访问。 408 Request Timeout 请求超出了服务器的等待时间。 429 Too Many Requests 当前请求过多。 500 Internal Server Error 请求未完成，服务异常。 503 Service Unavailable 系统暂时不可用，请求受限。

请求消息 单次POST请求消息体大小不能超过512KB，否则请求会被服务端拒绝。 POST请求发送周期应小于最小聚合周期，否则会出现聚合数据点不连续。例如：聚合周期为5分钟，发送周期为7分钟，则5分钟情况的聚合数据会出现每10分钟才出现一个点。 POST请求体中时间戳（collect_time）的值必须从当前时间的前三天到当前时间后的十分钟之内某一时间，如果不在这个范围内，则不允许插入指标数据。 请求参数 表2 参数说明 名称 参数类型 是否必选 说明 数组元素 Array of objects 是 添加一条或多条自定义指标监控数据。 单次POST请求消息体大小不能超过512KB 详细参数请参见表3。 表3 数组元素 名称 是否必选 参数类型 说明 metric 是 Object 指标数据。 详细参数请参见表4。 ttl 是 Integer 数据的有效期，超出该有效期则自动删除该数据，单位秒，取值范围(0-604800]。 collect_time 是 Long 数据收集时间 UNIX时间戳，单位毫秒。 说明： 因为客户端到服务器端有延时，因此插入数据的时间戳应该在[当前时间-3天+20秒，当前时间+10分钟-20秒]区间内，保证到达服务器时不会因为传输时延造成数据不能插入数据库。 value 是 Double 待添加的监控指标数据的值。 数值类型支持“整数”或“浮点数”。 unit 否 String 数据的单位。 最大长度为32位。 type 否 String 枚举型。 取值范围： int float 表4 metric字段数据结构说明 名称 是否必选 参数类型 说明 namespace 是 String 自定义的命名空间，各服务命名空间请参考支持监控的服务列表。 格式为service.item；service和item必须是字符串，必须以字母开头，只能包含0-9/a-z/A-Z/_，service.item总长度最短为3，最大为32，其中service不能为“SYS”、“AGT”和“SRE”，namespace不能为SERVICE.BMS，因为此namespace已被系统使用。 当alarm_type为(EVENT.SYS| EVENT.CUSTOM)时允许为空。 dimensions 是 Array of objects 指标的维度，目前最大支持3个维度。 详细参数请参见表5。 metric_name 是 String 指标ID，例如弹性云服务器的监控指标CPU使用率，对应的metric_name为cpu_util。各服务监控指标请参考支持监控的服务列表。 表5 dimensions字段数据结构说明 名称 是否必选 参数类型 说明 name 是 String 监控维度名称，例如弹性云服务器的维度为instance_id。各服务维度请参考支持监控的服务列表，可参考维度中key字段。 必须以字母开头，只能包含0-9/a-z/A-Z/_/-，长度最短为1，最大为32。 value 是 String 维度取值，例如弹性云服务器的ID。 必须以字母或数字开头，只能包含0-9/a-z/A-Z/_/-，长度最短为1，最大为256。 请求样例 请求样例一：添加自定义的维度instance_id为6f3c6f91-4b24-4e1b-b7d1-a94ac1cb011d的监控指标数据cpu_util。 [ { "metric": { "namespace": "MINE.APP", "dimensions": [ { "name": "instance_id", "value": "6f3c6f91-4b24-4e1b-b7d1-a94ac1cb011d" } ], "metric_name": "cpu_util" }, "ttl": 172800, "collect_time": 1463598260000, "type": "float", "value": 0.09, "unit": "%" }, { "metric": { "namespace": "MINE.APP", "dimensions": [ { "name": "instance_id", "value": "6f3c6f91-4b24-4e1b-b7d1-a94ac1cb011d" } ], "metric_name": "cpu_util" }, "ttl": 172800, "collect_time": 1463598270000, "type": "float", "value": 0.12, "unit": "%" } ] 请求样例二：添加关系型数据库的维度rds_cluster_id为3c8cc15614ab46f5b8743317555e0de2in01的监控指标数据rds021_myisam_buf_usage。 [ { "metric": { "namespace": "SYS.RDS", "dimensions": [ { "name": "rds_cluster_id", "value": "3c8cc15614ab46f5b8743317555e0de2in01" } ], "metric_name": "rds021_myisam_buf_usage" }, "ttl": 172800, "collect_time": 1463598260000, "type": "float", "value": 0.01, "unit": "Ratio" } ] 请求样例三：添加分布式缓存服务的维度dcs_instance_id为1598b5d4-3cb5-4f4d-8d99-2425d8e9ed54和dcs_cluster_redis_node为6666cd76f96956469e7be39d750cc7d9的监控指标数据connections_usage。 [ { "metric": { "namespace": "SYS.DCS", "dimensions": [ { "name": "dcs_instance_id", "value": "1598b5d4-3cb5-4f4d-8d99-2425d8e9ed54" }, { "name": "dcs_cluster_redis_node", "value": "6666cd76f96956469e7be39d750cc7d9" } ], "metric_name": "connections_usage" }, "ttl": 172800, "collect_time": 1463598260000, "type": "float", "value": 8.3, "unit": "%" } ]

返回值 正常 201 异常 返回值 说明 400 Bad Request 请求错误。 401 Unauthorized 未提供认证信息，或认证信息错误。 403 Forbidden 请求页面被禁止访问。 408 Request Timeout 请求超出了服务器的等待时间。 429 Too Many Requests 当前请求过多。 500 Internal Server Error 请求未完成，服务异常。 503 Service Unavailable 系统暂时不可用，请求受限。

响应示例 状态码： 200 OK { "widgets" : [ { "widget_id" : "wgXXXXXXXXXXXXXXXXXXXXXX", "ret_status" : "successful" }, { "widget_id" : "wg9876543210123456789012", "ret_status" : "error", "error_msg" : "record not found" } ] }

请求示例 [ { "widget_id" : "wgXXXXXXXXXXXXXXXXXXXXXX", "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" : 500, "threshold_enabled" : false, "title" : "widget_title_new", "properties" : { "filter" : "topN", "topN" : 10, "order" : "asc" }, "location" : { "left" : 0, "top" : 3, "width" : 4, "height" : 3 }, "unit" : "%" } ]

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 发送的实体的MIME类型。推荐用户默认使用application/json 缺省值：application/json;charset=UTF-8 最小长度：1 最大长度：64 X-Auth-Token 是 String 用户Token。用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 最小长度：1 最大长度：16000 表3 请求Body参数 参数 是否必选 参数类型 描述 [数组元素] 是 Array of UpdateWidgetInfo objects 批量更新监控视图请求体 表4 UpdateWidgetInfo 参数 是否必选 参数类型 描述 widget_id 是 String 视图id 正则匹配：^wg([a-z]|[A-Z]|[0-9]){22}$ 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 单位 表5 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 指标名称 最小长度：1 最大长度：96 正则匹配：^([A-Za-z]){1}([0-9A-Za-z]|_|-)*$ alias 否 Array of strings 监控视图的指标别名列表 最小长度：1 最大长度：128 数组长度：0 - 200 extra_info 否 ExtraInfo object 指标信息 表6 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 表7 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 表8 properties 参数 是否必选 参数类型 描述 filter 否 String 聚合类型，目前只有TopN这一种类型，折线图不支持该参数 枚举值： topN topN 否 Integer Top值前N个;折线图时表示随机展示的时序数据条数 最小值：1 最大值：2147483647 缺省值：100 order 否 String 排序字段，asc正序，desc倒序，折线图不支持该参数 枚举值： asc desc 表9 location 参数 是否必选 参数类型 描述 top 是 Integer 监控视图的上坐标 最小值：0 最大值：2147483647 left 是 Integer 监控视图的左坐标 最小值：0 最大值：9 width 是 Integer 监控视图图表宽度 最小值：3 最大值：12 height 是 Integer 监控视图图表高度 最小值：3 最大值：2147483647

响应参数 状态码： 200 表10 响应Body参数 参数 参数类型 描述 widgets Array of BatchUpdateWidgetInfo objects 更新结果列表 数组长度：1 - 50 表11 BatchUpdateWidgetInfo 参数 参数类型 描述 widget_id String 视图id 正则匹配：^wg([a-z]|[A-Z]|[0-9]){22}$ ret_status String 修改结果；成功: successful, 失败: error 枚举值： successful error error_msg String 如果失败则返回失败信息 最小长度：1 最大长度：2048 状态码： 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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 发送的实体的MIME类型。推荐用户默认使用application/json 缺省值：application/json;charset=UTF-8 最小长度：1 最大长度：64 X-Auth-Token 是 String 用户Token。用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 最小长度：1 最大长度：16000

响应参数 状态码： 400 表3 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度：0 最大长度：256 error_msg String 请求异常信息 最小长度：0 最大长度：256 request_id String 请求ID 最小长度：0 最大长度：256 状态码： 401 表4 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度：0 最大长度：256 error_msg String 请求异常信息 最小长度：0 最大长度：256 request_id String 请求ID 最小长度：0 最大长度：256 状态码： 500 表5 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度：0 最大长度：256 error_msg String 请求异常信息 最小长度：0 最大长度：256 request_id String 请求ID 最小长度：0 最大长度：256

响应消息 响应参数 表2 响应参数 名称 参数类型 说明 group_name String 资源分组的名称，如：Resource-Group-ECS-01。 group_id String 资源分组的ID，如：rg1603786526428bWbVmk4rP。 resources Arrays of objects 一组或者多组资源信息。 详细参数说明请参见表3。 status String 资源分组的当前状态，值可为health、unhealth、no_alarm_rule。health表示健康，unhealth表示不健康，no_alarm_rule表示未设置告警规则。 create_time Long 资源分组的创建时间，UNIX时间戳，单位毫秒。如：1603819753000。 meta_data MetaData object 查询结果元数据信息，包括分页信息等。 详细参数说明请参见表5。 enterprise_project_id String 创建资源分组时关联的企业项目。默认值为0，表示企业项目为default。 表3 resources字段数据结构说明 名称 参数类型 说明 namespace String 资源命名空间，如弹性云服务器的资源命名空间为：SYS.ECS，各服务命名空间可查看支持监控的服务列表。 dimensions Arrays of objects 一个或者多个资源维度。 详细参数说明请参见表4。 status String 资源分组的当前状态，值可为health、unhealth、no_alarm_rule。health表示健康，unhealth表示不健康，no_alarm_rule表示未设置告警规则。 event_type Integer 事件类型，默认为0。 表4 dimensions字段数据结构说明 名称 参数类型 说明 name String 资源维度，例如弹性云服务器维度为：instance_id，各资源的维度可查看支持监控的服务列表。 value String 资源维度值，为资源的实例ID。如：4270ff17-aba3-4138-89fa-820594c39755。 表5 meta_data字段数据结构说明 名称 参数类型 说明 count Integer 当前返回结果条数。 total Integer 结果总条数。 marker String 下一个开始的标记，用于分页。 返回样例 { "group_name": "ResourceGroup-Test-01", "resources": [ { "namespace": "SYS.ECS", "dimensions": [ { "name": "instance_id", "value": "6cffb0bd-fd37-400f-ae6f-8f4be021ff7e" } ], "status": "health", "event_type": 0 }, { "namespace": "SYS.ECS", "dimensions": [ { "name": "instance_id", "value": "e37d6238-9dd3-4720-abcc-eb9f8fb08ca0" } ], "status": "health", "event_type": 0 } ], "create_time": 1604476378000, "group_id": "rg16044763786104XvXvl00a", "status": "health", "meta_data": { "count": 0, "marker": "", "total": 2 }, "enterprise_project_id": "0" }

URI GET /V1.0/{project_id}/resource-groups/{group_id} 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 项目ID。 获取方式请参见获取项目ID。 group_id 是 资源分组ID。 status 否 资源健康状态，值可为health、unhealth、no_alarm_rule，health表示健康。 namespace 否 资源命名空间，例如弹性云服务器的资源命名空间为：SYS.ECS，各服务命名空间可查看支持监控的服务列表。 dname 否 资源维度，例如弹性云服务器维度为：instance_id，各资源的维度可查看支持监控的服务列表。 start 否 分页起始值，类型为integer，默认值为0。 limit 否 单次查询的条数限制，类型为integer，取值范围(0,100]，默认值为100，用于限制结果数据条数。 样例：查询资源分组下的资源。 GET https://{ 云监控 的endpoint}/V1.0/{project_id}/resource-groups/{group_id}

返回值 正常 200 异常 返回值 说明 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参数 参数 参数类型 描述 one_click_alarm_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 状态码： 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 表3 请求Body参数 参数 是否必选 参数类型 描述 one_click_alarm_ids 是 Array of strings 需要批量删除的一键告警ID列表 数组长度：1 - 100

响应参数 状态码： 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