华为云用户手册

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（智能添加-组合匹配） 枚举值： EPS TAG Manual COMB origin_flag 否 String 来源标识，取值只能为resourcegroup（资源分组）,monitoroverview（监控概览），不传默认为资源分组 枚举值： resourcegroup monitoroverview

响应示例 状态码： 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 表3 响应Body参数 参数 参数类型 描述 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 单位 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 指标名称 最小长度：1 最大长度：96 正则匹配：^([A-Za-z]){1}([0-9A-Za-z]|_|-)*$ alias Array of strings 监控视图的指标别名列表 最小长度：1 最大长度：128 数组长度：0 - 200 extra_info ExtraInfo object 指标信息 表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 表8 location 参数 参数类型 描述 top Integer 监控视图的上坐标 最小值：0 最大值：2147483647 left Integer 监控视图的左坐标 最小值：0 最大值：9 width Integer 监控视图图表宽度 最小值：3 最大值：12 height Integer 监控视图图表高度 最小值：3 最大值：2147483647 状态码： 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 状态码： 500 表11 响应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

基本概念 账号 用户注册时的账号，账号对其所拥有的资源及云服务具有完全的访问权限，可以重置用户密码、分配用户权限等。由于账号是付费主体，为了确保账号安全，建议您不要直接使用账号进行日常管理工作，而是创建用户并使用用户进行日常管理工作。 用户 由账号在IAM中创建的用户，是云服务的使用人员，具有身份凭证（密码和访问密钥）。 在我的凭证下，您可以查看账号ID和IAM用户ID。通常在调用API的鉴权过程中，您需要用到账号、用户和密码等信息。 区域（Region） 从地理位置和网络时延维度划分，同一个Region内共享弹性计算、块存储、对象存储、VPC网络、弹性公网IP、镜像等公共服务。Region分为通用Region和专属Region，通用Region指面向公共租户提供通用云服务的Region；专属Region指只承载同一类业务或只面向特定租户提供业务服务的专用Region。 详情请参见区域和可用区。 可用区（AZ，Availability Zone） 一个可用区是一个或多个物理数据中心的集合，有独立的风火水电，AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连，以满足用户跨AZ构建高可用性系统的需求。 项目 区域默认对应一个项目，这个项目由系统预置，用来隔离物理区域间的资源（计算资源、存储资源和网络资源），以默认项目为单位进行授权，用户可以访问您账号中该区域的所有资源。如果您希望进行更加精细的权限控制，可以在区域默认的项目中创建子项目，并在子项目中创建资源，然后以子项目为单位进行授权，使得用户仅能访问特定子项目中的资源，使得资源的权限控制更加精确。 图1 项目隔离模型 同样在我的凭证下，您可以查看项目ID。 企业项目 企业项目是项目的升级版，针对企业不同项目间的资源进行分组和管理，是逻辑隔离。企业项目中可以包含多个区域的资源，且项目中的资源可以迁入迁出。 关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理用户指南》。 父主题： 使用前必读

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

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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token 最小长度：1 最大长度：16384 表3 请求Body参数 参数 是否必选 参数类型 描述 resources 是 Array of Resource objects 资源信息 数组长度：1 - 1000 表4 Resource 参数 是否必选 参数类型 描述 namespace 是 String 查询服务的命名空间，各服务命名空间请参考“服务命名空间” dimensions 是 Array of Dimension objects 资源的维度信息 数组长度：1 - 4 表5 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}$

请求消息体（可选） 该部分可选。请求消息体通常以结构化格式（如JSON或XML）发出，与请求消息头中Content-Type对应，传递除请求消息头之外的内容。若请求消息体中的参数支持中文，则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。 对于获取用户Token接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示，加粗的斜体字段需要根据实际值填写，其中username为用户名，domainname为用户所属的账号名称，********为用户登录密码，xxxxxxxxxxxxxxxxxx为project的名称，如“cn-north-1”，您可以从地区和终端节点获取。 scope参数定义了Token的作用域，下面示例中获取的Token仅能访问project下的资源。您还可以设置Token的作用域为某个账号下所有资源或账号的某个project下的资源，详细定义请参见获取用户Token。 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxxxxxxxxxxxx" } } } } 到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于获取用户Token接口，返回的响应消息头中的“x-subject-token”就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。

请求URI 请求URI由如下部分组成： {URI-scheme}://{Endpoint}/{resource-path}?{query-string} 尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。 表1 URI中的参数说明 参数 描述 URI-scheme 表示用于传输请求的协议，当前所有API均采用HTTPS协议。 Endpoint 指定承载REST服务端点的服务器域名或IP，不同服务不同区域的Endpoint不同，您可以从地区和终端节点获取。 例如IAM服务在“华北-北京四”区域的Endpoint为“iam.cn-north-4.myhuaweicloud.com”。 resource-path 资源路径，即API访问路径。从具体API的URI模块获取，例如“获取用户Token”API的resource-path为“/v3/auth/tokens”。 query-string 查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个“?”，形式为“参数名=参数取值”，例如“?limit=10”，表示查询不超过10条数据。 例如您需要获取IAM在“华北-北京四”区域的Token，则需使用“华北-北京四”区域的Endpoint（iam.cn-north-4.myhuaweicloud.com），并在获取用户Token的URI部分找到resource-path（/v3/auth/tokens），拼接起来如下所示。 1 https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens 图1 URI示意图 为方便查看，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，而Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。

请求方法 HTTP请求方法（也称为操作或动词），它告诉服务您正在请求什么类型的操作。 表2 HTTP方法 方法 说明 GET 请求服务器返回指定资源。 PUT 请求服务器更新指定资源。 POST 请求服务器新增资源或执行特殊操作。 DELETE 请求服务器删除指定资源，如删除对象等。 HEAD 请求服务器资源头部。 PATCH 请求服务器更新资源的部分内容。 当资源不存在的时候，PATCH可能会去创建一个新的资源。 在获取用户Token的URI部分，您可以看到其请求方法为“POST”，则其请求为： 1 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens

请求消息头 附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。 详细的公共请求消息头字段请参见表3。 表3 公共请求消息头 名称 描述 是否必选 示例 Host 请求的服务器信息，从服务API的URL中获取。值为hostname[:port]。端口缺省时使用默认的端口，https的默认端口为443。 否 使用AK/SK认证时该字段必选。 code.test.com or code.test.com:443 Content-Type 消息体的类型（格式）。推荐用户使用默认值application/json，有其他取值时会在具体接口中专门说明。 是 application/json Content-Length 请求body长度，单位为Byte。 否 3495 X-Project-Id project id，项目编号。请参考获取项目ID章节获取项目编号。 否 如果是专属云场景采用AK/SK认证方式的接口请求，或者多project场景采用AK/SK认证的接口请求，则该字段必选。 e9993fc787d94b6c886cbaa340f9c0f4 X-Auth-Token 用户Token。 用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头（Headers）中包含的“X-Subject-Token”的值即为Token值。 否 使用Token认证时该字段必选。 注：以下仅为Token示例片段。 MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ API同时支持使用AK/SK认证，AK/SK认证使用SDK对请求进行签名，签名过程会自动往请求中添加Authorization（签名认证信息）和X-Sdk-Date（请求发送的时间）请求头。 AK/SK认证的详细说明请参见认证鉴权的“AK/SK认证”。 对于获取用户Token接口，由于不需要认证，所以只添加“Content-Type”即可，添加消息头后的请求如下所示。 1 2 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json

返回值 正常 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：标签动态匹配，空值：手动添加； 最小长度：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 } }

URI GET /V1.0/{project_id}/resource-groups 参数说明 表1 参数说明 名称 类型 是否必选 说明 project_id String 是 项目ID。 获取方式请参见获取项目ID。 group_name String 否 资源分组的名称，如：Resource-Group-ECS-01。 group_id String 否 资源分组的ID，如：rg1603786526428bWbVmk4rP。 status String 否 资源健康状态，值可为health、unhealth、no_alarm_rule，health表示健康。 start Integer 否 分页起始值，类型为integer，默认值为0。 limit Integer 否 单次查询的条数限制。取值范围(0,100]，默认值为100，用于限制结果数据条数。 样例：查询所有资源分组。 GET https://{云监控的endpoint}/V1.0/{project_id}/resource-groups

响应示例 状态码： 201 Created [ { "instance_id" : "instancexxx001", "ret_status" : "successful" }, { "instance_id" : "instancexxx002", "ret_status" : "error", "error_msg" : "do not meet the installation conditions" } ]

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 发送的实体的MIME类型。默认使用application/json; charset=UTF-8。 缺省值：application/json; charset=UTF-8 最小长度：1 最大长度：64 X-Auth-Token 是 String 用户project Token。用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 最小长度：1 最大长度：16384 表3 请求Body参数 参数 是否必选 参数类型 描述 instance_ids 否 Array of strings 主机id列表（INSTALL和UPDATE时必须） 数组长度：1 - 100 invocation_type 是 String 任务类型，INSTALL 安装，UPDATE升级，ROLLBACK回退，RETRY重试 枚举值： INSTALL UPDATE ROLLBACK RETRY invocation_target 否 String 任务对象，目前仅支持telescope 缺省值：telescope 枚举值： telescope invocation_ids 否 Array of strings 任务ID列表（ROLLBACK和RETRY时必须） 数组长度：1 - 100 version_type 否 String 插件升级时需要选择升级“基础版本”还是“增强版本”，传值“BASIC_VERSION”表示升级成基础版本，传值“ADVANCE_VERSION”表示升级成增强版本 枚举值： BASIC_VERSION ADVANCE_VERSION origin 否 String Agent任务接口调用源，CES表示由Console调用，APICOM_BMS表示由裸金属服务器调用，ADMIN_SERVER表示由运维平台调用 枚举值： CES APICOM_BMS ADMIN_SERVER

响应参数 状态码： 201 表4 响应Body参数 参数 参数类型 描述 invocations Array of BatchCreateInvocationInfo objects 创建任务的信息列表 数组长度：0 - 100 表5 BatchCreateInvocationInfo 参数 参数类型 描述 instance_id String 主机id 正则匹配：^[a-zA-Z0-9-]{1,64}$ ret_status String 任务结果, successful成功，error失败 枚举值： successful error error_msg String 错误信息 最小长度：1 最大长度：128 invocation_id String 任务id 正则匹配：^[a-zA-Z0-9-]{1,64}$ error_code String 错误码 正则匹配：^(invocationmgr\.[0-9]{4})$ 状态码： 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

返回值 正常 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}/metric-data?namespace={namespace}&metric_name={metric_name}&dim.{i}=key,value&from={from}&to={to}&period={period}&filter={filter} 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 项目ID。 获取方式请参见获取项目ID。 表2 查询检索参数 名称 是否必选 参数类型 说明 namespace 是 String 服务的命名空间，各服务命名空间请参考支持监控的服务列表。 格式为service.item；service和item必须是字符串，必须以字母开头，只能包含0-9/a-z/A-Z/_，service.item总长度最短为3，最大为32。 metric_name 是 String 指标名称，可通过查询指标列表获取已有的告警规则的指标名。 from 是 String 查询数据起始时间，UNIX时间戳，单位毫秒。 由于聚合运算的过程是将一个聚合周期范围内的数据点聚合到周期起始边界上，如果将from和to的范围设置在聚合周期内，会因为聚合未完成而造成查询数据为空，所以建议from参数相对于当前时间向前偏移至少1个周期。 以5分钟聚合周期为例：假设当前时间点为10:35，10:30~10:35之间的原始数据会被聚合到10:30这个点上，所以查询5分钟数据点时from参数应为10:30。 说明： 云监控会根据所选择的聚合粒度向前取整from参数。 to 是 String 查询数据截止时间UNIX时间戳，单位毫秒。from必须小于to。 period 是 Integer 监控数据粒度。 取值范围： 1，实时数据 300，5分钟粒度 1200，20分钟粒度 3600，1小时粒度 14400，4小时粒度 86400，1天粒度 filter 是 String 数据聚合方式，支持的聚合方式如下: average：聚合周期内指标数据的平均值。 max：聚合周期内指标数据的最大值。 min：聚合周期内指标数据的最小值。 sum：聚合周期内指标数据的求和值。 variance：聚合周期内指标数据的方差。 说明： 聚合运算的过程是将一个聚合周期范围内的数据点根据相应的聚合算法聚合到周期起始边界上，以5分钟聚合周期为例：假设当前时间点为10:35，则10:30~10:35之间的原始数据会被聚合到10:30这个时间点。 dim 是 String 指标的维度，目前最大支持3个维度，维度编号从0开始；维度格式为dim.{i}=key,value，key的最大长度32，value的最大长度为256。 CloudTable仅支持多维度查询。 以下维度说明仅为实例，具体是否支持多维度请参见各服务中监控指标说明中的维度说明。 单维度：dim.0=instance_id,i-12345 多维度：dim.0=instance_id,i-12345&dim.1=instance_name,i-1234 对于dimensions字段的内容，可通过调用查询指标列表接口，在其响应体的相关指标数据中获取。 对于OBS相关指标数据，当进行了相关OBS接口操作时可查询到相关指标数据，否则查询结果为空。 样例： 请求样例一：查看弹性云服务器ID为6f3c6f91-4b24-4e1b-b7d1-a94ac1cb011d的CPU使用率在2019-04-30 20:00:00到2019-04-30 22:00:00时间内，周期为20分钟的监控数据。 GET https://{云监控的endpoint}/V1.0/{project_id}/metric-data?namespace=SYS.ECS&metric_name=cpu_util&dim.0=instance_id,6f3c6f91-4b24-4e1b-b7d1-a94ac1cb011d&from=1556625600000&to=1556632800000&period=1200&filter=min 请求样例二：查询CloudTable服务维度分别是cluster_id为f2fbxxxc-36b2-4d1d-895d-972a4d656xxx和instance_name为hmaster-active的监控指标cmdProcessMem，在2019-04-30 20:00:00到2019-04-30 22:00:00时间内，周期为20分钟的监控数据。 GET https://{云监控的endpoint}/V1.0/{project_id}/metric-data?namespace=SYS.CloudTable&metric_name=cmdProcessMem&dim.0=cluster_id,f2fbxxxc-36b2-4d1d-895d-972a4d656xxx&dim.1=instance_name,hmaster-active&from=1556625600000&to=1556632800000&period=1200&filter=variance

响应消息 响应参数 表3 响应参数 名称 参数类型 说明 datapoints Array of objects 指标数据列表。详细参数请参见表4。 由于查询数据时，云监控会根据所选择的聚合粒度向前取整from参数，所以datapoints中包含的数据点有可能会多于预期。 metric_name String 指标ID，例如弹性云服务器的监控指标CPU使用率，对应的metric_name为cpu_util。各服务监控指标请参考支持监控的服务列表。 表4 datapoints字段数据结构说明 名称 参数类型 说明 average Double 聚合周期内指标数据的平均值。 max Double 聚合周期内指标数据的最大值。 min Double 聚合周期内指标数据的最小值。 sum Double 聚合周期内指标数据的求和值。 variance Double 聚合周期内指标数据的方差。 timestamp Long 指标采集时间，UNIX时间戳，单位毫秒。 unit String 指标单位。 响应样例 响应样例一：维度为SYS.ECS，响应弹性云服务器，CPU使用率的平均值。 { "datapoints": [ { "average": 0.23, "timestamp": 1442341200000, "unit": "%" } ], "metric_name": "cpu_util" } 响应样例二：维度为SYS.ECS，响应弹性云服务器，CPU使用率的求和值。 { "datapoints": [ { "sum": 0.53, "timestamp": 1442341200000, "unit": "%" } ], "metric_name": "cpu_util" } 响应样例三：维度为SYS.ECS，响应弹性云服务器，CPU使用率的最大值。 { "datapoints": [ { "max": 0.13, "timestamp": 1442341200000, "unit": "%" } ], "metric_name": "cpu_util" }

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)$

响应示例 状态码： 200 批量查询通知屏蔽规则资源列表成功 { "resources" : [ { "namespace" : "SYS.ECS", "dimensions" : [ { "name" : "instance_id", "value" : "4270ff17-aba3-4138-89fa-820594c39755" } ] } ], "count" : 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 资源命名空间，例如弹性云服务器命名空间(格式为service.item；service和item必须是字符串，以字母开头，可包含0-9/a-z/A-Z/_；长度范围[3,32]。) 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 状态码： 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 缺省值：application/json;charset=UTF-8 最小长度：1 最大长度：64 X-Auth-Token 是 String 用户Token。用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 最小长度：1 最大长度：16000 表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

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

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