CLI命令参考(V3)
API版本信息
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询API版本列表信息 | hcloud ELB ListApiVersions/v3 | 查询当前ELB服务所有可用的API版本。通常情况下高版本API(当前v3为最高版本)比低版本API支持更多更全的特性。 |
负载均衡器
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 升级负载均衡器类型 | hcloud ELB UpgradeLoadbalancer/v3 | 升级负载均衡器类型。支持将共享型ELB升级为独享型ELB,但不支持独享型降级为共享型。 | |
| 创建负载均衡器 | hcloud ELB CreateLoadBalancer/v3 | 创建独享型负载均衡器,包括按需及包周期计费负载均衡器。 | |
| 查询负载均衡器列表 | hcloud ELB ListLoadBalancers/v3 | 查询负载均衡器列表。 | |
| 批量创建负载均衡器 | hcloud ELB BatchCreateLoadBalancers/v3 | 批量创建独享型或者共享型负载均衡器,包括按需及包周期计费负载均衡器。 | |
| 批量删除负载均衡器 | hcloud ELB BatchDeleteLoadbalancers/v3 | 批量删除负载均衡器。 | |
| 查询负载均衡器详情 | hcloud ELB ShowLoadBalancer/v3 | 查询负载均衡器详情。 | |
| 更新负载均衡器 | hcloud ELB UpdateLoadBalancer/v3 | 更新负载均衡器。 | |
| 删除负载均衡器 | hcloud ELB DeleteLoadBalancer/v3 | 删除负载均衡器。 | |
| 查询负载均衡器状态树 | hcloud ELB ShowLoadBalancerStatus/v3 | 查询负载均衡器状态树,包括负载均衡器及其关联的子资源的状态信息。 | |
| 查询负载均衡器拓扑 | hcloud ELB ShowLoadBalancerTopology/v3 | 查询负载均衡拓扑,将负载均衡器及其包含的监听器、后端服务器组以拓扑的形式展示。 | |
| 查询负载均衡内部转发用的IP | hcloud ELB ShowLoadBalancerPorts/v3 | 查询负载均衡内部转发用的IP。 | |
| 新增负载均衡器可用区 | hcloud ELB BatchAddAvailableZones/v3 | 给负载均衡器新增可用区。 | |
| 移除负载均衡器可用区 | hcloud ELB BatchRemoveAvailableZones/v3 | 移除负载均衡器的可用区。 | |
| 级联删除负载均衡器 | hcloud ELB DeleteLoadBalancerForce/v3 | 删除负载均衡器且级联删除其下子资源(删除负载均衡器及其绑定的监听器、后端服务器组、后端服务器等一系列资源)。 | |
| 级联删除负载均衡器及关联EIP | hcloud ELB DeleteLoadBalancerCascade/v3 | 删除负载均衡器且级联删除其下子资源(删除负载均衡器及其绑定的监听器、后端服务器等一系列资源)。以及根据需要删除或解绑后端服务器组和LB关联的EIP。 | |
| 复制已有负载均衡器 | hcloud ELB CloneLoadbalancer/v3 | 复制已有的负载均衡器实例。 | |
| 自定义配置负载均衡器域名解析 | hcloud ELB UpdateUserDefinedDomainConfig/v3 | 自定义配置负载均衡器域名解析。 | |
| 配置系统默认的负载均衡器域名解析 | hcloud ELB UpdateSystemDefaultDomainConfig/v3 | 配置系统默认的负载均衡器域名解析。 | |
| 批量将IP地址加入ELB实例域名解析中 | hcloud ELB BatchEnableDomainIPs/v3 | 批量将IP地址加入ELB实例域名解析中。 | |
| 批量将IP地址从ELB实例域名解析中移除 | hcloud ELB BatchDisableDomainIPs/v3 | 批量将IP地址从ELB实例域名解析中移除。 | |
| 查询负载均衡器IP地址的域名解析配置 | hcloud ELB ListDomainIPs/v3 | 查询负载均衡器所有IP的域名解析配置信息,即负载均衡器的IP是否加入了域名解析,以及对应的域名。 |
安全策略
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 创建自定义安全策略 | hcloud ELB CreateSecurityPolicy/v3 | 创建自定义安全策略。用于在创建HTTPS/TLS监听器时,请求参数中指定security_policy_id来设置监听器的自定义安全策略。 | |
| 查询自定义安全策略列表 | hcloud ELB ListSecurityPolicies/v3 | 查询自定义安全策略列表。 | |
| 查询自定义安全策略详情 | hcloud ELB ShowSecurityPolicy/v3 | 查询自定义安全策略详情。 | |
| 更新自定义安全策略 | hcloud ELB UpdateSecurityPolicy/v3 | 更新自定义安全策略。 | |
| 删除自定义安全策略 | hcloud ELB DeleteSecurityPolicy/v3 | 删除自定义安全策略。 | |
| 查询系统安全策略列表 | hcloud ELB ListSystemSecurityPolicies/v3 | 查询系统安全策略列表。 |
配额
可用区
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询可用区列表 | hcloud ELB ListAvailabilityZones/v3 | 返回租户创建LB时可使用的可用区集合列表情况。 |
规格
预占IP
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 计算预占IP数 | hcloud ELB CountPreoccupyIpNum/v3 | 计算以下几种场景的预占用IP数量: |
回收站
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询回收站负载均衡器列表 | hcloud ELB ListRecycleBinLoadBalancers/v3 | 查询回收站负载均衡器列表。 | |
| 还原负载均衡器 | hcloud ELB RestoreLoadbalancer/v3 | 从回收站中还原负载均衡器 | |
| 销毁回收站负载均衡器 | hcloud ELB DeleteRecycleLoadBalancer/v3 | 销毁回收站负载均衡器。销毁后无法再还原。 | |
| 查询回收站的配置 | hcloud ELB ShowRecycleBin/v3 | 查询回收站的配置。 | |
| 开关回收站 | hcloud ELB UpdateRecycleBinEnable/v3 | 开启或关闭回收站功能。开启后删除的LB可以进入回收站,否则将不进入回收站而是直接被删除无法恢复。关闭回收站前需要先将回收站中的实例还原或销毁。 | |
| 更新回收站的配置 | hcloud ELB UpdateRecycleBinPolicy/v3 | 更新回收站的配置。若回收站未开启,则更新会报错。 |
证书
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 创建证书 | hcloud ELB CreateCertificate/v3 | 创建用于弹性负载均衡器HTTPS/TLS/QUIC协议监听器的证书。支持关联云证书与管理服务(CCM)的证书,或者使用自有证书。 | |
| 查询证书列表 | hcloud ELB ListCertificates/v3 | 查询ELB证书列表。 | |
| 查询证书详情 | hcloud ELB ShowCertificate/v3 | 查询ELB证书详情。 | |
| 更新证书 | hcloud ELB UpdateCertificate/v3 | 更新ELB证书。不能更新证书类型,但可以更新证书内容和私钥等。 | |
| 删除证书 | hcloud ELB DeleteCertificate/v3 | 删除ELB证书。若是删除source=scm的证书,关联的云证书与管理服务(CCM)中的证书不会被删除。若想删除已关联到监听器的证书,则需要先解除监听器和证书的绑定关系。 | |
| 批量删除证书 | hcloud ELB BatchDeleteCertificates/v3 | 批量删除证书。 | |
| 修改证书私钥字段回显开关 | hcloud ELB CreateCertificatePrivateKeyEcho/v3 | 开启或关闭ELB证书的私钥字段回显开关。该开关用于设置各个ELB证书接口的响应字段private_key和enc_private_key是否展示。若开启则证书的详情、列表、更新和创建接口返回私钥内容;不开启则返回脱敏后内容(******)。该开关影响整个租户项目(project),默认开启。 | |
| 查询证书私钥字段回显开关 | hcloud ELB ShowCertificatePrivateKeyEcho/v3 | 查询证书私钥回显开关的状态。该开关用于设置各个ELB证书接口的响应字段private_key和enc_private_key是否展示。若开启则这些接口返回私钥内容;不开启则返回脱敏后内容(******)。该开关影响整个租户项目(project),默认开启。 |
IP地址组
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 创建IP地址组 | hcloud ELB CreateIpGroup/v3 | 创建IP地址组。IP地址组用于关联监听器,设置监听器访问控制,指定可以访问或者禁止访问监听器的IP地址。 | |
| 查询IP地址组列表 | hcloud ELB ListIpGroups/v3 | 查询IP地址组列表。 | |
| 查询IP地址组详情 | hcloud ELB ShowIpGroup/v3 | 获取IP地址组详情。 | |
| 更新IP地址组 | hcloud ELB UpdateIpGroup/v3 | 更新IP地址组。若要更新其中的IP地址列表,则只支持全量更新。即IP地址组中的ip_list将被全量覆盖,不在请求参数中的IP地址将被移除。 | |
| 删除IP地址组 | hcloud ELB DeleteIpGroup/v3 | 删除IP地址组。已关联监听器的IP地址组无法直接删除,需要先解除关联关系 | |
| 更新IP地址组的IP列表项 | hcloud ELB UpdateIpList/v3 | 添加新的IP地址到IP地址组的IP列表中,或更新已有IP地址的描述。不支持通过该接口删除ip_list中已有的IP地址。 | |
| 删除IP地址组的IP列表项 | hcloud ELB BatchDeleteIpList/v3 | 批量删除IP地址组中IP列表的IP地址项。 | |
| 查询IP地址组关联的监听器列表 | hcloud ELB ShowIpGroupRelatedListeners/v3 | 查询IP地址组关联的监听器列表。 |
监听器
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 批量删监听器 | hcloud ELB BatchDeleteListeners/v3 | 批量删除监听器。 | |
| 创建监听器 | hcloud ELB CreateListener/v3 | 创建监听器。支持通过该接口创建独享型及共享型ELB实例下的监听器。 | |
| 查询监听器列表 | hcloud ELB ListListeners/v3 | 查询监听器列表。 | |
| 查询监听器详情 | hcloud ELB ShowListener/v3 | 查询监听器详情。 | |
| 更新监听器 | hcloud ELB UpdateListener/v3 | 更新监听器。 | |
| 删除监听器 | hcloud ELB DeleteListener/v3 | 删除监听器。 | |
| 级联删除监听器 | hcloud ELB DeleteListenerForce/v3 | 删除监听器且级联删除其下子资源(删除监听器、转发策略等,解绑后端服务器组)。 | |
| 复制已有监听器 | hcloud ELB CloneListener/v3 | 复制已有的监听器到同VPC内的负载均衡器。 |
后端服务器组
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 创建后端服务器组 | hcloud ELB CreatePool/v3 | 创建后端服务器组。 | |
| 查询后端服务器组列表 | hcloud ELB ListPools/v3 | 查询后端服务器组列表。 | |
| 查询后端服务器组详情 | hcloud ELB ShowPool/v3 | 后端服务器组详情。 | |
| 更新后端服务器组 | hcloud ELB UpdatePool/v3 | 更新后端服务器组。 | |
| 删除后端服务器组 | hcloud ELB DeletePool/v3 | 删除后端服务器组。 | |
| 级联删除后端服务器组 | hcloud ELB DeletePoolCascade/v3 | 级联删除后端服务器组,包含在此后端服务器组下的所有后端服务器和健康检查也将被删除。 | |
| 批量删除后端服务器组 | hcloud ELB BatchDeletePools/v3 | 批量删除后端服务器组。 |
主备后端服务器组
后端服务器
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 创建后端服务器 | hcloud ELB CreateMember/v3 | 创建后端服务器。 | |
| 查询后端服务器列表 | hcloud ELB ListMembers/v3 | Pool下的后端服务器列表。 | |
| 查询后端服务器详情 | hcloud ELB ShowMember/v3 | 后端服务器详情。 | |
| 更新后端服务器 | hcloud ELB UpdateMember/v3 | 更新后端服务器。 | |
| 删除后端服务器 | hcloud ELB DeleteMember/v3 | 删除后端服务器。 | |
| 后端服务器全局列表 | hcloud ELB ListAllMembers/v3 | 查询当前项目下的后端服务器列表。 | |
| 批量创建后端服务器 | hcloud ELB BatchCreateMembers/v3 | 在指定pool下批量创建后端服务器。一次最多创建200个。 | |
| 批量删除后端服务器 | hcloud ELB BatchDeleteMembers/v3 | 在指定pool下批量删除后端服务器。一次最多添加200个。 | |
| 批量更新后端服务器 | hcloud ELB BatchUpdateMembers/v3 | 在指定pool下批量更新后端服务器。一次最多添加200个。 | |
| 创建后端服务器检测任务 | hcloud ELB CreateMemberHealthCheckJob/v3 | 创建后端服务器检测任务。包括后端服务器的配置、ACL规则和安全组规则检查。 | |
| 查询后端服务器检测任务的结果 | hcloud ELB ShowMemberHealthCheckJob/v3 | 查询后端服务器检测任务的结果。 |
健康检查
转发策略
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 创建转发策略 | hcloud ELB CreateL7Policy/v3 | 创建七层转发策略。 | |
| 查询转发策略列表 | hcloud ELB ListL7Policies/v3 | 查询七层转发策略列表。 | |
| 查询转发策略详情 | hcloud ELB ShowL7Policy/v3 | 查询七层转发策略详情。 | |
| 更新转发策略 | hcloud ELB UpdateL7Policy/v3 | 更新七层转发策略。 | |
| 删除转发策略 | hcloud ELB DeleteL7Policy/v3 | 删除七层转发策略。 | |
| 批量更新转发策略优先级 | hcloud ELB BatchUpdatePoliciesPriority/v3 | 批量更新转发策略的优先级。 |
转发规则
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 创建转发规则 | hcloud ELB CreateL7Rule/v3 | 创建七层转发规则。 | |
| 查询转发规则列表 | hcloud ELB ListL7Rules/v3 | 查询转发规则列表。 | |
| 查询转发规则详情 | hcloud ELB ShowL7Rule/v3 | 查询七层转发规则详情。 | |
| 更新转发规则 | hcloud ELB UpdateL7Rule/v3 | 更新七层转发规则。 | |
| 删除转发规则 | hcloud ELB DeleteL7Rule/v3 | 删除七层转发规则。 | |
| 查询转发规则全局列表 | hcloud ELB ListAllL7Rules/v3 | 查询当前项目下所有转发规则列表 |
云日志
异步任务
特性配置
标签管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 变更负载均衡器标签列表 | hcloud ELB ChangeLoadbalancerTags/v3 | 批量添加或删除指定负载均衡器标签。 | |
| 查询所有负载均衡器的标签列表 | hcloud ELB ListLoadbalancerTags/v3 | 查询指定项目下所有负载均衡器的标签列表 | |
| 查询负载均衡器的标签 | hcloud ELB ShowLoadbalancerTags/v3 | 查询指定负载均衡器的所有标签 | |
| 变更监听器标签列表 | hcloud ELB ChangeListenerTags/v3 | 批量添加或删除指定监听器器标签。 | |
| 查询所有监听器的标签列表 | hcloud ELB ListListenerTags/v3 | 查询指定项目下所有监听器的标签列表 | |
| 查询监听器的标签 | hcloud ELB ShowListenerTags/v3 | 查询指定监听器的所有标签。 |