文档首页 > > CLI使用指导(基于API Explorer)(公测中)> 华为云CLI介绍

华为云CLI介绍

分享
更新时间: 2020/08/04 GMT+08:00

什么是华为云CLI

华为云CLI(Huawei Cloud CLI,简称HCloud CLI)是配套华为云API Explorer,为华为云各服务管理类API提供的命令行管理工具。借助此工具,您可以调用华为云API Explorer中各云服务开放的API,管理和使用您的各类云服务资源。

HCloud CLI命令行工具灵活性高且易于扩展:

  1. 单一可执行文件,方便拷贝与安装。
  2. 多操作系统支持,包括 Linux、Windows、Mac等环境都可以使用CLI工具。
  3. 扩展性强,您可基于CLI工具对华为云原生API进行封装,扩展出您想要的功能,实现脚本化管理云服务资源。

CLI相关概念

在CLI指导中常用到的词语,以下做出详细介绍,方便您的阅读理解。

  • 命令

    华为云CLI工具提供的各项操作指令,用于配置CLI工具环境,或者调用华为云各服务开放的API。

    API调用命令格式如下:

    hcloud [options] <service> <operation> [--param1=paramValue1 --param2=paramValue2 ...]

    配置命令格式如下:

    hcloud <operation> [--param1=paramValue1 --param2=paramValue2 ...]

    例如以下为调用云服务API的命令,获取ECS服务的产品规格,调用API所需的公共信息从名为“aoding”的配置文件获取。

    $ hcloud ecs GetFlavors --profile=aoding

    在Windows的cmd窗口执行时,同时支持hcloud与hcloud.exe两种写法。

  • API

    华为云服务向用户开放的API。CLI工具配套华为云API Explorer使用,API可从API Explorer上查询。

    由于使用方式不同,各云服务在帮助中心的API文档中列出的API,不能在CLI工具中直接使用,需从API Explorer上查询API对应的操作名称。

  • 配置信息

    CLI工具存储在用户本地机器上的信息。CLI工具支持将调用API所需的公共信息,以及CLI的一些环境设置信息等存储在本地的配置文件中,在API调用时,您可以省去这些公共信息的输入,CLI从配置信息中获取。

    CLI存储调用API所需的公共信息包括:访问密钥(AK/SK)、区域(Region)、项目ID(Project ID)。

    环境设置信息包括:API调用返回信息的默认格式。

如何使用华为云CLI

  1. 下载CLI客户端。

    CLI支持WindowsMACLinux x86Linux arm,请根据您本地系统下载对应的客户端版本。

    请您认真阅读公测试用服务协议后,再下载使用。

  2. 配置CLI客户端环境。

    CLI客户端为免安装版,您下载到本地后解压即可使用。客户端环境配置请参考快速初始化配置

  3. 获取API调用命令。

    获取API调用有2种方式:

    • (推荐)API Explorer上获取

      CLI工具配套API Explorer,云服务的API可在API Explorer上查看。您可以在API Explorer上先配置好参数进行调试,调试成功后,从CLI页签中直接获取命令。

    • CLI客户端查询

      具体查询方法可参考查看与执行云服务操作命令,Mac和Linux环境下查询方法类似。

  4. 在CLI客户端调用API。

    调用方法参考后续章节说明。

  5. (可选)将CLI调用命令集成到您的自定义脚本中,实现云服务资源的自动化管理。
分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问