文档首页/ 华为云命令行工具服务 KooCLI/ 产品介绍/ KooCLI相关概念
更新时间：2024-04-19 GMT+08:00
查看PDF
分享

KooCLI相关概念

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

  • 命令

    KooCLI提供的各项操作指令，用于配置工作环境，或者调用云各服务开放的API。

    API调用命令格式如下：

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

    系统命令格式如下：

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

    在如下“查询云服务器信息列表”的命令中，service为“ECS”，operation为“NovaListServers”，调用API所需的公共信息从名为“default”的配置项中获取：

    hcloud ECS NovaListServers --cli-profile=default
  • operation

    operation是指云服务在API Explorer上发布的API的英文名称，可唯一表达某API。云服务的operation列表可从API Explorer上查询，或执行“hcloud <service> --help”命令获取。

  • 配置项

    配置项用于存储一组调用云服务API时所需的公共信息，由用户通过调用KooCLI命令完成配置。各配置项组成配置文件，存储在用户本地。用户在调用云服务API时，可通过指定配置项，代替这组公共信息的输入。

    配置项支持配置的公共信息包括：访问密钥（AK/SK）、区域（cli-region）、项目ID（cli-project-id）、账号ID（cli-domain-id）等。

  • 默认配置项

    当命令中未指定配置项时，默认使用的配置项。KooCLI默认将最后一次添加或修改的配置项作为默认配置项；若默认配置项被删除，将剩余配置项中最早被添加的配置项作为新的默认配置项。用户可以使用“hcloud configure set --cli-profile=${profileName}”命令切换默认配置项。

  • 参数

    参数可分为API参数和KooCLI系统参数。API参数是指云服务的API中定义的参数；系统参数是指KooCLI的内置参数，具有其固定的使用方式和特定含义。请查看系统参数列表。

  • 选项

    KooCLI选项是指可以直接在调用API的命令中添加的KooCLI系统参数，并非所有的系统参数都可作为选项使用。请查看选项列表。

  • 元数据

    KooCLI在命令执行过程中需要获取云服务及其API的详情信息，用于命令中参数的校验及解析，该数据称为元数据。远程获取的元数据会被保存在用户本地供后续使用，以减少命令执行过程中的网络IO，提高命令响应速度，保存元数据的文件称为元数据缓存文件。请查看如何管理元数据缓存文件。

    KooCLI在使用离线模式时，会下载已有元数据的合集，称为离线元数据包。