CLI命令参考(V1)
告警规则管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询单条告警规则信息 | hcloud CES ShowAlarm/v1 | 根据告警ID查询告警规则信息。告警规则V1接口只支持配置单资源单策略规则,建议使用“查询告警规则列表(推荐)”、“查询告警规则资源列表”与前端功能配套使用。 | |
| 删除告警规则 | hcloud CES DeleteAlarm/v1 | 删除一条告警规则。 | |
| 修改告警规则 | hcloud CES UpdateAlarm/v1 | 修改告警规则。 | |
| 启停告警规则 | hcloud CES UpdateAlarmAction/v1 | 启动或停止一条告警规则。 | |
| 查询告警规则列表(V1) | hcloud CES ListAlarms/v1 | 查询告警规则列表,可以指定分页条件限制结果数量,可以指定排序规则。如果用本接口去查询多资源多策略的告警规则,也只能返回告警规则的某个策略,建议使用“查询告警规则列表(推荐)”与前端功能配套使用。 | |
| 创建告警规则(V1) | hcloud CES CreateAlarm/v1 | 创建一条告警规则。创建告警规则V1接口只支持配置单资源单策略规则,建议使用“创建告警规则(推荐)”与前端功能配套使用。 | |
| 查询告警历史 | hcloud CES ListAlarmHistories/v1 | 查询告警历史列表。 |
告警模板
事件监控
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 上报事件 | hcloud CES CreateEvents/v1 | 上报自定义事件。事件的time、project_id、event_source、event_name、event_type、sub_event_type、event_state、event_level、event_user、resource_id、resource_name字段相同时,则视为同一条事件。 | |
| 查询事件监控列表 | hcloud CES ListEvents/v1 | 查询事件监控列表,包括系统事件和自定义事件。 | |
| 查询某一事件监控详情 | hcloud CES ListEventDetail/v1 | 根据事件监控名称,查询该事件发生的详细信息。 |
指标管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询指标列表 | hcloud CES ListMetrics/v1 | 查询系统当前可监控指标列表,可以指定指标命名空间、指标名称、维度、排序方式,起始记录和最大记录条数过滤查询结果。 |
监控数据管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 批量查询监控数据 | hcloud CES BatchListMetricData/v1 | 批量查询指定时间范围内指定指标的指定粒度的监控数据,目前最多支持500指标的批量查询。 对于不同的period取值和查询的指标数量,默认的最大查询区间(to-from)不同。 规则为“指标数量*(to-from)/监控周期<=3000”,若超出阈值,会自动调整from以满足规则。 | |
| 查询主机配置数据 | hcloud CES ShowEventData/v1 | 查询指定时间范围指定事件类型的主机配置数据,可以通过参数指定需要查询的数据维度。注意:该接口提供给HANA场景下SAP Monitor查询主机配置数据,其他场景下查不到主机配置数据。 | |
| 查询监控数据 | hcloud CES ShowMetricData/v1 | 查询指定时间范围指定指标的指定粒度的监控数据,可以通过参数指定需要查询的数据维度。 | |
| 添加监控数据 | hcloud CES CreateMetricData/v1 | 添加一条或多条指标监控数据。 |
配额管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询配额 | hcloud CES ShowQuotas/v1 | 查询用户可以创建的资源配额总数及当前使用量,当前仅有告警规则一种资源类型。 |
资源分组管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询资源分组下的资源 | hcloud CES ShowResourceGroup/v1 | 根据资源分组ID查询资源分组下的资源。此接口已过时,建议使用v2接口 “查询资源分组下指定服务类别特定维度的资源列表” | |
| 更新资源分组 | hcloud CES UpdateResourceGroup/v1 | 更新资源分组,资源分组支持将各类资源按照业务集中进行分组管理,可以从分组角度查看监控与告警信息,以提升运维效率。 | |
| 删除资源分组 | hcloud CES DeleteResourceGroup/v1 | 删除一条资源分组。 | |
| 创建资源分组 | hcloud CES CreateResourceGroup/v1 | 创建资源分组,资源分组支持将各类资源按照业务集中进行分组管理,可以从分组角度查看监控与告警信息,以提升运维效率。 | |
| 查询所有资源分组 | hcloud CES ListResourceGroup/v1 | 查询所创建的所有资源分组。 |