CLI命令参考
伸缩活动日志管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询伸缩活动日志 | hcloud AS ListScalingActivityLogs | 根据输入条件过滤查询伸缩活动日志。查询结果分页显示。
| |
| 查询伸缩活动日志v2版本 | hcloud AS ListScalingActivityV2Logs | 根据输入条件过滤查询伸缩活动日志，支持查询实例伸缩、ELB迁移、实例备用等类型活动。查询结果分页显示。
|
伸缩策略日志管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询策略执行日志 | hcloud AS ListScalingPolicyExecuteLogs | 根据输入条件过滤查询策略执行的历史记录。查询结果分页显示。
|
弹性伸缩API管理
弹性伸缩实例管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询弹性伸缩组中的实例列表 | hcloud AS ListScalingInstances | 根据输入条件过滤查询弹性伸缩组中实例信息。查询结果分页显示。
| |
| 移出弹性伸缩组实例 | hcloud AS DeleteScalingInstance | 从弹性伸缩组中移出一个指定实例。
| |
| 批量添加实例 | hcloud AS BatchAddScalingInstances | 批量添加伸缩组外的实例。 | |
| 批量移除实例 | hcloud AS BatchRemoveScalingInstances | 批量移出伸缩组中的实例。 | |
| 批量设置实例保护 | hcloud AS BatchProtectScalingInstances | 批量对伸缩组中的实例设置实例保护属性。 | |
| 批量取消实例保护 | hcloud AS BatchUnprotectScalingInstances | 批量对伸缩组中的实例取消其实例保护属性。 | |
| 批量将实例转为备用状态 | hcloud AS BatchSetScalingInstancesStandby | 批量将伸缩组中的实例转入备用状态。 | |
| 批量将实例移出备用状态 | hcloud AS BatchUnsetScalingInstancesStantby | 批量将伸缩组中的实例移出备用状态。 |
弹性伸缩策略管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 创建弹性伸缩策略 | hcloud AS CreateScalingPolicy | 创建弹性伸缩策略。
| |
| 查询弹性伸缩策略详情 | hcloud AS ShowScalingPolicy | 查询指定弹性伸缩策略信息。 | |
| 修改弹性伸缩策略 | hcloud AS UpdateScalingPolicy | 修改指定弹性伸缩策略。 | |
| 删除弹性伸缩策略 | hcloud AS DeleteScalingPolicy | 删除一个指定弹性伸缩策略。 | |
| 查询弹性伸缩策略列表 | hcloud AS ListScalingPolicies | 根据输入条件过滤查询弹性伸缩策略。查询结果分页显示。可根据伸缩策略名称，策略类型，伸缩策略ID，起始行号，记录数进行条件过滤查询。若不加过滤条件默认查询租户下指定伸缩组内最多20条伸缩策略信息。 | |
| 批量删除弹性伸缩策略 | hcloud AS BatchDeleteScalingPolicies | 批量删除弹性伸缩策略。单次最多批量操作伸缩策略个数为20。 | |
| 批量停用弹性伸缩策略 | hcloud AS BatchPauseScalingPolicies | 批量停用弹性伸缩策略。单次最多批量操作伸缩策略个数为20。 | |
| 批量启用弹性伸缩策略 | hcloud AS BatchResumeScalingPolicies | 批量启用弹性伸缩策略。单次最多批量操作伸缩策略个数为20。 | |
| 执行弹性伸缩策略 | hcloud AS ExecuteScalingPolicy | 立即执行一个指定弹性伸缩策略。当伸缩组、伸缩策略状态处于INSERVICE时，伸缩策略才能被正确执行，否则会执行失败。 | |
| 启用弹性伸缩策略 | hcloud AS ResumeScalingPolicy | 立即启用一个指定弹性伸缩策略。当伸缩组、伸缩策略状态处于INSERVICE时，伸缩策略才能被正确执行，否则会执行失败。 | |
| 停止弹性伸缩策略 | hcloud AS PauseScalingPolicy | 立即停止一个指定弹性伸缩策略。当伸缩组、伸缩策略状态处于INSERVICE时，伸缩策略才能被正确执行，否则会执行失败。 |
弹性伸缩策略管理V2
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询弹性伸缩策略全量列表（V2版本） | hcloud AS ListAllScalingV2Policies | 根据输入条件过滤查询弹性伸缩策略，支持查询当前租户下全量伸缩策略。查询结果分页显示。 可根据伸缩资源ID，伸缩资源类型，伸缩策略名称，伸缩策略ID，告警ID，企业项目ID，起始行号，记录数，排序方式等条件进行过滤查询。 若不加过滤条件默认查询该租户下最多20条伸缩策略信息。 | |
| 创建弹性伸缩策略（V2版本） | hcloud AS CreateScalingV2Policy | 可针对不同类型资源如伸缩组或带宽，创建弹性伸缩策略。创建弹性伸缩策略V2版本与V1版本的区别在于，V2版本支持创建对带宽资源进行调整的策略，通过伸缩资源类型区分伸缩资源。 | |
| 查询指定弹性伸缩策略详情（V2版本） | hcloud AS ShowScalingV2Policy | 查询指定弹性伸缩策略信息。 | |
| 修改弹性伸缩策略（V2版本） | hcloud AS UpdateScalingV2Policy | 修改指定弹性伸缩策略。修改弹性伸缩策略V2版本与V1版本的区别在于，V2版本支持修改伸缩资源类型。 | |
| 查询弹性伸缩策略列表（V2版本） | hcloud AS ListScalingV2Policies | 根据输入条件过滤查询弹性伸缩策略。查询结果分页显示。查询弹性伸缩策略V2版本与V1版本的区别在于，V2版本响应含伸缩资源类型。可根据伸缩策略名称，策略类型，伸缩策略ID，起始行号，记录数进行条件过滤查询。若不加过滤条件默认查询该租户下指定资源下最多20条伸缩策略信息。 |
弹性伸缩组管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询弹性伸缩组列表 | hcloud AS ListScalingGroups | 根据输入条件过滤查询弹性伸缩组列表。查询结果分页显示。可根据伸缩组名称，伸缩配置ID，伸缩组状态，企业项目ID，起始行号，记录条数进行条件过滤查询。若不加过滤条件默认最多查询租户下20条伸缩组信息。 | |
| 创建弹性伸缩组 | hcloud AS CreateScalingGroup | 伸缩组是具有相同应用场景的实例的集合，是启停伸缩策略和进行伸缩活动的基本单位。伸缩组内定义了最大实例数、期望实例数、最小实例数、虚拟私有云、子网、负载均衡等信息。默认最多可以创建10个伸缩组。 | |
| 查询弹性伸缩组详情 | hcloud AS ShowScalingGroup | 查询一个指定弹性伸缩组详情。 | |
| 修改弹性伸缩组 | hcloud AS UpdateScalingGroup | 修改一个指定弹性伸缩组中的信息。
| |
| 删除弹性伸缩组 | hcloud AS DeleteScalingGroup | 删除一个指定弹性伸缩组。 | |
| 启用弹性伸缩组 | hcloud AS ResumeScalingGroup | 启用一个指定弹性伸缩组。 | |
| 停止弹性伸缩组 | hcloud AS PauseScalingGroup | 停止一个指定弹性伸缩组。已停用状态的伸缩组，不会自动触发任何伸缩活动。当伸缩组正在进行伸缩活动，即使停用，正在进行的伸缩活动也不会立即停止。 | |
| 查询暖池信息 | hcloud AS ShowWarmPool | 查询暖池信息。 | |
| 开启暖池 | hcloud AS PutWarmPool | 开启并修改暖池参数。 | |
| 关闭暖池 | hcloud AS CloseWarmPool | 关闭伸缩组的暖池。 | |
| 查询暖池内实例信息 | hcloud AS ListWarmPoolInstances | 查询暖池内实例信息。 | |
| 查询暖池信息（V2版本） | hcloud AS ShowWarmPoolNew | 查询暖池信息。 | |
| 开启暖池（V2版本） | hcloud AS PutWarmPoolNew | 开启并修改暖池参数。 | |
| 关闭暖池（V2版本） | hcloud AS CloseWarmPoolNew | 关闭伸缩组的暖池。 | |
| 查询暖池内实例信息（V2版本） | hcloud AS ListWarmPoolInstancesNew | 查询暖池内实例信息。 |
弹性伸缩配置
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询弹性伸缩配置列表 | hcloud AS ListScalingConfigs | 根据输入条件过滤查询弹性伸缩配置。查询结果分页显示。
| |
| 创建弹性伸缩配置 | hcloud AS CreateScalingConfig | 创建弹性伸缩配置。伸缩配置是伸缩组内实例（弹性云服务器）的模板，定义了伸缩组内待添加的实例的规格数据。伸缩配置与伸缩组是解耦的，同一伸缩配置可以被多个伸缩组使用。默认最多可以创建100个伸缩配置。 | |
| 查询弹性伸缩配置详情 | hcloud AS ShowScalingConfig | 根据伸缩配置ID查询一个弹性伸缩配置的详细信息。 | |
| 修改伸缩配置 | hcloud AS UpdateScalingConfig | 修改伸缩配置。 | |
| 删除弹性伸缩配置 | hcloud AS DeleteScalingConfig | 删除一个指定弹性伸缩配置。 | |
| 批量删除弹性伸缩配置 | hcloud AS BatchDeleteScalingConfigs | 批量删除指定弹性伸缩配置。被伸缩组使用的伸缩配置不能被删除。单次最多删除伸缩配置个数为50。 |
标签管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询标签 | hcloud AS ListScalingTagInfosByTenantId | 根据项目ID查询指定资源类型的标签列表。 | |
| 查询资源标签 | hcloud AS ListScalingTagInfosByResourceId | 根据项目ID和资源ID查询指定资源类型的资源标签列表。 | |
| 查询资源实例 | hcloud AS ListResourceInstances | 根据项目ID查询指定资源类型的资源实例。资源、资源tag默认按照创建时间倒序。 | |
| 创建标签 | hcloud AS CreateScalingTagInfo | 创建指定资源的标签。 | |
| 删除标签 | hcloud AS DeleteScalingTagInfo | 删除指定资源的标签。 |
生命周期挂钩管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 创建生命周期挂钩 | hcloud AS CreateLifyCycleHook | 创建生命周期挂钩，可为伸缩组添加一个或多个生命周期挂钩，最多添加5个。
| |
| 查询生命周期挂钩列表 | hcloud AS ListLifeCycleHooks | 根据伸缩组ID查询生命周期挂钩列表。 | |
| 查询生命周期挂钩详情 | hcloud AS ShowLifeCycleHook | 根据伸缩组ID及生命周期挂钩名称查询指定的生命周期挂钩详情。 | |
| 修改生命周期挂钩 | hcloud AS UpdateLifeCycleHook | 修改一个指定生命周期挂钩中的信息。 | |
| 删除生命周期挂钩 | hcloud AS DeleteLifecycleHook | 删除一个指定生命周期挂钩。伸缩组进行伸缩活动时，不允许删除该伸缩组内的生命周期挂钩。 | |
| 伸缩实例生命周期回调 | hcloud AS AttachCallbackInstanceLifeCycleHook | 通过生命周期操作令牌或者通过实例ID和生命周期挂钩名称对伸缩实例指定的挂钩进行回调操作。
| |
| 查询伸缩实例挂起信息 | hcloud AS ListHookInstances | 添加生命周期挂钩后，当伸缩组进行伸缩活动时，实例将被挂钩挂起并置于等待状态，根据输入条件过滤查询弹性伸缩组中伸缩实例的挂起信息。
|
计划任务
通知管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询伸缩组通知列表 | hcloud AS ListScalingNotifications | 根据伸缩组ID查询指定弹性伸缩组的通知列表。 | |
| 配置伸缩组通知 | hcloud AS CreateScalingNotification | 给弹性伸缩组配置通知功能。每调用一次该接口，伸缩组即配置一个通知主题及其通知场景，每个伸缩组最多可以增加5个主题。通知主题由用户事先在SMN创建并进行订阅，当通知主题对应的通知场景出现时，伸缩组会向用户的订阅终端发送通知。 | |
| 删除伸缩组通知 | hcloud AS DeleteScalingNotification | 删除指定的弹性伸缩组中指定的通知。 |
