CLI命令参考
告警
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 获取告警发送结果 | hcloud AOM ListNotifiedHistories | 获取告警发送结果。 | |
| 删除静默规则 | hcloud AOM DeleteMuteRules | 删除静默规则。 | |
| 新增静默规则 | hcloud AOM AddMuteRules | 新增静默规则。 | |
| 修改静默规则 | hcloud AOM UpdateMuteRule | 修改静默规则。 | |
| 获取静默规则列表 | hcloud AOM ListMuteRule | 获取静默规则列表。 | |
| 通过规则名称获取告警行动规则 | hcloud AOM ShowActionRule | 通过规则名称获取告警行动规则。 | |
| 新增告警行动规则 | hcloud AOM AddActionRule | 新增告警行动规则。 | |
| 删除告警行动规则 | hcloud AOM DeleteActionRule | 删除告警行动规则。 | |
| 修改告警行动规则 | hcloud AOM UpdateActionRule | 修改告警行动规则。 | |
| 获取告警行动规则列表 | hcloud AOM ListActionRule | 获取告警行动规则列表。 | |
| 查询事件类告警规则列表 | hcloud AOM ListEvent2alarmRule | 查询事件类告警规则列表。 | |
| 新增一条事件类告警规则 | hcloud AOM AddEvent2alarmRule | 新增一条事件类告警规则。 | |
| 更新事件类告警规则 | hcloud AOM UpdateEventRule | 更新事件类告警规则。 | |
| 删除事件类告警规则 | hcloud AOM DeleteEvent2alarmRule | 删除一条事件类告警规则。 | |
| 查询指标类或者事件类告警规则列表 | hcloud AOM ListMetricOrEventAlarmRule | 查询AOM2.0指标类或者事件类告警规则列表。 | |
| 添加或修改指标类或事件类告警规则 | hcloud AOM AddOrUpdateMetricOrEventAlarmRule | 添加或修改AOM2.0指标类或事件类告警规则。 | |
| 删除指标类或事件类告警规则 | hcloud AOM DeleteMetricOrEventAlarmRule | 删除AOM2.0指标类或事件类告警规则。 | |
| 批量更新Prometheus监控告警规则 | hcloud AOM BatchUpdateAlarmRule | 该接口用于批量启停Prometheus监控告警规则、批量修改Prometheus监控告警规则的告警行动规则。 | |
| 查询消息通知模板列表 | hcloud AOM ListNotificationTemplates | 该接口用于查询消息通知模板列表。 | |
| 删除消息通知模板 | hcloud AOM DeleteNotificationTemplate | 该接口用于删除消息通知模板。 | |
| 新增消息通知模板 | hcloud AOM CreateNotificationTemplate | 该接口用于新增消息通知模板。 | |
| 修改消息通知模板 | hcloud AOM UpdateNotificationTemplate | 该接口用于修改消息通知模板。 | |
| 根据消息通知模板名称查询消息通知模板 | hcloud AOM ListNotificationTemplateByName | 该接口用于根据消息通知模板名称查询消息通知模板。 | |
| 删除告警模板 | hcloud AOM DeleteAlarmRuleTemplate | 该接口用于删除告警模板。 | |
| 查询告警模板列表 | hcloud AOM ListAlarmRuleTemplate | 该接口用于查询告警模板列表。 | |
| 查询事件告警信息 | hcloud AOM ListEvents | 该接口用于查询对应用户的事件、告警。 | |
| 统计事件告警信息 | hcloud AOM CountEvents | 该接口用于分段统计指定条件下的事件、告警。 | |
| 上报事件或告警信息 | hcloud AOM PushEvents | 该接口用于上报事件或告警至AOM，同时支持清除告警信息。 |
监控
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询时间序列 | hcloud AOM ListSeries | 该接口用于查询系统当前可监控的时间序列列表，可以指定时间序列命名空间、名称、维度、所属资源的编号（格式为：resType_resId），分页查询的起始位置和返回的最大记录条数。 | |
| 查询时序数据 | hcloud AOM ListSample | 该接口用于查询指定时间范围内的监控时序数据，可以通过参数指定需要查询的数据维度，数据周期等。 | |
| 查询指标 | hcloud AOM ListMetricItems | 该接口用于查询系统当前可监控的指标列表，可以指定指标命名空间、指标名称、维度、所属资源的编号（格式为：resType_resId），分页查询的起始位置和返回的最大记录条数。 | |
| 查询监控数据 | hcloud AOM ShowMetricsData | 该接口用于查询指定时间范围内指标的监控数据，可以通过参数指定需要查询的数据维度，数据周期等。 | |
| 添加监控数据 | hcloud AOM AddMetricData | 该接口用于向服务端添加一条或多条监控数据。 | |
| 添加或修改服务发现规则 | hcloud AOM AddOrUpdateServiceDiscoveryRules | 该接口用于添加或修改一条或多条服务发现规则。同一projectid下可添加的规则上限为100条。 | |
| 删除服务发现规则 | hcloud AOM DeleteserviceDiscoveryRules | 该接口用于删除服务发现规则。 | |
| 查询系统中已有服务发现规则 | hcloud AOM ListServiceDiscoveryRules | 该接口用于查询系统当前已存在的服务发现规则。 | |
| 添加阈值规则 | hcloud AOM AddAlarmRule | 该接口用于添加一条阈值规则。 | |
| 查询阈值规则列表 | hcloud AOM ListAlarmRule | 该接口用于查询阈值规则列表。 | |
| 修改阈值规则 | hcloud AOM UpdateAlarmRule | 该接口用于修改一条阈值规则。 | |
| 删除阈值规则 | hcloud AOM DeleteAlarmRule | 该接口用于删除阈值规则。 | |
| 查询单条阈值规则 | hcloud AOM ShowAlarmRule | 该接口用于查询单条阈值规则。 | |
| 批量删除阈值规则 | hcloud AOM DeleteAlarmRules | 该接口用于批量删除阈值规则。 |
Prometheus监控
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| GET方法查询区间数据 | hcloud AOM ListRangeQueryAomPromGet | 该接口使用GET方法查询PromQL(Prometheus Query Language)在一段时间范围内的计算结果。 | |
| （推荐）POST方法查询区间数据 | hcloud AOM ListRangeQueryAomPromPost | 该接口使用POST方法查询PromQL(Prometheus Query Language)在一段时间范围内的计算结果。 | |
| GET方法查询瞬时数据 | hcloud AOM ListInstantQueryAomPromGet | 该接口使用GET方法查询PromQL(Prometheus Query Language)在特定时间点下的计算结果。 | |
| （推荐）POST方法查询瞬时数据 | hcloud AOM ListInstantQueryAomPromPost | 该接口使用POST方法查询PromQL(Prometheus Query Language)在特定时间点下的计算结果。 | |
| 查询标签值 | hcloud AOM ListLabelValuesAomPromGet | 该接口用于查询带有指定标签的时间序列列表。 | |
| GET方法获取标签名列表 | hcloud AOM ListLabelsAomPromGet | 该接口使用GET方法获取标签名列表。 | |
| （推荐）POST方法获取标签名列表 | hcloud AOM ListLabelsAomPromPost | 该接口使用POST方法获取标签名列表。 | |
| 元数据查询 | hcloud AOM ListMetadataAomPromGet | 该接口用于查询序列及序列标签的元数据。 |
日志
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询日志 | hcloud AOM ListLogItems | 该接口用于查询不同维度(例如集群、IP、应用等)下的日志内容，支持分页查询。 |
Prometheus实例
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 卸载托管Prometheus实例 | hcloud AOM DeletePromInstance | 该接口用于卸载托管Prometheus实例。 | |
| 查询Prometheus实例 | hcloud AOM ListPromInstance | 该接口用于查询Prometheus实例。 | |
| 新增Prometheus实例 | hcloud AOM CreatePromInstance | 该接口用于新增Prometheus实例。 | |
| 修改Prometheus实例 | hcloud AOM UpdatePromInstance | 该接口用于修改Prometheus实例。 | |
| 创建Prometheus实例的预聚合规则 | hcloud AOM CreateRecordingRule | 该接口用于给Prometheus实例创建预聚合规则。 | |
| 获取Prometheus实例调用凭证 | hcloud AOM ListAccessCode | 该接口用于获取Prometheus实例调用凭证。 |
配置管理
仪表盘
应用资源管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 新增应用 | hcloud AOM CreateApp | 该接口用于新增应用。 | |
| 根据应用名称查询应用详情 | hcloud AOM ShowAppByName | 该接口用于查询应用详情。 | |
| 删除应用 | hcloud AOM DeleteApp | 该接口用于删除应用。 | |
| 查询应用详情 | hcloud AOM ShowApp | 该接口用于查询应用详情。 | |
| 修改应用 | hcloud AOM UpdateApp | 该接口用于修改应用。 | |
| 新增组件 | hcloud AOM CreateComponent | 该接口用于新增组件。 | |
| 删除组件 | hcloud AOM DeleteComponent | 该接口用于删除组件。 | |
| 查询组件详情 | hcloud AOM ShowComponent | 该接口用于查询组件详情。 | |
| 修改组件 | hcloud AOM UpdateComponent | 该接口用于修改组件。 | |
| 创建环境 | hcloud AOM CreateEnv | 该接口用于创建环境。 | |
| 删除环境 | hcloud AOM DeleteEnv | 该接口用于删除环境。 | |
| 查询环境详情 | hcloud AOM ShowEnv | 该接口用于查询环境详情。 | |
| 修改环境 | hcloud AOM UpdateEnv | 该接口用于修改环境。 | |
| 查询绑定在节点上的资源列表 | hcloud AOM ListResourceUnderNode | 该接口用于查询绑定在节点上的资源列表。 | |
| 根据组件名称查询组件详情 | hcloud AOM ShowComponentByName | 该接口用于查询组件详情。 | |
| 根据环境名称查询环境详情 | hcloud AOM ShowEnvByName | 该接口用于查询环境详情。 | |
| 新增子应用 | hcloud AOM CreateSubApp | 该接口用于新增子应用。 | |
| 删除子应用 | hcloud AOM DeleteSubApp | 该接口用于删除子应用。 | |
| 修改子应用 | hcloud AOM UpdateSubApp | 该接口用于修改子应用。 |
自动化运维
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 创建任务 | hcloud AOM CreateWorkflow | 该接口用于创建工作流（任务），返回工作流详情。任务类型取决于模板名称和'input'参数。（注：接口目前开放的region为：华北-北京四,华东-上海一,华东-上海二,华南-广州）。 | |
| 更新任务 | hcloud AOM UpdateWorkflowTriggerStatus | 更新定时任务的启停状态，可启动定时任务或停止定时任务，返回操作任务结果。（注：接口目前开放的region为：华北-北京四,华东-上海一,华东-上海二,华南-广州）。 | |
| 对暂停中的任务进行操作 | hcloud AOM StartPausingWorkflowExecutions | 该接口可对任务进行失败重试、失败跳过、暂停继续操作，返回操作结果。（注：接口目前开放的region为：华北-北京四,华东-上海一,华东-上海二,华南-广州）。 | |
| 获取工作流执行中的执行详情 | hcloud AOM SearchWorkflowExecutionDetail | 该接口可获取任务的执行详情，可指定工作流ID和执行ID去查询对应的任务，返回任务执行详情。（注：接口目前开放的region为：华北-北京四,华东-上海一,华东-上海二,华南-广州）。 | |
| 终止任务执行 | hcloud AOM StopExecution | 该接口可终止正在执行的任务，指定工作流ID和执行ID去终止对应的任务，返回终止操作状态。（注：接口目前开放的region为：华北-北京四,华东-上海一,华东-上海二,华南-广州）。 | |
| 脚本查询 | hcloud AOM ListAllScriptByName | 该接口是脚本主页查询，可指定脚本名称和脚本创建人进行精确查询，返回包含脚本基本信息的列表数据。（注：接口目前开放的region为：华北-北京四,华东-上海一,华东-上海二,华南-广州）。 | |
| 脚本版本查询 | hcloud AOM ListAllVersionByVersionId | 该接口可查询指定脚本ID下的所有版本，返回该名称的脚本版本列表信息。（注：接口目前开放的region为：华北-北京四,华东-上海一,华东-上海二,华南-广州）。 | |
| 作业管理主页模糊查询 | hcloud AOM ListAllJobByName | 该接口可查询已创建的作业，可指定作业名称和作业创建人去精确查询，返回作业列表信息。（注：接口目前开放的region为：华北-北京四,华东-上海一,华东-上海二,华南-广州）。 | |
| 根据作业id查询方案(自定义模板)列表 | hcloud AOM ListTemplateByJobId | 该接口可根据作业ID查询执行方案，分页返回执行方案列表。（注：接口目前开放的region为：华北-北京四,华东-上海一,华东-上海二,华南-广州）。 | |
| 获取方案信息 | hcloud AOM SearchTemplateById | 该接口可根据执行方案id查询执行方案详情。（注：接口目前开放的region为：华北-北京四,华东-上海一,华东-上海二,华南-广州）。 | |
| 查询任务列表 | hcloud AOM ListWorkflow | 该接口可返回已经创建的任务列表，可按任务名称，任务状态，任务类型，执行人，更新时间为查询条件分页查询任务。（注：接口目前开放的region为：华北-北京四,华东-上海一,华东-上海二,华南-广州）。 | |
| 获取任务执行历史 | hcloud AOM ListWorkflowExecutions | 该接口可获取执行任务的执行历史。（注：接口目前开放的region为：华北-北京四,华东-上海一,华东-上海二,华南-广州）。 | |
| 执行工作流 | hcloud AOM ExecuteWorkflow | 该接口可下发执行指定的任务。（注：接口目前开放的region为：华北-北京四,华东-上海一,华东-上海二,华南-广州）。 |
