文档首页/ 数据仓库服务 DWS/ CLI参考/ 如何使用CLI
更新时间：2026-08-20 GMT+08:00
查看PDF
分享

如何使用CLI

华为云命令行工具服务（Koo Command Line Interface，KooCLI，原名HCloud CLI）是为发布在API Explorer上的云服务API提供的命令行管理工具。您可以通过此工具调用API Explorer中DWS开放的API，管理和使用您的DWS资源。关于KooCLI的详细信息，请参见什么是KooCLI。

安装KooCLI

在使用KooCLI前，您需要先安装KooCLI。KooCLI支持Windows、Linux和macOS三种操作系统，请根据您机器所使用的操作系统，安装对应版本的工具。

配置KooCLI初始化

使用KooCLI调用API时，需要获取调用者的身份信息用于认证鉴权。通过配置KooCLI初始化，可以把永久AK/SK信息存储在配置文件中，避免在调用API时频繁输入这些固定信息。

如果您不希望通过配置文件传入认证信息，而是直接在命令中传入认证相关参数，可跳过此步骤，具体操作可参见以无配置方式使用KooCLI。

此处以Windows系统为例介绍如何配置KooCLI的初始化，Linux和MacOS系统的操作类似。在配置初始化前，您需要提前获取AK/SK信息，具体操作请参见新增访问密钥。

  1. 打开命令行窗口。
  2. 执行以下命令进行初始化配置。 
    hcloud configure init
  3. 根据界面提示输入各参数值。 
    Access Key ID [required]:      //必填，输入AK 
 Secret Access Key [required]:      //必填，输入SK，输入内容时系统会匿名化处理
 Secret Access Key (again):      //必填，再次输入SK，输入内容时系统会匿名化处理
 Region:      //选填，输入Region

    完成后，界面提示“初始化配置成功”。

生成和执行CLI命令

KooCLI支持两种命令生成方式：

  • 通过API Explorer快速生成并获取调用API的CLI命令。推荐通过API Explorer获取CLI命令，更方便快捷。
  • 通过CLI命令查询API的操作命令和相关参数信息，然后手动拼接调用API的CLI命令，具体操作可参见查看与执行云服务操作命令。

    此处以DWS的创建集群API接口为例，介绍如何从API Explorer生成CLI命令，然后执行CLI命令调用API。

    1. 在API Explorer中，云服务选择“数据仓库服务”，然后在API列表中选择“集群管理 > 创建集群”。
    2. 在中间的参数配置界面中，填写调用API所需的参数。
    3. 在右侧界面选择“CLI示例”页签，可查看生成的CLI命令。

      创建集群API接口的CLI命令示例如下。

      hcloud DWS CreateCluster --cli-region="cn-north-4" --project_id="0f4bca096d80f3212f31c002eab9931d" --cluster.node_type="dwsx2.xlarge.m7" --cluster.number_of_node=3 --cluster.vpc_id="1f785f19-4dad-4995-b6bf-799f3f0e2580" --cluster.port=8000 --cluster.user_name="dbadmin" --cluster.name="dws-demo" --cluster.subnet_id="c6386f44-0ea8-41ec-a569-ba96d807fc9a" --cluster.user_pwd="xxxxxxxx" --cluster.tags.value="value01" --cluster.tags.key="key01"
    4. 复制生成的CLI命令，并粘贴到命令行窗口中执行。

      创建集群API的CLI命令执行结果示例如下。

      {
  "cluster" : {
    "id" : "7d85f602-a948-4a30-afd4-e84f47471c15"
  }
}

相关文档