CLI命令参考(ECS)
查询API版本信息
生命周期管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 创建云服务器 | hcloud ECS CreateServers | 创建一台或多台云服务器。 | |
| 创建云服务器(按需) | hcloud ECS CreatePostPaidServers | 创建一台或多台按需付费方式的云服务器。 | |
| 删除云服务器 | hcloud ECS DeleteServers | 根据指定的云服务器ID列表,删除云服务器。 | |
| 查询云服务器详情 | hcloud ECS ShowServer | 查询弹性云服务器的详细信息。 | |
| 修改云服务器 | hcloud ECS UpdateServer | 修改云服务器信息,目前支持修改云服务器名称及描述和hostname。 | |
| 查询云服务器详情列表 | hcloud ECS ListServersDetails | 根据用户请求条件从数据库筛选、查询所有的弹性云服务器,并关联相关表获取到弹性云服务器的详细信息。 | |
| 查询云服务器列表接口 | hcloud ECS ListCloudServers | 查询云服务器列表接口。 | |
| 查询云服务器列表 | hcloud ECS NovaListServers | 查询云服务器信息列表。 | |
| 创建云服务器 | hcloud ECS NovaCreateServers | 创建一台弹性云服务器。 | |
| 查询云服务器详情 | hcloud ECS NovaShowServer | 根据云服务器ID,查询云服务器的详细信息。 | |
| 修改云服务器 | hcloud ECS NovaUpdateServer | 修改云服务器信息,目前支持修改云服务器名称及描述。 | |
| 删除云服务器 | hcloud ECS NovaDeleteServer | 删除一台云服务器。 | |
| 查询云服务器详情列表 | hcloud ECS NovaListServersDetails | 查询云服务器详情信息列表。 |
状态管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 重装弹性云服务器操作系统(安装Cloud-init) | hcloud ECS ReinstallServerWithCloudInit | 重装弹性云服务器的操作系统。支持弹性云服务器数据盘不变的情况下,使用原镜像重装系统盘。 | |
| 切换弹性云服务器操作系统(安装Cloud init) | hcloud ECS ChangeServerOsWithCloudInit | 切换弹性云服务器操作系统。支持弹性云服务器数据盘不变的情况下,使用新镜像重装系统盘。 | |
| 重装弹性云服务器操作系统(未安装Cloud init) | hcloud ECS ReinstallServerWithoutCloudInit | 重装弹性云服务器的操作系统。 | |
| 切换弹性云服务器操作系统(未安装Cloud init) | hcloud ECS ChangeServerOsWithoutCloudInit | 切换弹性云服务器操作系统。 | |
| 冷迁移云服务器 | hcloud ECS MigrateServer | ||
| 获取VNC远程登录地址 | hcloud ECS ShowServerRemoteConsole | 获取弹性云服务器VNC远程登录地址。 | |
| 变更云服务器规格 | hcloud ECS ResizeServer | 变更云服务器规格。 | |
| 变更云服务器规格(按需) | hcloud ECS ResizePostPaidServer | 当您创建的弹性云服务器规格无法满足业务需要时,可以变更云服务器规格,升级vCPU、内存。具体接口的使用,请参见本节内容。 | |
| 更换云服务器计费模式 | hcloud ECS ChangeServerChargeMode | 更换云服务器的计费模式 | |
| 重部署云服务器 | hcloud ECS ExecuteServerRedeploy | 重部署云服务器 | |
| 启动云服务器 | hcloud ECS NovaStartServer | 启动单台云服务器。 | |
| 重启云服务器 | hcloud ECS NovaRebootServer | 重启单台云服务器。 | |
| 关闭云服务器 | hcloud ECS NovaStopServer | 关闭单台云服务器。 | |
| 锁定云服务器 | hcloud ECS NovaLockServer | 锁定弹性云服务器。 | |
| 解锁云服务器 | hcloud ECS NovaUnlockServer | 解锁弹性云服务器。 | |
| 修改云服务器定时删除时间 | hcloud ECS UpdateServerAutoTerminateTime | 修改按需服务器,设置定时删除时间。如果设置的定时删除时间为空字符串,表示取消定时删除。 | |
| 注册云服务器监控 | hcloud ECS RegisterServerMonitor | 将云服务器添加到监控表中。 | |
| 触发云服务器内核dump | hcloud ECS ExecuteServerDump | 触发云服务器内核dump | |
| 设置云服务器云主机串口登录 | hcloud ECS UpdateSerialConsoleOptions | 设置云服务器云主机串口登录。 | |
| 获取串口登录地址 | hcloud ECS ShowSerialConsoleActions | 获取云服务器云主机串口登录地址。 |
批量操作
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 批量启动云服务器 | hcloud ECS BatchStartServers | 根据给定的云服务器ID列表,批量启动云服务器,一次最多可以启动1000台。 | |
| 批量重启云服务器 | hcloud ECS BatchRebootServers | 根据给定的云服务器ID列表,批量重启云服务器,一次最多可以重启1000台。 | |
| 批量关闭云服务器 | hcloud ECS BatchStopServers | 根据给定的云服务器ID列表,批量关闭云服务器,一次最多可以关闭1000台。 | |
| 批量修改弹性云服务器 | hcloud ECS BatchUpdateServersName | 批量修改弹性云服务器信息。 | |
| 批量重置弹性云服务器密码 | hcloud ECS BatchResetServersPassword | 批量重置弹性云服务器管理帐号(root用户或Administrator用户)的密码。 | |
| 批量挂载指定共享盘 | hcloud ECS BatchAttachSharableVolumes | 将指定的共享磁盘一次性挂载到多个弹性云服务器,实现批量挂载。 | |
| 批量变更云服务器规格 | hcloud ECS BatchResizeServers | 批量变更云服务器规格 | |
| 批量卸载卷 | hcloud ECS BatchDetachVolumes | 批量卸载卷。 |
网卡管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 批量添加云服务器网卡 | hcloud ECS BatchAddServerNics | 给云服务器添加一张或多张网卡。 | |
| 批量删除云服务器网卡 | hcloud ECS BatchDeleteServerNics | 卸载并删除云服务器中的一张或多张网卡。 | |
| 更新云服务器指定网卡属性 | hcloud ECS ChangeServerNetworkInterface | 更新云服务器指定网卡属性,当前仅支持更新网卡IP。 | |
| 云服务器网卡配置虚拟IP地址 | hcloud ECS AssociateServerVirtualIp | 虚拟IP地址用于为网卡提供第二个IP地址,同时支持与多个弹性云服务器的网卡绑定,从而实现多个弹性云服务器之间的高可用性。 | |
| 云服务器网卡解绑虚拟IP地址 | hcloud ECS DisassociateServerVirtualIp | 虚拟IP地址用于为网卡提供第二个IP地址,同时支持与多个弹性云服务器的网卡绑定,从而实现多个弹性云服务器之间的高可用性。 | |
| 查询云服务器网卡信息 | hcloud ECS ListServerInterfaces | 查询云服务器网卡信息。 | |
| 云服务器切换虚拟私有云 | hcloud ECS ChangeVpc | 云服务器切换虚拟私有云。 | |
| 更新云服务器网卡挂载信息 | hcloud ECS UpdateServerInterface | 更新云服务器网卡挂载信息。 | |
| 查询云服务器网卡信息 | hcloud ECS NovaListServerInterfaces | 查询云服务器网卡信息。 | |
| 添加云服务器网卡 | hcloud ECS NovaAttachInterface | 给云服务器添加一张网卡。 | |
| 查询指定云服务器网卡信息 | hcloud ECS NovaShowServerInterface | 根据网卡ID,查询云服务器网卡信息。 | |
| 删除云服务器网卡 | hcloud ECS NovaDetachInterface | 根据指定的Port ID,从云服务器中卸载网卡。 | |
| 查询虚拟机可挂载网卡 | hcloud ECS ShowServerAttachableNicNum | 查询虚拟机可挂载网卡 |
磁盘管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询弹性云服务器单个磁盘信息 | hcloud ECS ShowServerBlockDevice | 查询弹性云服务器挂载的单个磁盘信息。 | |
| 修改云服务器挂载的单个磁盘信息 | hcloud ECS UpdateServerBlockDevice | 修改云服务器云主机挂载的单个磁盘信息。'当前仅支持修改delete_on_termination字段。 | |
| 查询弹性云服务器挂载磁盘列表信息 | hcloud ECS ListServerVolumeAttachments | 查询弹性云服务器挂载的磁盘信息。 | |
| 查询弹性云服务器挂载磁盘列表详情信息 | hcloud ECS ListServerBlockDevices | 查询弹性云服务器挂载的磁盘信息。 | |
| 弹性云服务器挂载磁盘 | hcloud ECS AttachServerVolume | 把磁盘挂载到弹性云服务器上。 | |
| 弹性云服务器卸载磁盘 | hcloud ECS DetachServerVolume | 从弹性云服务器中卸载磁盘。 | |
| 查询弹性云服务器挂载磁盘信息 | hcloud ECS NovaListServerVolumes | 查询弹性云服务器挂载的磁盘信息。 | |
| 弹性云服务器挂载磁盘 | hcloud ECS NovaAttachVolume | 弹性云服务器挂载磁盘。 | |
| 查询弹性云服务器挂载的单个磁盘信息 | hcloud ECS NovaShowServerVolume | 根据磁盘ID,查询云服务器挂载的单个磁盘信息。 | |
| 卸载云服务器磁盘 | hcloud ECS NovaDetachVolume | 弹性云服务器卸载磁盘。 | |
| 查询包周期虚拟机可以追加卷数量 | hcloud ECS ShowAppendableVolumeQuota | 查询包周期虚拟机可以追加卷数量 |
安全组管理
规格管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询规格详情和规格扩展信息列表 | hcloud ECS ListFlavors | 查询云服务器规格详情信息和规格扩展信息列表。 | |
| 查询规格销售策略 | hcloud ECS ListFlavorSellPolicies | 查询规格销售策略。 | |
| 查询云服务器规格变更支持列表 | hcloud ECS ListResizeFlavors | 变更规格时,部分规格的云服务器之间不能互相变更。您可以通过本接口,通过指定弹性云服务器规格,查询该规格可以变更的规格列表。 | |
| 查询云服务器规格列表 | hcloud ECS NovaListFlavors | 查询系统中可用的弹性云服务器规格列表。 | |
| 查询云服务器规格详情列表 | hcloud ECS NovaListFlavorsDetails | 查询云服务器规格信息列表。 | |
| 查询云服务器规格详情 | hcloud ECS NovaShowFlavor | 根据云服务器规格ID,查询云服务器规格详情信息。 | |
| 查询云服务器规格extra_specs的详情 | hcloud ECS NovaShowFlavorExtraSpecs | 查询指定的规格的详细信息。 | |
| 查询规格的容量 | hcloud ECS ShowFlavorCapacity | 查询规格的容量 |
元数据管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 更新云服务器元数据 | hcloud ECS UpdateServerMetadata | 更新云服务器元数据。 | |
| 删除云服务器指定元数据 | hcloud ECS DeleteServerMetadata | 删除云服务器指定元数据。 | |
| 查询云服务器元数据列表 | hcloud ECS NovaShowServerMetadata | 查询弹性云服务器的元数据信息。 | |
| 更新云服务器元数据 | hcloud ECS NovaUpdateServerMetadata | 更新云服务器元数据。 | |
| 设置云服务器元数据 | hcloud ECS NovaCreateServerMetadata | 设置弹性云服务器的元数据信息。 | |
| 获取云服务器指定Key的元数据 | hcloud ECS NovaShowServerMetadataItem | 获取云服务器指定key的元数据信息。 | |
| 修改云服务器指定Key的元数据 | hcloud ECS NovaUpdateServerMetadataItem | 设置云服务器指定key的元数据。 | |
| 删除云服务器指定元数据 | hcloud ECS NovaDeleteServerMetadataItem | 删除云服务器指定元数据。 |
元数据配置管理
租户配额管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询租户配额 | hcloud ECS ShowServerLimits | 查询租户配额信息。 |
查询Job状态
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询任务的执行状态 | hcloud ECS ShowJob | 查询Job的执行状态。 |
标签管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 批量添加云服务器标签 | hcloud ECS BatchCreateServerTags | ||
| 批量删除云服务器标签 | hcloud ECS BatchDeleteServerTags | ||
| 查询项目标签 | hcloud ECS ListServerTags | 项目(Project)用于将OpenStack的资源(计算资源、存储资源和网络资源)进行分组和隔离。项目可以是一个部门或者一个项目组。一个帐户中可以创建多个项目。 | |
| 查询云服务器标签 | hcloud ECS ShowServerTags |
密钥密码管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询是否支持一键重置密码 | hcloud ECS ShowResetPasswordFlag | 查询弹性云服务器是否支持一键重置密码。 | |
| 一键重置弹性云服务器密码(企业项目) | hcloud ECS ResetServerPassword | 重置弹性云服务器管理帐号(root用户或Administrator用户)的密码。 | |
| 云服务器获取密码(企业项目) | hcloud ECS ShowServerPassword | 当通过支持Cloudbase-init功能的镜像创建Windows云服务器时,获取云服务器初始安装时系统生成的管理员帐户(Administrator帐户或Cloudbase-init设置的帐户)随机密码。 | |
| 云服务器清除密码(企业项目) | hcloud ECS DeleteServerPassword | 清除Windows云服务器初始安装时系统生成的密码记录。清除密码后,不影响云服务器密码登录功能,但不能再使用获取密码功能来查询该云服务器密码。 | |
| 查询SSH密钥列表 | hcloud ECS NovaListKeypairs | 查询SSH密钥信息列表。 | |
| 创建和导入SSH密钥 | hcloud ECS NovaCreateKeypair | 创建SSH密钥,或把公钥导入系统,生成密钥对。 | |
| 查询SSH密钥详情 | hcloud ECS NovaShowKeypair | 根据SSH密钥名称查询指定SSH密钥。 | |
| 删除SSH密钥 | hcloud ECS NovaDeleteKeypair | 根据SSH密钥的名称,删除指定SSH密钥。 |
云服务器组管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 云服务器组批量添加成员 | hcloud ECS BatchAddServerGroupMember | 将云服务器加入云服务器组。添加成功后,该云服务器与云服务器组中的其他成员尽量分散地创建在不同主机上。 | |
| 云服务器组批量删除成员 | hcloud ECS BatchDeleteServerGroupMember | 将弹性云服务器移出云服务器组。移出后,该云服务器与云服务器组中的成员不再遵从反亲和策略。 | |
| 查询云服务器组列表 | hcloud ECS ListServerGroups | 查询弹性云服务器组。 | |
| 创建云服务器组 | hcloud ECS CreateServerGroup | 创建弹性云服务器组。 | |
| 查询云服务器组详情 | hcloud ECS ShowServerGroup | 查询弹性云服务器组详情。 | |
| 删除云服务器组 | hcloud ECS DeleteServerGroup | 删除云服务器组。 | |
| 添加云服务器组成员 | hcloud ECS AddServerGroupMember | 将云服务器加入云服务器组。添加成功后,如果该云服务器组是反亲和性策略的,则该云服务器与云服务器组中的其他成员尽量分散地创建在不同主机上。如果该云服务器是故障域类型的,则该云服务器会拥有故障域属性。 | |
| 删除云服务器组成员 | hcloud ECS DeleteServerGroupMember | 将弹性云服务器移出云服务器组。移出后,该云服务器与云服务器组中的成员不再遵从反亲和策略。 | |
| 查询云服务器组列表 | hcloud ECS NovaListServerGroups | 查询云服务器组列表。 | |
| 创建云服务器组 | hcloud ECS NovaCreateServerGroup | 创建弹性云服务器组。 | |
| 查询云服务器组详情 | hcloud ECS NovaShowServerGroup | 查询云服务器组详情。 | |
| 删除云服务器组 | hcloud ECS NovaDeleteServerGroup | 删除云服务器组。 |
云服务器操作管理
可用区管理
计划事件
回收站
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询回收站配置 | hcloud ECS ShowRecycleBin | 查询回收站配置 | |
| 更新回收站配置 | hcloud ECS UpdateRecycleBin | 更新回收站属性信息 | |
| 删除回收站中虚拟机 | hcloud ECS DeleteRecycleBinServer | 删除回收站中的虚拟机 | |
| 查询回收站中虚拟机列表 | hcloud ECS ListRecycleBinServers | 查询回收站中虚拟机列表 | |
| 更新回收站策略 | hcloud ECS UpdateRecycleBinPolicy | 更新回收站策略 | |
| 恢复回收站中虚拟机 | hcloud ECS RevertRecycleBinServer | 回收站中的虚拟机从回收站中恢复 |
模板
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询模板版本列表 | hcloud ECS ListLaunchTemplateVersions | 根据用户请求条件从数据库筛选、查询启动模板的版本相关信息,支持按照image_id和flavor_id进行过滤。 | |
| 删除模板 | hcloud ECS DeleteLaunchTemplates | 删除启动模板。删除一个启动模板。并同时删除模板下所有的版本。 | |
| 查询模板列表 | hcloud ECS ListTemplates | 根据用户请求条件从数据库筛选、查询启动模板相关信息。 | |
| 创建模板 | hcloud ECS CreateLaunchTemplate | 创建启动模板。将创建一个全新的模板,并自动生成版本号为1的作为默认版本。 |