华为云用户手册

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

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

响应参数 状态码： 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 GET /V1.0/{project_id}/alarms/{alarm_id} 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 项目ID。 获取方式请参见获取项目ID。 alarm_id 是 告警规则的ID。 样例 GET https://{ 云监控 的endpoint}/V1.0/{project_id}/alarms/al1441967036681YkazZ0deN

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

请求示例 修改告警规则告警通知信息 { "notification_enabled" : true, "alarm_notifications" : [ { "type" : "", "notification_list" : [ ] } ], "ok_notifications" : [ { "type" : "", "notification_list" : [ ] } ], "notification_begin_time" : "00:00", "notification_end_time" : "23:59" }

响应示例 状态码： 200 修改告警规则告警通知信息成功 { "notification_enabled" : true, "alarm_notifications" : [ { "type" : "", "notification_list" : [ ] } ], "ok_notifications" : [ { "type" : "", "notification_list" : [ ] } ], "notification_begin_time" : "00:00", "notification_end_time" : "23:59" }

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 notification_enabled Boolean 是否开启告警通知 alarm_notifications Array of Notification objects 告警触发的动作 ok_notifications Array of Notification objects 告警恢复触发的动作 notification_begin_time String 告警通知开启时间 notification_end_time String 告警通知关闭时间 表6 Notification 参数 参数类型 描述 type String 通知类型, notification代表通过 SMN 通知 正则匹配：^(notification|autoscaling|ecsRecovery|contact|contactGroup|iecAction)$ notification_list Array of strings 告警状态发生变化时，被通知对象的列表。topicUrn可从SMN获取，具体操作请参考查询Topic列表。当type为notification时，notification_list列表不能为空。 说明：若alarm_action_enabled为true，对应的alarm_actions、ok_actions至少有一个不能为空。若alarm_actions、ok_actions同时存在时，notification_list值保持一致。 数组长度：0 - 20 状态码： 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

请求参数 表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_enabled 是 Boolean 是否开启告警通知，值为true时，其他字段均必选，值为false时，其他字段可不选 alarm_notifications 否 Array of Notification objects 告警触发的动作 ok_notifications 否 Array of Notification objects 告警恢复触发的动作 notification_begin_time 否 String 告警通知开启时间 notification_end_time 否 String 告警通知关闭时间 表4 Notification 参数 是否必选 参数类型 描述 type 是 String 通知类型, notification代表通过SMN通知 正则匹配：^(notification|autoscaling|ecsRecovery|contact|contactGroup|iecAction)$ notification_list 是 Array of strings 告警状态发生变化时，被通知对象的列表。topicUrn可从SMN获取，具体操作请参考查询Topic列表。当type为notification时，notification_list列表不能为空。 说明：若alarm_action_enabled为true，对应的alarm_actions、ok_actions至少有一个不能为空。若alarm_actions、ok_actions同时存在时，notification_list值保持一致。 数组长度：0 - 20

响应示例 状态码： 200 插件状态查询返回体 { "agent_status" : [ { "instance_id" : "111111111111", "uniagent_status" : "none", "extensions" : [ { "name" : "telescope", "status" : "none", "version" : "2.5.6" } ] } ] }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 agent_status Array of AgentStatusInfo objects agent插件状态列表 数组长度：1 - 2000 表5 AgentStatusInfo 参数 参数类型 描述 instance_id String 机器id 正则匹配：^[a-zA-Z0-9-]{1,64}$ uniagent_status String uniagent运行状态,none无，running运行中，silent静默中，unknown故障 枚举值： none running silent unknown extensions Array of ExtensionInfo objects 插件信息列表 数组长度：1 - 10 表6 ExtensionInfo 参数 参数类型 描述 name String 插件名称 最小长度：1 最大长度：64 status String 插件状态, none未安装，running运行中，stopped已停止，fault故障（进程异常），unknown故障（连接异常） 枚举值： none running stopped fault unknown version String 插件版本 最小长度：1 最大长度：32 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 正则匹配：^(ces\.[0-9]{4})$ error_msg String 错误信息 最小长度：1 最大长度：256 状态码： 401 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 正则匹配：^(ces\.[0-9]{4})$ error_msg String 错误信息 最小长度：1 最大长度：256 状态码： 403 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 正则匹配：^(ces\.[0-9]{4})$ error_msg String 错误信息 最小长度：1 最大长度：256 状态码： 500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 正则匹配：^(ces\.[0-9]{4})$ error_msg String 错误信息 最小长度：1 最大长度：256

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 发送的实体的MIME类型。默认使用application/json; charset=UTF-8。 缺省值：application/json; charset=UTF-8 最小长度：1 最大长度：64 X-Auth-Token 是 String 用户Token。用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 最小长度：1 最大长度：16384 表3 请求Body参数 参数 是否必选 参数类型 描述 instance_ids 是 Array of strings 机器实例id列表 数组长度：1 - 2000 uniagent_status 否 String uniagent运行状态，不传查所有状态,none无，running运行中，silent静默中，unknown故障 枚举值： none running silent unknown extension_name 否 String 插件名称，不传查所有插件，目前仅支持telescope 枚举值： telescope extension_status 否 String 插件状态，不传查所有状态, none未安装，running运行中，stopped已停止，fault故障（进程异常），unknown故障（连接异常） 枚举值： none running stopped fault unknown

响应示例 状态码： 200 OK [ { "widget_id" : "wg1234567890123456789012", "metrics" : [ { "namespace" : "SYS.E CS ", "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 表4 响应Body参数 参数 参数类型 描述 widgets Array of WidgetInfoWithId objects 监控视图列表 数组长度：0 - 50 表5 WidgetInfoWithId 参数 参数类型 描述 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 表6 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 指标信息 表7 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 表8 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 表9 properties 参数 参数类型 描述 filter String 聚合类型，目前只有TopN这一种类型，折线图不支持该参数 枚举值： topN topN Integer Top前N个；折线图时为随机展示的时序数据条数 最小值：1 最大值：2147483647 缺省值：100 order String 排序字段，asc正序，desc倒序，折线图不支持该参数 枚举值： asc desc 表10 location 参数 参数类型 描述 top Integer 监控视图的上坐标 最小值：0 最大值：2147483647 left Integer 监控视图的左坐标 最小值：0 最大值：9 width Integer 监控视图图表宽度 最小值：3 最大值：12 height Integer 监控视图图表高度 最小值：3 最大值：2147483647 状态码： 400 表11 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度：0 最大长度：256 error_msg String 请求异常信息 最小长度：0 最大长度：256 request_id String 请求ID 最小长度：0 最大长度：256 状态码： 401 表12 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度：0 最大长度：256 error_msg String 请求异常信息 最小长度：0 最大长度：256 request_id String 请求ID 最小长度：0 最大长度：256 状态码： 500 表13 响应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 缺省值：application/json;charset=UTF-8 最小长度：1 最大长度：64 X-Auth-Token 是 String 用户Token。用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 最小长度：1 最大长度：16000

URI GET /v2/{project_id}/dashboards/{dashboard_id}/widgets 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户id 最小长度：1 最大长度：64 dashboard_id 是 String 监控看板id，以db开头，包含22个字母和数字例：db16564943172807wjOmoLyn' 数组长度：24 - 24 正则匹配：^db([a-z]|[A-Z]|[0-9]){22}$ 表2 Query参数 参数 是否必选 参数类型 描述 group_id 否 String 视图所在的分组id 正则匹配：^dg([a-z]|[A-Z]|[0-9]){22}|default$

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

URI PUT /V1.0/{project_id}/alarm-template/{template_id} 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 项目ID。 获取方式请参见获取项目ID。 template_id 是 需要更新的自定义告警模板ID。 样例 PUT https://{云监控的endpoint}/V1.0/{project_id}/alarm-template/{template_id}

URI GET /V1.0/{project_id}/events 参数说明 表1 参数说明 名称 类型 是否必选 说明 project_id String 是 项目ID。 获取方式请参见获取项目ID。 event_type String 否 事件类型，值为EVENT.SYS或EVENT.CUSTOM。EVENT.SYS表示系统事件，EVENT.CUSTOM表示自定义事件。 event_name String 否 事件名称，值为系统产生的事件名称或用户自定义上报的事件名称。 from Integer 否 查询数据起始时间，UNIX时间戳，单位毫秒，例如：1605952700911。 to Integer 否 查询数据截止时间，UNIX时间戳，单位毫秒。from必须小于to，例如：1606557500911。 start Integer 否 分页起始值，类型为integer，默认值为0。 limit Integer 否 单次查询的条数限制,取值范围(0,100]，默认值为100，用于限制结果数据条数。 样例 GET https://{云监控的endpoint}/V1.0/{project_id}/events

响应消息 响应参数 表2 参数说明 名称 类型 是否必选 描述 events Array of Events objects 否 一条或者多条事件数据。 详细参数说明请参见表3。 meta_data MetaData object 否 查询结果元数据统计个数。 详细参数说明请参见表4。 表3 events字段数据结构说明 名称 类型 是否必选 描述 event_name String 否 事件名称。 event_type String 否 事件类型。 event_count Integer 否 选择查询的时间范围内，此事件发生的数量。 latest_occur_time Long 否 此事件最近一次发生的时间。 latest_event_source String 否 事件来源，如果是系统事件则值为各服务的命名空间，可查看支持监控的服务列表。 如果是自定义事件,则为用户自定义上报定义。 表4 meta_data字段数据结构说明 名称 类型 是否必选 描述 total Integer 否 事件总条数。

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

响应示例 状态码： 200 OK { "dashboards" : [ { "dashboard_id" : "dbxxxxxxxxxxxxxxxxxxxxxx", "dashboard_name" : "dashboard_name", "enterprise_id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "creator_name" : "creator_name", "create_time" : 1111111111111, "row_widget_num" : 3, "is_favorite" : false } ] }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 dashboards Array of DashBoardInfo objects 监控看板列表 数组长度：0 - 10 表5 DashBoardInfo 参数 参数类型 描述 dashboard_id String 监控看板id 正则匹配：^db([a-z]|[A-Z]|[0-9]){22} 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)$ creator_name String 监控看板的创建用户名 最小长度：1 最大长度：128 正则匹配：^([\u4E00-\u9FFF]|[a-z]|[A-Z]|[0-9]|_|-)+$ create_time Long 监控看板创建时间 最小值：1111111111111 最大值：9999999999999 row_widget_num Integer 监控视图展示模式，0表示自定义坐标，1代表每行一个 最小值：0 最大值：3 缺省值：3 is_favorite Boolean 监控看板是否标记收藏, true: 收藏, false: 未收藏 状态码： 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

URI GET /v2/{project_id}/dashboards 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户id 最小长度：1 最大长度：64 表2 Query参数 参数 是否必选 参数类型 描述 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|all_granted_eps)$ is_favorite 否 Boolean 指定企业项目下监控看板是否收藏，true:收藏，false:未收藏，填此参数时，enterprise_id必填 dashboard_name 否 String 监控看板名称 最小长度：1 最大长度：128 正则匹配：^([\u4E00-\u9FFF]|[a-z]|[A-Z]|[0-9]|_|-)+$ dashboard_id 否 String 监控看板id 正则匹配：^db([a-z]|[A-Z]|[0-9]){22}

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

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

请求参数 表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}/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 系统暂时不可用，请求受限。