CLI命令参考（V1）

创建集群

hcloud CSS CreateCluster/v1

该接口用于创建集群。

去调试

查询集群列表

hcloud CSS ListClustersDetails/v1

该接口用于查询并显示集群列表以及集群的状态。

去调试

查询集群详情

hcloud CSS ShowClusterDetail/v1

该接口用于查询并显示单个集群详情。

去调试

删除集群

hcloud CSS DeleteCluster/v1

此接口用于删除集群。集群删除将释放此集群的所有资源，包括客户数据。如果需要保留客户集群数据，建议在删除集群前先创建快照。

去调试

按需集群转包周期

hcloud CSS UpdateOndemandClusterToPeriod/v1

该接口用于按需集群转包周期集群。

去调试

修改集群名称或描述

hcloud CSS UpdateClusterName/v1

该接口用于修改集群名称或描述。

去调试

修改密码

hcloud CSS ResetPassword/v1

该接口用于修改集群密码。

去调试

重启集群

hcloud CSS RestartCluster/v1

此接口用于重启集群，重启集群将导致业务中断。

去调试

扩容集群

hcloud CSS UpdateExtendCluster/v1

该接口用于集群扩容实例（仅支持扩容elasticsearch实例）。只扩容普通节点，且只针对要扩容的集群实例不存在特殊节点（Master、Client、冷数据节点）的情况。

去调试

扩容实例的数量和存储容量

hcloud CSS UpdateExtendInstanceStorage/v1

该接口用于集群扩容不同类型实例的个数以及存储容量。已经存在独立Master、Client、冷数据节点的集群使用该接口扩容。

去调试

变更规格

hcloud CSS UpdateFlavor/v1

该接口用于变更集群规格。只支持变更ess节点类型。

去调试

查询所有标签

hcloud CSS ListClustersTags/v1

该接口用于查询指定region下的所有标签集合。

去调试

查询指定集群的标签

hcloud CSS ShowClusterTag/v1

该接口用于查询指定集群的标签信息。

去调试

添加指定集群标签

hcloud CSS CreateClustersTags/v1

该接口用于给指定集群添加标签。

去调试

删除集群标签

hcloud CSS DeleteClustersTags/v1

此接口用于删除集群标签。

去调试

批量添加或删除集群标签

hcloud CSS UpdateBatchClustersTags/v1

该接口用于对集群批量添加或删除标签。

去调试

指定节点类型规格变更

hcloud CSS UpdateFlavorByType/v1

修改集群规格。支持修改:

去调试

指定节点缩容

hcloud CSS UpdateShrinkNodes/v1

该接口可以对集群现有节点中指定节点进行缩容。包周期类型的集群不支持通过api进行指定节点缩容操作。

去调试

指定节点类型缩容

hcloud CSS UpdateShrinkCluster/v1

该接口用于集群对不同类型实例的个数以及存储容量进行缩容。包周期类型的集群不支持通过api进行指定节点类型缩容操作。

去调试

下载安全证书

hcloud CSS DownloadCert/v1

该接口用于下载安全证书。

去调试

节点替换

hcloud CSS UpdateInstance/v1

该接口用于替换失败节点。

去调试

安全模式修改

hcloud CSS ChangeMode/v1

该接口用于切换集群的安全模式。

去调试

添加独立master、client

hcloud CSS AddIndependentNode/v1

由于集群数据面业务的增长或者不确定性，很难在一开始就能够把集群的规模形态想明白，该接口能够在非独立master和client的集群上面独立master、client角色。

去调试

集群内核升级

hcloud CSS UpgradeCore/v1

该接口用于将低版本的ES升级到高版本或同版本ES。

去调试

获取可升级的目标镜像ID

hcloud CSS ListImages/v1

该接口用于获取当前集群的可升级目标镜像ID。

去调试

获取集群升级或切换AZ的详情信息

hcloud CSS UpgradeDetail/v1

由于升级过程时间较长，该接口可以展示当前升级（切换AZ）节点的各个阶段信息。

去调试

重试升级失败任务

hcloud CSS RetryUpgradeTask/v1

由于升级过程时间较长，可能由于网络等原因导致升级失败，可以通过该接口重试该任务或终止该任务的影响。

去调试

切换安全组

hcloud CSS ChangeSecurityGroup/v1

该接口可以在集群创建成功后，修改安全组。

去调试

切换集群实例可用区

hcloud CSS UpdateAzByInstanceType/v1

该接口通过指定节点类型切换AZ。

去调试

切换集群子网

hcloud CSS ChangeClusterSubnet/v1

该接口可以在集群创建成功后，切换集群子网，扩容等添加节点场景下使用新子网绑定新增节点。

去调试

更新集群路由

hcloud CSS UpdateRoute/v1

该接口用于更新集群路由。

去调试

获取集群路由

hcloud CSS ListRoutes/v1

该接口用于获取集群路由。

去调试

自动创建委托

hcloud CSS CreateAgency/v1

当CSS预置委托不存在时，自动创建委托并赋予CSS依赖的权限。

去调试

查询集群磁盘使用情况

hcloud CSS ShowClusterVolumeUsage/v1

查询集群磁盘使用情况

去调试

获取实例规格列表

hcloud CSS ListFlavors/v1

该接口用于查询并显示支持的实例规格对应的ID。

去调试

查询指定集群的可变更规格列表

hcloud CSS ShowResizeFlavors/v1

查询指定集群可以变更到哪些规格

去调试

查询规格详情

hcloud CSS ShowFlavorDetail/v1

查询规格详细信息。

去调试

查询指定引擎支持的规格。

hcloud CSS ShowDataStoreFlavorDetail/v1

查询指定引擎支持的规格。

去调试

列举磁盘类型

hcloud CSS ListDiskType/v1

获取各可用区支持的磁盘类型。

去调试

加载自定义词库

hcloud CSS CreateLoadIkThesaurus/v1

该接口用于加载存放于OBS的自定义词库。

去调试

查询自定义词库状态

hcloud CSS ShowIkThesaurus/v1

该接口用于查询自定义词库的加载状态。

去调试

删除自定义词库

hcloud CSS DeleteIkThesaurus/v1

该接口用于删除自定义词库。

去调试

开启Kibana公网访问

hcloud CSS StartKibanaPublic/v1

该接口用于开启Kibana公网访问。

去调试

关闭Kibana公网访问

hcloud CSS UpdateCloseKibana/v1

该接口用于关闭Kibana公网访问。包周期类型集群不支持通过api进行关闭Kibana公网访问。

去调试

修改Kibana公网带宽

hcloud CSS UpdateAlterKibana/v1

该接口用于修改Kibana公网带宽。

去调试

修改Kibana公网访问控制

hcloud CSS UpdatePublicKibanaWhitelist/v1

该接口通过修改kibana白名单，修改kibana的访问权限。

去调试

关闭Kibana公网访问控制

hcloud CSS StopPublicKibanaWhitelist/v1

该接口用于关闭Kibana公网访问控制。

去调试

创建配置文件

hcloud CSS CreateCnf/v1

该接口用于创建配置文件。

去调试

更新配置文件

hcloud CSS UpdateCnf/v1

该接口用于更新配置文件。

去调试

启动pipeline迁移数据

hcloud CSS StartPipeline/v1

该接口用于启动pipeline迁移数据。

去调试

停止pipeline迁移数据

hcloud CSS StopPipeline/v1

该接口用于停止pipeline迁移数据。

去调试

添加到自定义模板

hcloud CSS AddFavorite/v1

该接口用于添加到自定义模板。

去调试

连通性测试

hcloud CSS StartConnectivityTest/v1

该接口用于连通性测试。

去调试

查询模板列表

hcloud CSS ListTemplates/v1

该接口用于查询模板列表。

去调试

查询配置文件列表

hcloud CSS ListConfs/v1

该接口用于查询配置文件列表。

去调试

查询pipeline列表

hcloud CSS ListPipelines/v1

该接口用于查询pipeline列表。

去调试

查询操作记录

hcloud CSS ListActions/v1

该接口用于查询操作记录。

去调试

查询配置文件内容

hcloud CSS ShowGetConfDetail/v1

该接口用于查询配置文件内容。

去调试

删除配置文件

hcloud CSS DeleteConf/v1

删除配置文件。

去调试

删除自定义模板

hcloud CSS DeleteTemplate/v1

该接口用于删除自定义模板。

去调试

热启动pipeline迁移数据。

hcloud CSS StartHotPipeline/v1

该接口用于热启动pipeline迁移数据。

去调试

热停止pipeline迁移数据。

hcloud CSS StopHotPipeline/v1

该接口用于热停止pipeline迁移数据。

去调试

上传证书文件

hcloud CSS UploadCerts/v1

该接口用于上传证书文件。

去调试

查询证书列表

hcloud CSS ListCerts/v1

该接口用于查询证书列表。

去调试

查询证书文件信息

hcloud CSS ShowCertsDetail/v1

该接口用于查询证书文件信息。

去调试

删除证书文件

hcloud CSS DeleteCerts/v1

该接口用于删除证书文件。

去调试

强制重启集群VMs

hcloud CSS RebootCluster/v1

重启过程中集群不可用，请谨慎操作。 工作中状态的集群，重启过程会主动停止logstash进程，管道列表“是否保持常驻”值为否，会将所有运行中管道状态置为已停止。“是否保持常驻”值为是，会触发logstash进程恢复机制，将工作中的管道状态置为恢复中，若十分钟内重新拉起logstash进程，管道状态恢复为工作中，否则置为失败状态。

去调试

开启日志备份或日志采集功能

hcloud CSS StartLogs/v1

该接口用于开启集群的日志备份或日志采集功能开关。

去调试

关闭日志功能

hcloud CSS StopLogs/v1

该接口用于关闭日志功能。

去调试

查询作业列表

hcloud CSS ListLogsJob/v1

该接口用于查询具体某个集群的日志任务记录列表。

去调试

查询日志基础配置

hcloud CSS ShowGetLogSetting/v1

该接口用于日志基础配置查询。

去调试

修改日志基础配置

hcloud CSS UpdateLogSetting/v1

该接口用于修改日志基础配置。

去调试

开启日志自动备份策略

hcloud CSS StartLogAutoBackupPolicy/v1

该接口用于日志自动备份策略开启。

去调试

关闭日志自动备份策略

hcloud CSS StopLogAutoBackupPolicy/v1

该接口用于日志自动备份策略关闭。

去调试

备份日志

hcloud CSS CreateLogBackup/v1

该接口用于备份日志。

去调试

查询日志

hcloud CSS ShowLogBackup/v1

该接口用于查询日志信息。

去调试

连通性测试。

hcloud CSS StartTargetClusterConnectivityTest/v1

该接口用于连通性测试。

去调试

开启公网访问

hcloud CSS CreateBindPublic/v1

该接口用于开启公网访问。

去调试

关闭公网访问

hcloud CSS UpdateUnbindPublic/v1

该接口用于关闭公网访问。包周期类型的集群不支持通过api进行关闭公网访问。

去调试

修改公网访问带宽

hcloud CSS UpdatePublicBandWidth/v1

该接口用于修改公网访问带宽。

去调试

开启公网访问控制白名单

hcloud CSS StartPublicWhitelist/v1

该接口用于开启公网访问控制白名单。

去调试

关闭公网访问控制白名单

hcloud CSS StopPublicWhitelist/v1

该接口用于关闭公网访问控制白名单。

去调试

自动设置集群快照的基础配置

hcloud CSS StartAutoSetting/v1

该接口用于自动设置集群快照的基础配置，包括配置OBS桶和IAM委托。

去调试

修改集群快照的基础配置

hcloud CSS UpdateSnapshotSetting/v1

该接口用于修改集群快照的基础配置，可修改OBS桶和IAM委托。

去调试

手动创建快照

hcloud CSS CreateSnapshot/v1

该接口用于手动创建一个快照。

去调试

恢复快照

hcloud CSS RestoreSnapshot/v1

该接口用于手动恢复一个快照。

去调试

删除快照

hcloud CSS DeleteSnapshot/v1

该接口用于删除快照。

去调试

设置自动创建快照策略

hcloud CSS CreateAutoCreatePolicy/v1

该接口用于设置自动创建快照，默认一天创建一个快照。

去调试

查询自动创建快照的策略

hcloud CSS ShowAutoCreatePolicy/v1

该接口用于查询自动创建快照策略。

去调试

查询快照列表

hcloud CSS ListSnapshots/v1

该接口用于查询集群的所有快照。

去调试

停用快照功能

hcloud CSS StopSnapshot/v1

该接口用于停用快照功能。

去调试

开启终端节点服务

hcloud CSS StartVpcep/v1

该接口用于开启终端节点服务。

去调试

关闭终端节点服务

hcloud CSS StopVpcep/v1

该接口用于关闭终端节点服务。

去调试

获取终端节点连接

hcloud CSS ShowVpcepConnection/v1

该接口用于获取终端节点连接。

去调试

更新终端节点连接

hcloud CSS UpdateVpcepConnection/v1

该接口用于更新终端节点连接。

去调试

修改终端节点服务白名单

hcloud CSS UpdateVpcepWhitelist/v1

该接口用于修改终端节点服务白名单。

去调试

修改参数配置

hcloud CSS UpdateYmls/v1

该接口用于修改参数配置。

去调试

获取参数配置任务列表

hcloud CSS ListYmlsJob/v1

该接口可获取参数配置的任务操作列表。

去调试

获取参数配置列表

hcloud CSS ListYmls/v1

该接口用于获取当前集群现有的参数配置列表。

去调试

查询集群支持的elbv3负载均衡器

hcloud CSS ListElbs/v1

展示查询集群支持的elbv3负载均衡器

去调试

为集群打开或关闭负载均衡器

hcloud CSS EnableOrDisableElb/v1

该接口为集群打开或关闭负载均衡器。

去调试

集群负载均衡监听器配置。

hcloud CSS CreateElbListener/v1

该接口用于集群负载均衡监听器配置。

去调试

获取集群的负载均衡器信息

hcloud CSS ShowElbDetail/v1

该接口用于获取集群的负载均衡器信息。

去调试

更新集群负载均衡监听器

hcloud CSS UpdateEsListener/v1

该接口用于更新集群负载均衡监听器。

去调试

查询证书列表

hcloud CSS ListElbCerts/v1

该接口用于查询证书列表。

去调试

获取智能运维任务列表及详情

hcloud CSS ListAiOps/v1

CSS服务提供智能运维功能，支持检测集群潜在风险。检测任务完成后，可以查看集群存在的风险项详情，根据风险建议及时处理集群存在的风险。此接口用于获取智能运维任务列表及详情。

去调试

创建一次集群检测任务

hcloud CSS CreateAiOps/v1

该接口用于创建一个集群检测任务。

去调试

删除一个检测任务记录

hcloud CSS DeleteAiOps/v1

该接口用于删除一个检测任务记录。

去调试

获取可用的SMN主题

hcloud CSS ListSmnTopics/v1

该接口用于获取智能运维告警可用的SMN主题。

去调试

查看智能运维检测项

hcloud CSS ShowAiOpsDetector/v1

CSS服务提供智能运维功能，支持检测集群潜在风险。此接口用于获取智能运维的检测项。

去调试

查看智能运维定时检测设置

hcloud CSS ShowAiOpsSetting/v1

CSS服务提供智能运维功能的定时检测，支持每日定时检测集群的潜在风险。此接口用于获取智能运维定时检测设置。

去调试

更新智能运维定时检测设置

hcloud CSS UpdateAiOpsSetting/v1

CSS服务提供智能运维功能的定时检测，支持每日定时检测集群的潜在风险。此接口用于设置智能运维定时检测。

去调试

关闭智能运维定时检测

hcloud CSS CloseAiOpsSetting/v1

CSS服务提供智能运维功能的定时检测，支持每日定时检测集群的潜在风险。此接口用于关闭智能运维定时检测。

去调试