华为云用户手册

URI GET /v2/{project_id}/alarms/{alarm_id}/policies 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户ID 最小长度：1 最大长度：64 alarm_id 是 String 告警规则ID 正则匹配：^al([0-9A-Za-z]){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)$

URI GET /V1.0/{project_id}/alarms 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 项目ID。 获取方式请参见获取项目ID。 表2 参数说明 名称 参数类型 说明 alarms Array of objects 告警规则列表。 详细参数请参见表3。 表3 查询检索参数 名称 是否必选 参数类型 说明 start 否 String 分页起始值，内容为alarm_id。 limit 否 Integer 取值范围(0,100]，默认值为100 用于限制结果数据条数。 order 否 String 用于标识结果排序方法，时间戳排序。 取值说明，默认值为desc。 asc：升序 desc：降序 enterprise_project_id 否 String 企业项目ID，默认值为all_granted_eps。表示所有企业项目。 当查询所有企业项目时，配置为：all_granted_eps。 当需要查询某个企业项目时，配置为对应的企业项目ID，请参考获取企业项目ID。 样例 请求样例一：查询当前告警规则列表。 GET https://{云监控的endpoint}/V1.0/{project_id}/alarms 请求样例二：查询告警规则列表，从alarm_id为al1441967036681YkazZ0deN开始，结果按时间戳降序保留10条数据。 GET https://{云监控的endpoint}/V1.0/{project_id}/alarms?start=al1441967036681YkazZ0deN&limit=10&order=desc 请求样例三：查询所有企业项目下的告警规则列表，从alarm_id为al1441967036681YkazZ0deN开始，结果按时间戳降序保留10条数据。 GET https://{云监控的endpoint}/V1.0/{project_id}/alarms?start=al1441967036681YkazZ0deN&limit=10&order=desc&enterprise_project_id=all_granted_eps

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

请求参数 表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参数 参数 参数类型 描述 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

URI GET /V1.0/{project_id}/alarm-template 参数说明 表1 参数说明 名称 参数类型 是否必选 说明 project_id String 是 项目ID。 获取方式请参见获取项目ID。 alarmTemplateId String 否 自定义告警模的ID，如：at1603330892378wkDm77y6B。 namespace String 否 资源命名空间，如弹性云服务器的资源命名空间为：SYS.ECS，各服务命名空间可查看支持监控的服务列表。 dname String 否 自定义告警模板选择的资源维度，例如弹性云服务器维度为instance_id。各服务的监控维度可查看支持监控的服务列表。 start String 否 分页起始值，类型为integer，默认值为0。 limit String 否 单次查询的条数限制，取值范围(0,100]，默认值为100，用于限制结果数据条数。 样例 GET https://{云监控的endpoint}/V1.0/{project_id}/alarms/alarm-template

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

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

响应消息 响应参数 表1 要素说明 名称 参数类型 说明 versions Array of objects 描述version相关对象的列表。 详细参数说明请参见表2。 表2 versions字段数据结构说明 名称 参数类型 说明 id String 版本ID（版本号），如v1。 links Array of objects API的URL地址。 详细参数说明请参见表3。 version String 若该版本API支持微版本，该参数表示支持的最大微版本号，如果不支持微版本，则为空。 status String 版本状态，为如下3种： CURRENT：表示该版本为主推版本。 SUPPORTED：表示为老版本，但是现在还继续支持。 DEPRECATED：表示为废弃版本，存在后续删除的可能。 updated String 版本发布时间，采用UTC时间表示。如v1发布的时间2014-06-28T12:20:21Z。 min_version String 若该版本API 支持微版本，该参数表示支持的最小微版本号， 如果不支持微版本，则为空。 表3 links字段数据结构说明 名称 参数类型 说明 href String 当前API版本的引用地址。 rel String 当前API版本和被引用地址的关系。 响应样例 { "versions": [ { "id": "V1.0", "links": [ { "href": "https://x.x.x.x/V1.0/", "rel": "self" } ], "min_version": "", "status": "CURRENT", "updated": "2018-09-30T00:00:00Z", "version": "" } ] }

请求参数 表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：告警规则，CES-dashboard：dashboard，CES-resourceGroup：资源分组，CES-qualityMonitor：质量监控 最小长度：1 最大长度：32 枚举值： CES-alarm CES-dashboard CES-resourceGroup CES-qualityMonitor

响应参数 状态码： 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参数 参数 参数类型 描述 http_code Integer Http状态码。200:：OK，404：资源不存在。 最小值：3 最大值：3 枚举值： 200 404 message GoAPIErrorResponseMsg object 错误信息 表6 GoAPIErrorResponseMsg 参数 参数类型 描述 details String 错误信息 最小长度：0 最大长度：1024 code String 业务错误码 最小长度：1 最大长度：16

响应示例 状态码： 200 OK { "dashboards" : [ { "dashboard_id" : "dbxxxxxxxxxxxxxxxxxxxxxx", "ret_status" : "successful" }, { "dashboard_id" : "dbXXXXXXXXXXXXXXXXXXXXXX", "ret_status" : "error", "error_msg" : "record not found" } ] }

请求参数 表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参数 参数 是否必选 参数类型 描述 dashboard_ids 否 Array of strings 监控看板id列表 数组长度：1 - 30

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

请求参数 表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 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)$

响应消息 响应参数 表2 响应参数 名称 参数类型 说明 datapoints Array of objects 配置信息列表。如果不存在对应的配置信息，则datapoints为空数组[]。 详细参数请参见表3。 表3 datapoints字段数据结构说明 名称 参数类型 说明 type String 事件类型，例如instance_host_info。 timestamp Long 事件上报时间，UNIX时间戳，单位毫秒。 value String 主机配置信息。 响应样例 { "datapoints": [ { "type": "instance_host_info", "timestamp": 1450231200000, "value": "xxx" }, { "type": "instance_host_info", "timestamp": 1450231800000, "value": "xxx" } ] }

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

URI GET /V1.0/{project_id}/event-data 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 项目ID。 获取方式请参见获取项目ID。 以下列表为查询检索参数 名称 是否必选 参数类型 说明 namespace 是 String 查询服务的命名空间，各服务命名空间请参考支持监控的服务列表。 格式为service.item；service和item必须是字符串，必须以字母开头，只能包含0-9/a-z/A-Z/_，service.item总长度最短为3，最大为32。 type 是 String 事件类型，只允许字母、下划线、中划线，字母开头，长度不超过64，如instance_host_info。 from 是 String 查询数据起始时间，UNIX时间戳，单位毫秒。 to 是 String 查询数据截止时间UNIX时间戳，单位毫秒。from必须小于to。 dim 是 String 监控维度，例如弹性云服务器的维度为instance_id。各服务监控指标对应的维度请参考支持监控的服务列表中对应服务的监控指标说明。 指标的维度，目前最大支持3个维度，维度编号从0开始；维度格式为dim.{i}=key,value。key的最大长度32，value的最大长度为256。 例如dim.0=instance_id,i-12345 样例：查询弹性云服务器ID为33328f02-3814-422e-b688-bfdba93d4051，事件类型为instance_host_info的主机配置信息。 GET https://{云监控的endpoint}/V1.0/{project_id}/event-data?namespace=SYS.ECS&dim.0=instance_id,33328f02-3814-422e-b688-bfdba93d4051&type=instance_host_info&from=1450234543422&to=1450320943422

响应示例 状态码： 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)+$

响应参数 状态码： 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 表3 响应Body参数 参数 参数类型 描述 alarms Array of alarms objects 告警规则列表 数组长度：1 - 100 表4 alarms 参数 参数类型 描述 alarm_id String 告警规则ID，以al开头，包含22个数字或字母 name String 告警名称, 只能包含0-9/a-z/A-Z/_/-或汉字，长度1-128 description String 告警描述，长度0-256 namespace String 指标命名空间 policies Array of Policy objects 告警策略 数组长度：1 - 100 resources Array of ResourcesInListResp objects 资源列表，关联资源需要使用查询告警规则资源接口获取 数组长度：1 - 3000 type String 告警规则类型 enabled Boolean 告警开关 notification_enabled Boolean 是否开启告警通知 alarm_notifications Array of SMNAction objects 告警触发的动作 ok_notifications Array of SMNAction objects 告警恢复触发的动作 notification_begin_time String 告警通知开启时间 notification_end_time String 告警通知关闭时间 表5 Policy 参数 参数类型 描述 alarm_policy_id String 告警规则策略ID metric_name String 指标名称 period Integer 告警条件判断周期，单位秒，1表示以原始数据判断告警，当告警的alarm_type为(EVENT.SYS|EVENT.CUSTOM)时可能为0 枚举值： 0 1 300 1200 3600 14400 86400 filter String 聚合方式 comparison_operator String 告警阈值的比较条件 value Number 阈值 unit String 单位 count Integer 次数 suppress_duration Integer 抑制周期，单位秒，0表示只告警一次 枚举值： 0 300 600 900 1800 3600 10800 21600 43200 86400 level Integer 告警级别, 1为紧急，2为重要，3为次要，4为提示 enabled Boolean 开关 表6 ResourcesInListResp 参数 参数类型 描述 resource_group_id String 资源分组ID，监控范围为资源分组时存在该值 正则匹配：^rg([a-z]|[A-Z]|[0-9]){22}$ resource_group_name String 资源分组名称，监控范围为资源分组时存在该值 最小长度：1 最大长度：128 dimensions Array of MetricDimension objects 维度信息 数组长度：0 - 10000 表7 MetricDimension 参数 参数类型 描述 name String 指标维度名称 最小长度：1 最大长度：32 正则匹配：^([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_|-){1,32}$ value String 指标维度值 最小长度：0 最大长度：256 正则匹配：^((([a-z]|[A-Z]|[0-9]){1}([a-z]|[A-Z]|[0-9]|_|-)*)|){0,256}$ 表8 SMNAction 参数 参数类型 描述 type String 通知类型,枚举类型：notification,autoscaling,groupwatch,ecsRecovery,contact,contactGroup,iecAction 枚举值： notification autoscaling groupwatch ecsRecovery contact contactGroup iecAction 正则匹配：^(notification|autoscaling|groupwatch|ecsRecovery|contact|contactGroup|iecAction)$ notification_list Array of strings 告警状态发生变化时，被通知对象的列表。topicUrn可从SMN获取，具体操作请参考查询Topic列表。当type为notification时，notificationList列表不能为空；当type为autoscaling时，列表必须为[]。 说明：若alarm_action_enabled为true，对应的alarm_actions、ok_actions至少有一个不能为空。若alarm_actions、ok_actions同时存在时，notificationList值保持一致。 数组长度：0 - 20 状态码： 400 表9 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度：0 最大长度：256 error_msg String 请求异常信息 最小长度：0 最大长度：256 request_id String 请求ID 最小长度：0 最大长度：256 状态码： 401 表10 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度：0 最大长度：256 error_msg String 请求异常信息 最小长度：0 最大长度：256 request_id String 请求ID 最小长度：0 最大长度：256 状态码： 403 表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

响应示例 状态码： 200 OK { "alarms" : [ { "alarm_id" : "al123232232341232132", "name" : "alarm1", "description" : "hello world", "namespace" : "SYS.ECS", "policies" : [ { "alarm_policy_id" : "alxdxxxdsw12321321", "metric_name" : "cpu_util", "period" : 0, "filter" : "max", "comparison_operator" : "", "value" : 1.7976931348623156E108, "unit" : "%", "count" : 100, "suppress_duration" : 0, "level" : 2, "enabled" : true } ], "resources" : [ { "dimensions" : [ { "name" : "string", "value" : "string" } ] } ], "type" : "EVENT.SYS", "enabled" : true, "notification_enabled" : true, "alarm_notifications" : [ { "type" : "notification", "notification_list" : [ "urn:smn:123" ] } ], "ok_notifications" : [ { "type" : "notification", "notification_list" : [ "urn:smn:123" ] } ], "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

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

响应示例 状态码： 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 Dimension objects 资源的维度信息 数组长度：1 - 4 表6 Dimension 参数 参数类型 描述 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

URI GET /v2/{project_id}/resource-groups/{group_id}/services/{service}/resources 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户ID 最小长度：1 最大长度：64 group_id 是 String 资源分组ID，以rg开头，后跟22位由字母或数字组成的字符串 最小长度：2 最大长度：24 service 是 String 服务类别，如SYS.ECS 最小长度：3 最大长度：32 表2 Query参数 参数 是否必选 参数类型 描述 dim_name 否 String 资源维度信息，多个维度按字母序使用逗号分割 最小长度：1 最大长度：131 limit 否 String 分页查询时每页的条目数，取值[1,100]，默认值为100 最小长度：1 最大长度：100 offset 否 Integer 分页查询时查询的起始位置，表示从第几条数据开始，默认为0 最小值：0 最大值：10000 status 否 String 按状态信息进行过滤，取值只能为health（已设置告警规则且无告警触发的资源）、unhealthy（已设置告警规则且有告警触发的资源）、no_alarm_rule（未设置告警规则的资源） 枚举值： health unhealthy no_alarm_rule dim_value 否 String 资源维度值，不支持模糊匹配，但是多维度资源可以只指定一个维度值 最小长度：1 最大长度：1027 tag 否 String 资源的标签信息，格式："[key]":"[value]"，样例参考："ssss":"1111" 最小长度：0 最大长度：500 extend_relation_id 否 String 企业项目ID 最小长度：0 最大长度：128