CLI命令参考
裸金属服务器生命周期管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询裸金属服务器详情列表 | hcloud BMS ListBareMetalServers | 用户根据设置的请求条件筛选裸金属服务器,并获取裸金属服务器的详细信息。该接口支持查询裸金属服务器计费方式,以及是否被冻结。 | |
| 查询裸金属服务器列表 | hcloud BMS ListBareMetalServersDetail | 用户根据设置的请求条件筛选裸金属服务器,并获取裸金属服务器的详细信息。 | |
| 创建裸金属服务器 | hcloud BMS CreateBareMetalServers | 创建一台或多台裸金属服务器。 | |
| 查询裸金属服务器详情 | hcloud BMS ListBareMetalServerDetails | 获取裸金属服务器详细信息,该接口支持查询裸金属服务器的计费方式,以及是否被冻结。 |
裸金属服务器状态管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 修改裸金属服务器名称 | hcloud BMS ChangeBaremetalServerName | 修改裸金属服务器名称。 | |
| 重装裸金属服务器操作系统 | hcloud BMS ReinstallBaremetalServerOs | 重装裸金属服务器的操作系统。快速发放裸金属服务器支持裸金属服务器数据盘不变的情况下,使用原镜像重装系统盘。重装操作系统支持密码或者密钥注入。 | |
| 启动裸金属服务器 | hcloud BMS BatchStartBaremetalServers | 根据给定的裸金属服务器ID列表,批量启动裸金属服务器。 | |
| 重启裸金属服务器 | hcloud BMS BatchRebootBaremetalServers | 根据给定的裸金属服务器ID列表,批量重启裸金属服务器。 | |
| 关闭裸金属服务器 | hcloud BMS BatchStopBaremetalServers | 根据给定的裸金属服务器ID列表,批量关闭裸金属服务器。 | |
| 获取裸金属服务器远程登录地址 | hcloud BMS ShowServerRemoteConsole | 获取裸金属服务器远程登录地址。 | |
| 切换裸金属服务器的操作系统 | hcloud BMS ChangeBaremetalServerOs | 切换裸金属服务器的操作系统。切换操作系统支持密码或者密钥注入。 |
裸金属服务器元数据管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 更新裸金属服务器元数据 | hcloud BMS UpdateBaremetalServerMetadata | 更新裸金属服务器元数据。如果元数据中没有待更新字段,则自动添加该字段。如果元数据中已存在待更新字段,则直接更新字段值;如果元数据中的字段不在请求参数中,则保持不变。 |
裸金属服务器元数据配置管理
裸金属服务器网卡管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询裸金属服务器网卡信息 | hcloud BMS ShowBaremetalServerInterfaceAttachments | 查询裸金属服务器的网卡信息,比如网卡的IP地址、MAC地址。 | |
| 裸金属服务器解绑弹性网卡 | hcloud BMS DeleteServerNics | 解绑裸金属服务器中的一张或多张弹性网卡。 | |
| 修改裸金属服务器弹性网卡的属性 | hcloud BMS UpdateBaremetalServerInterfaceAttachments | 修改裸金属服务器所绑定的弹性网卡属性:终止时删除,即删除裸金属服务器,或者解绑网卡时是否删除该网卡。 | |
| 裸金属服务器绑定弹性网卡 | hcloud BMS AddServerNics | 为裸金属服务器绑定一张或多张弹性网卡。 | |
| 编辑port | hcloud BMS ModifyVmNic | 编辑裸金属服务器网卡信息。 |
裸金属服务器云硬盘管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 裸金属服务器挂载云硬盘 | hcloud BMS AttachBaremetalServerVolume | 裸金属服务器创建成功后,如果发现磁盘不够用或者当前磁盘不满足要求,可以将已有云硬盘挂载给裸金属服务器,作为数据盘使用。 | |
| 裸金属服务器卸载云磁盘 | hcloud BMS DetachBaremetalServerVolume | 将挂载至裸金属服务器中的磁盘卸载;对于挂载在系统盘盘位(也就是“/dev/sda”挂载点)上的磁盘,不允许执行卸载操作;对于挂载在数据盘盘位(非“/dev/sda”挂载点)上的磁盘,支持离线卸载和在线卸载(裸金属服务器处于“运行中”状态)磁盘。 | |
| 查询裸金属服务器挂载的云硬盘信息 | hcloud BMS ShowBaremetalServerVolumeInfo | 查询裸金属服务器挂载的云硬盘信息。 |
裸金属服务器密码管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询是否支持一键重置密码 | hcloud BMS ShowResetPwd | 查询裸金属服务器是否支持一键重置密码。 | |
| 一键重置裸金属服务器密码 | hcloud BMS ResetPwdOneClick | 在裸金属服务器支持一键重置密码功能的前提下,重置裸金属服务器管理账号(root用户或Administrator用户)的密码。 | |
| Windows裸金属服务器获取密码 | hcloud BMS ShowWindowsBaremetalServerPwd | 获取Windows裸金属服务器初始安装时系统生成的管理员账户(Administrator账户或Cloudbase-init设置的账户)随机密码。 如果裸金属服务器是通过私有镜像创建的,请确保已安装Cloudbase-init。公共镜像默认已安装该软件。 | |
| Windows裸金属服务器清除密码 | hcloud BMS DeleteWindowsBareMetalServerPassword | 清除Windows裸金属服务器初始安装时系统生成的密码记录。清除密码后,不影响裸金属服务器密码登录功能,但不能再使用获取密码功能来查询该裸金属服务器密码。 如果裸金属服务器是通过私有镜像创建的,请确保已安装Cloudbase-init。公共镜像默认已安装该软件。 |
裸金属服务器租户配额管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询租户配额 | hcloud BMS ShowTenantQuota | 查询该租户下,所有资源的配额信息,包括已使用配额。 |
裸金属服务器规格管理
Job管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询Job状态 | hcloud BMS ShowJobInfos | 查询Job的执行状态。 对于创建裸金属服务器物理机、挂卸卷等异步API,命令下发后,会返回job_id,通过job_id可以查询任务的执行状态。 |
查询API版本信息
裸金属服务器二维标签管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 批量添加裸金属服务器标签 | hcloud BMS BatchCreateBaremetalServerTags | 为指定裸金属服务器批量添加标签。 标签管理服务(Tag Management Service,TMS)使用该接口批量管理裸金属服务器的标签。 | |
| 批量删除裸金属服务器标签 | hcloud BMS BatchDeleteBaremetalServerTags | 为指定云服务器批量删除标签。 TMS使用该接口批量管理裸金属服务器的标签。 | |
| 查询裸金属服务器标签 | hcloud BMS ShowBaremetalServerTags | 查询指定云服务器的标签信息。 TMS使用该接口查询指定裸金属服务器的全部标签数据。 |