华为云用户手册

到期后影响 图2描述了包年/包月DEW资源各个阶段的状态。购买后，在计费周期内资源正常运行，此阶段为有效期；资源到期而未续费时，将陆续进入宽限期和保留期。 图2 包年/包月DEW资源生命周期 到期预警 包年/包月DEW资源在到期前第7天内，系统将向用户推送到期预警消息。预警消息将通过邮件、短信和站内信的方式通知到华为云账号的创建者。 到期后影响 当您的包年/包月DEW资源到期未续费，首先会进入宽限期，资源状态变为“已过期”。宽限期内您可以正常访专属加密实例 如果您在宽限期内仍未续费包年/包月DEW资源，那么就会进入保留期，资源状态变为“已冻结”，您将无法对处于保留期的包年/包月资源执行任何操作。 保留期到期后，如果包年/包月DEW资源仍未续费，那专属加密实例资源将被释放，数据无法恢复。 华为云根据客户等级定义了不同客户的宽限期和保留期时长。 关于续费的详细介绍请参见续费概述。

通过企业项目进行成本管理 开通企业项目。 只有实名认证为企业的客户才可以开通企业项目，详细步骤请参见如何开通企业项目。 创建企业项目。 您可以根据部门或者业务，创建对应的企业项目，详细步骤请参见创建企业项目。 购买 数据加密 服务时选择企业项目。 在购买数据加密服务页面，您可以选择已启用的企业项目，新购数据加密服务将按此企业项目进行成本分配。 图1 选择企业项目 通过企业项目维度查看成本分析。 通过企业项目查看成本数据时，建议基于摊销成本进行数据汇总，详细步骤请参见通过企业项目维度查看成本分配。

通过标签进行成本管理 创建预定义标签。 客户在“标签管理服务”控制台中创建预定义标签，详细操作请参见创建预定义标签。 激活成本标签。 激活标签的具体操作请参见激活成本标签。激活成本标签后，才能在“成本分析”、“预算管理”等页面展现。 成本标签不会应用于激活标签之前产生的成本。激活前已产生的成本数据，如果仍需要基于标签分析，可以导出账单明细，基于账单明细中的资源标签字段进行处理分析。 为DEW资源添加标签。 在购买数据加密服务页面，可以选择已经创建的预定义标签。 图2 添加标签 通过成本标签查看成本数据。 通过成本标签查看成本数据时，建议基于摊销成本进行数据汇总，详细操作请参见通过成本标签查看成本数据。

成本优化 成本控制 企业可以在成本中心的“预算管理”页面创建精细粒度的预算来管理成本和使用量，在实际或预测超过预算阈值时，自动发送通知给指定消息接收人。企业还可以创建预算报告，定期将指定预算进展通知给指定消息接收人。 例如企业使用密钥管理服务成本预算，每月预算金额为10000元，当预测金额高于预算金额的80%时发送预算告警。创建的预算如下： 图3 预算基本信息 图4 设置成本范围 图5 设置提醒 详细介绍请参见使用预测和预算来跟踪成本和使用量。 资源优化 成本中心可以通过监控 云防火墙 的历史消费情况，为客户提供云防火墙资源的空闲识别和优化建议，寻找节约成本的机会。您还可以根据成本分析阶段的分析结果识别成本偏高的资源，通过 云监控服务 监控资源的使用情况，确定成本偏高的原因，然后采取针对性的优化措施。

错误码说明 当您调用API时，如果遇到“APIGW”开头的错误码，请参见API网关错误码进行处理。 模块 http状态码 错误码 错误码说明 Error Message 描述（处理措施） Cloud Eye通用 500 ces.0007 内部错误 Internal service error. 联系技术支持人员 API 400 ces.0001 请求内容不能为空 The content must be specified. 增加正确的请求内容 400 ces.0003 项目ID为空或不正确 The tenant ID is left blank or incorrect. 添加或使用正确的项目ID 400 ces.0004 未指定API版本号 The API version must be specified. 在请求URL中增加API版本号 400 ces.0005 API版本不正确 The API version is incorrect. 使用正确的API版本号 400 ces.0006 分页地址不正确 The paging address is incorrect. 使用正确的分页信息 403 ces.0009 不允许添加系统指标 Adding SYS metric is not allowed 使用正确权限添加指标数据 403 ces.0010 不允许删除系统指标 Deleting SYS metric is not allowed 使用正确权限删除指标信息 400 ces.0011 请求无效 The request is invalid. 检查请求信息 400 ces.0013 无效的URL参数或参数不存在 The URL parameter is invalid or does not exist. 检查URL参数 400 ces.0014 请求体错误 Some content in message body is not correct. 检查请求Body体参数 401 ces.0015 鉴权失败或未提供有效鉴权信息 Authentication fails or the authentication information is not provided. 检查获取token的用户名或密码（或AK、SK）是否正确 404 ces.0016 请求的资源不存在 The requested resource does not exist. 确认所请求资源是否存在 403 ces.0017 鉴权信息错误或者无相应权限 The authentication information is incorrect or the service invoker does not have sufficient rights. 检查获取token的用户名或密码（或AK、SK）的信息、权限是否正确 数据库 500 ces.0008 数据库错误 Database error. 联系技术支持人员 Zookeeper 500 ces.0021 内部锁错误 Internal locking error. 联系技术支持人员 Blueflood 500 ces.0019 指标处理引擎异常 The metric processing engine is abnormal. 联系技术支持人员 Alarm 400 ces.0002 告警ID不能为空 The alarm ID must be specified. 添加正确的Alarm ID信息 403 ces.0018 Alarm配额不足 The number of alarms exceeds the quota 申请更多的Alarm配额 400 ces.0028 创建告警规则时指标和通知类型不匹配 The metric does not support the alarm action type. 根据参数说明修改指标或通知类型，使二者匹配

请求示例 { "one_click_alarm_id" : "o1234567890123456789012", "dimension_names" : { "metric" : [ "disk", "instance_id" ], "event" : [ "resource_id" ] }, "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"}

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

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

响应参数 状态码： 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 主机类型，E CS 弹性云服务器，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

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

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 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" } ]}

概述 欢迎使用 云监控 服务（Cloud Eye）。云监控为用户提供一个针对弹性云服务器、带宽等资源的立体化监控平台。使您全面了解云上的资源使用情况、业务的运行状况，并及时收到异常告警做出反应，保证业务顺畅运行。 您可以使用本文档提供的API对指标、告警规则、监控数据进行相关操作，如查询指标列表、查询告警规则列表、创建告警规则、删除告警规则等。支持的全部操作请参见API概览。 在调用云监控服务API之前，请确保已经充分了解云监控服务相关概念，详细信息请参见“产品介绍”。 父主题： 使用前必读

基本概念 账号 用户注册时的账号，账号对其所拥有的资源及云服务具有完全的访问权限，可以重置用户密码、分配用户权限等。由于账号是付费主体，为了确保账号安全，建议您不要直接使用账号进行日常管理工作，而是创建用户并使用用户进行日常管理工作。 用户 由账号在 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的获取及企业项目特性的详细信息，请参见《企业管理用户指南》。 父主题： 使用前必读

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

URI DELETE /V1.0/{project_id}/alarms/{alarm_id} 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 项目ID。 获取方式请参见获取项目ID。 alarm_id 是 告警规则的ID。 样例 DELETE https://{云监控的endpoint}/V1.0/{project_id}/alarms/al1441967036681YkazZ0deN

响应消息 响应参数 表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": "" } ]}

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

响应消息 响应参数 表3 响应参数 名称 参数类型 说明 metrics Array of objects 指标对象列表。 详细参数请参见表4。 meta_data Object 查询结果元数据信息，包括分页信息等。 详细参数请参见表6。 表4 metrics字段数据结构说明 名称 参数类型 说明 namespace String 指标所属命名空间。 dimensions Array of objects 指标维度列表。 详细参数请参见表5。 metric_name String 指标名称，如cpu_util。 unit String 指标单位。 表5 dimensions字段数据结构说明 名称 参数类型 说明 name String 监控维度名称，例如弹性云服务器的维度为instance_id。各服务维度请参考支持监控的服务列表，可参考维度中key字段。 value String 维度取值，例如弹性云服务器的ID。 长度最短为1，最大为256。 表6 meta_data字段数据结构说明 名称 参数类型 说明 count Integer 当前返回结果条数。 marker String 下一个开始的标记，用于分页。 如本次查询10条数据，第十条为cpu_util，下次start配置为cpu_util可从该指标开始查询。 total Integer 指标总条数。 响应样例 { "metrics": [ { "namespace": "SYS.ECS", "dimensions": [ { "name": "instance_id", "value": "d9112af5-6913-4f3b-bd0a-3f96711e004d" } ], "metric_name": "cpu_util", "unit": "%" } ], "meta_data": { "count": 1, "marker": "SYS.ECS.cpu_util.instance_id:d9112af5-6913-4f3b-bd0a-3f96711e004d", "total": 7 }}

返回值 正常 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}/metrics 参数说明 表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 指标ID，例如弹性云服务器的监控指标CPU使用率，对应的metric_name为cpu_util。各服务监控指标请参考支持监控的服务列表。 字符格式必须以字母开头，只能包含0-9/a-z/A-Z/_-，字符长度最短为1，最大为96。 dim 否 String 监控维度，例如弹性云服务器的维度为instance_id。各服务维度请参考支持监控的服务列表。 目前最大支持3个维度，必须从0开始；维度格式为dim.{i}=key,value，key的最大长度32，value的最大长度为256。 单维度：dim.0=instance_id,6f3c6f91-4b24-4e1b-b7d1-a94ac1cb011d 多维度：dim.0=key,value&dim.1=key,value start 否 String 分页起始值，格式为：namespace.metric_name.key:value 例如：start=SYS.ECS.cpu_util.instance_id:d9112af5-6913-4f3b-bd0a-3f96711e004d limit 否 Integer 取值范围(0,1000]，默认值为1000。 用于限制结果数据条数。 order 否 String 用于标识结果排序方法，按时间戳排序。 取值说明，默认为desc： asc，升序 desc，降序 请求样例 请求样例一：查询当前可监控所有指标列表。 GET https://{云监控的终端节点}/V1.0/{project_id}/metrics 请求样例二：查询弹性云服务器ID为6f3c6f91-4b24-4e1b-b7d1-a94ac1cb011d的监控指标CPU使用率，结果按时间戳降序保留10条数据。 GET https://{云监控的终端节点}/V1.0/{project_id}/metrics?namespace=SYS.ECS&metric_name=cpu_util&dim.0=instance_id,6f3c6f91-4b24-4e1b-b7d1-a94ac1cb011d&limit=10&order=desc

调用说明 云监控服务提供了REST（Representational State Transfer）风格API，支持您通过HTTPS请求调用，调用方法请参见如何调用API。 同时云监控服务还提供多种编程语言的SDK供您使用，SDK的使用方法请参见https://console.huaweicloud.com/apiexplorer/#/sdkcenter/ CES ?lang=Java。 父主题： 使用前必读

返回值 正常 201 异常 返回值 说明 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 系统暂时不可用，请求受限。

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 响应参数 名称 参数类型 说明 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": "" } }

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