# 华为云命令行工具服务 KooCLI

> 为华为云服务API提供的命令行管理工具


## 产品介绍

- [隐私声明](https://support.huaweicloud.com/productdesc-hcli/hcli_024.md): 详见《隐私政策声明》。KooCLI的3.2.8及以后的版本在首次使用时，请您根据交互提示信息，选择是否同意其互联网连接及隐私政策声明。对于不方便交互的场景，如以自动化脚本执行KooCLI命令，可通过如下命令，配置同意隐私声明：
- [什么是KooCLI](https://support.huaweicloud.com/productdesc-hcli/hcli_01.md): 华为云命令行工具服务（Koo Command Line Interface，KooCLI，原名HCloud CLI）是为发布在API Explorer上的云服务API提供的命令行管理工具。您可以通过此工具调用API Explorer中各云服务开放的API，管理和使用您的各类云服务资源。KooCLI只提供了一种通过CLI调用云服务API的方
- [KooCLI相关概念](https://support.huaweicloud.com/productdesc-hcli/hcli_01_002.md): 在KooCLI指导中常用到的词语，以下做出详细介绍，方便您的阅读理解。命令KooCLI提供的各项操作指令，用于配置工作环境，或者调用云各服务开放的API。API调用命令格式如下：hcloud [options] <service> <operation> [--param1=paramValue1 --param2=paramValue2
- [如何使用KooCLI](https://support.huaweicloud.com/productdesc-hcli/hcli_01_003.md): KooCLI绿色免安装，下载到本地后解压即可使用。KooCLI支持Windows 64位、Linux AMD 64位、Linux ARM 64位、macOS AMD 64位、macOS ARM 64位，请根据您本地系统下载对应的版本。环境配置请参考快速初始化配置。获取云服务API调用命令有两种方式：（推荐）API Explorer上获取云
- [责任共担](https://support.huaweicloud.com/productdesc-hcli/hcli_26_001.md): 华为云秉承“将公司对网络和业务安全性保障的责任置于公司的商业利益之上”。针对层出不穷的云安全挑战和无孔不入的云安全威胁与攻击，华为云在遵从法律法规业界标准的基础上，以安全生态圈为护城河，依托华为独有的软硬件优势，构建面向不同区域和行业的完善云服务安全保障体系。与传统的本地数据中心相比，云计算的运营方和使用方分离，提供了更好的灵活性和控制力
- [身份认证与访问控制](https://support.huaweicloud.com/productdesc-hcli/hcli_26_002.md): KooCLI通过华为云API Gateway对华为云OpenAPI进行调用，其身份认证与访问控制与华为云OpenAPI保持一致。KooCLI的API调用分两种模式，一种是无身份认证的调用，当调用华为云OpenAPI中不需认证的API时用户不需要设置身份认证凭据即可调用；另一种是IAM认证后调用，当调用华为云OpenAPI中需要认证的API
- [数据保护技术](https://support.huaweicloud.com/productdesc-hcli/hcli_26_003.md): KooCLI与华为云API Gateway之间的通信传输采用https协议，有效防止数据被篡改，保护用户数据在网络中的传输安全。加密协议为业界公认安全性较高的TLS1.2、TLS1.3。用户使用KooCLI配置的认证凭据（如AK/SK）、自定义变量支持加密方式存储。 KooCLI的加密密钥在首次使用本工具时动态生成，以确保不同KooCLI
- [审计与日志](https://support.huaweicloud.com/productdesc-hcli/hcli_26_004.md): 由于KooCLI是部署在用户本地的客户端工具，工具本身记录的日志可以作为审计目的使用，但是需要用户对日志进行访问权限控制以达到审计日志不可篡改的目的。此外， 同使用SDK一样，KooCLI将用户命令解析成https请求发送到API Gateway后，API Gateway记录的相关信息也可用作审计目的。详情请见日志管理。
- [更新管理](https://support.huaweicloud.com/productdesc-hcli/hcli_26_005.md): KooCLI采用可信流水线构建，有完善的开源第三方软件管理流程，在每次版本发布时确保使用的开源第三方软件都是没有高危漏洞的。当业界公布最新的高危漏洞软件时， KooCLI如果涉及会发布修复后的相关版本供用户下载或更新。详情请见版本更新。
- [认证证书](https://support.huaweicloud.com/productdesc-hcli/hcli_26_006.md): 华为云服务及平台通过了多项国内外权威机构（ISO/SOC/PCI等）的安全合规认证，用户可自行申请下载合规资质证书。合规证书下载华为云还提供以下资源来帮助用户满足合规性要求，具体请查看资源中心。资源中心华为云安全服务提供了网络安全专用产品安全检测证书、软件著作权等证书，供用户下载和参考。具体请查看合规资质证书。网络安全专用产品安全检测证书
- [风险防范](https://support.huaweicloud.com/productdesc-hcli/hcli_26_007.md): 我们强烈建议您：在.hcloud目录及其子目录和文件上配置适当的文件系统权限，仅限授权用户访问。在使用敏感变量时对变量值进行加密，以防止敏感信息泄露。尽可能使用临时认证凭据以降低认证凭据泄露时带来的风险。

## 快速入门

- [入门流程](https://support.huaweicloud.com/qs-hcli/hcli_02.md): 本节以Windows系统为例介绍KooCLI的使用，Linux和MacOS系统的使用基本相同，可参考。KooCLI最基础的入门操作包括：快速安装、初始化配置信息，查看与执行云服务操作命令。图1为KooCLI大致的入门流程，本入门指导旨在帮助您对其操作有初步的认识。
- [步骤一：准备工作](https://support.huaweicloud.com/qs-hcli/hcli_02_002.md): 在使用KooCLI前，您需要完成本文中的准备工作。注册华为账号并完成实名认证创建IAM用户并授权获取访问密钥（AK/SK）如果您已有一个华为账号，请跳到下一个任务。如果您还没有华为账号，请参考以下步骤创建。使用KooCLI管理和使用您的各类云服务资源时，需提供调用者（IAM用户）的身份信息用于认证鉴权。IAM用户是由华为账号在IAM中创建
- [概述](https://support.huaweicloud.com/qs-hcli/hcli_02_003.md): 针对不同的环境，您可以参考如下方式完成快速安装：在Windows系统上安装KooCLI在Linux系统上安装KooCLI在MacOS系统上安装KooCLI在Docker中配置和使用KooCLI在Windows系统上安装KooCLI在Linux系统上安装KooCLI在MacOS系统上安装KooCLI在Docker中配置和使用KooCLI您也
- [在Windows系统上安装KooCLI](https://support.huaweicloud.com/qs-hcli/hcli_02_003_01.md): Windows 10 和 Windows 8 搜索并选择“查看高级系统设置”，然后单击“环境变量”；Windows 7 右键单击桌面上的“计算机”图标，从菜单中选择“属性”。单击“高级系统设置”链接，然后单击“环境变量”。Windows 7 右键单击桌面上的“计算机”图标，从菜单中选择“属性”。单击“高级系统设置”链接，然后单击“环境变量
- [在Linux系统上安装KooCLI](https://support.huaweicloud.com/qs-hcli/hcli_02_003_02.md): KooCLI支持Linux AMD 64位 和 ARM 64位操作系统，您可以根据需要选择一键式安装或分步安装。分步安装时请根据您的操作系统选择相应的安装命令。执行如下命令可查看您主机的操作系统：若执行如上命令的输出值是“x86_64”，请使用AMD 64位系统的下载命令；若执行如上命令的输出值是“aarch64”，请使用ARM 64位系
- [在MacOS系统上安装KooCLI](https://support.huaweicloud.com/qs-hcli/hcli_02_003_03.md): KooCLI支持MacOS AMD 64位 和 ARM 64位操作系统，您可以根据需要选择一键式安装或分步安装。分步安装时请根据您的操作系统选择相应的安装命令。执行如下命令查看您主机的操作系统：若执行如上命令的输出值是“x86_64”，请使用AMD 64位系统的下载命令；若执行该命令输出结果为空，请使用如下命令查看您主机的操作系统：执行如
- [在Docker中配置和使用KooCLI](https://support.huaweicloud.com/qs-hcli/hcli_02_003_05.md): 在Docker中配置和使用KooCLI，请遵循如下步骤（以创建Linux系统ubuntu发行版的Docker容器为例）：在按步骤执行之前，请确保您已经安装Docker。有关安装说明，请参阅 Docker 网站。可运行以下命令确认是否安装Docker：新建目录并在该目录下创建名为Dockerfile的纯文本文件，文件内容如下：Dockerf
- [步骤三：初始化配置（可选）](https://support.huaweicloud.com/qs-hcli/hcli_02_004.md): 本节以Windows系统为例介绍KooCLI的使用，Linux和Mac系统的使用基本相同，可参考。如果您希望以无配置方式使用KooCLI，可跳过此步骤；若您希望以非交互方式添加配置项，请参考新增或修改配置项。KooCLI初始化命令用于将常用的永久AK/SK和区域信息存储在配置文件中，如下表所示，避免使用时频繁输入这些固定信息：可通过如下命
- [步骤四：查看与执行云服务操作命令](https://support.huaweicloud.com/qs-hcli/hcli_02_005.md): 本节以Windows系统为例介绍KooCLI的使用，Linux和Mac系统的使用基本相同，可参考。完成初始化配置后，即可查询KooCLI支持的云服务列表，并执行相关命令。下文以弹性云服务器（ECS）的查询云服务器详情的API为例，说明如何查找与执行命令。hcloud <service> --help如下所示，“Available Oper
- [修改已初始化的配置项](https://support.huaweicloud.com/qs-hcli/hcli_02_006.md): KooCLI目前支持在配置项中以如下组合方式配置认证参数：访问密钥（永久AK/SK），临时安全凭证（临时AK/SK和SecurityToken）两种。其中，临时安全凭证（临时AK/SK和SecurityToken）具有时效性。初始化配置信息时，配置项的名称为“default”，且初始化时配置项中只允许配置永久AK/SK。如果您要使用其他认

## 用户指南

- [配置命令简介](https://support.huaweicloud.com/usermanual-hcli/hcli_03_001.md): KooCLI配置命令包含初始化配置、配置项的增删改查等，具体命令如下表：
- [初始化配置](https://support.huaweicloud.com/usermanual-hcli/hcli_03_002.md): KooCLI初始化命令用于将常用的永久AK/SK和区域信息存储在配置文件中，避免执行操作时频繁输入这些固定信息。可通过如下命令初始化配置：hcloud configure init输入以上命令并按回车后，会逐步提示您输入Access Key ID（必填）、Secret Access Key（必填）、默认或常用的Region（非必填）。
- [配置项参数概述](https://support.huaweicloud.com/usermanual-hcli/hcli_03_003_03.md): 如果您需要同时在多个区域或多个项目下管理资源，或者同时使用多个账号，可以通过增加配置项的方式，存储多个不同场景的固定信息。已配置多个配置项的情况下，您可在命令中以“--cli-profile”指定要操作或使用的配置项的名称。KooCLI配置项中可修改的参数如下表所示。参数“--cli-custom”的取值可标识向配置项中设置的参数类型：当
- [设置配置项中的系统参数](https://support.huaweicloud.com/usermanual-hcli/hcli_03_003_01.md): 设置配置项中的系统参数的示例如下：增加配置项新增配置项时，以“--cli-profile”声明配置项的名称，示例如下：新增认证模式为AK/SK的配置项，其中认证参数为访问密钥，即永久AK（cli-access-key）和SK（cli-secret-key）：hcloud configure set --cli-profile=testAK
- [设置配置项中的custom参数](https://support.huaweicloud.com/usermanual-hcli/hcli_03_003_02.md): KooCLI支持向配置项中设置custom参数，方便用户集中管理命令中高频使用，参数值过长，或需要对其值加密处理的参数。使用如下命令进入交互模式，根据提示新增或修改配置项中的custom参数：hcloud configure set [--cli-profile=${profileName}] --cli-custom=truecusto
- [SSO登录](https://support.huaweicloud.com/usermanual-hcli/hcli_03_009.md): KooCLI的SSO登录命令通过完成SSO登录，将用户的认证信息存储在配置文件中，避免执行操作时频繁输入这些固定信息。可通过如下命令进行SSO登录：hcloud configure sso输入以上命令并回车后，会逐步提示您输入SSO profile name（此SSO登录后要保存的配置项名称，必填）、SSO start URL（用户门户U
- [查询配置项列表中的系统参数](https://support.huaweicloud.com/usermanual-hcli/hcli_03_004_01.md): KooCLI支持多配置项，查询配置项列表中的系统参数的命令如下，查询结果支持以table，json或tsv格式输出，默认以json格式输出：hcloud configure list其中，敏感参数的值会被匿名化展示。可以使用“--cli-query”对查询结果进行过滤。使用“--cli-query”时，默认以json格式输出，可同时使用“
- [查询配置项列表中的custom参数](https://support.huaweicloud.com/usermanual-hcli/hcli_03_004_02.md): 查询KooCLI配置项列表中的custom参数的命令如下，查询结果支持以table，json或tsv格式输出，默认以json格式输出：hcloud configure list --cli-custom=true其中，加密保存的custom参数值会被匿名化展示。可以使用“--cli-query”对查询结果进行过滤，使用“--cli-que
- [查询指定配置项中的系统参数](https://support.huaweicloud.com/usermanual-hcli/hcli_03_005_01.md): 使用“--cli-profile”指定要查询的配置项的名称，缺省时查询默认配置项。支持以table，json或tsv格式输出，默认以json格式输出。查看指定配置项中的系统参数的命令为：hcloud configure show [--cli-profile=${profileName}]
- [查询指定配置项中的custom参数](https://support.huaweicloud.com/usermanual-hcli/hcli_03_005_02.md): 使用“--cli-profile”指定要查询的配置项的名称，支持以table，json或tsv格式输出，默认为json格式。查看指定配置项中的custom参数的命令为：hcloud configure show [--cli-profile=${profileName}] --cli-custom=true
- [删除指定配置项及其custom参数](https://support.huaweicloud.com/usermanual-hcli/hcli_03_006_01.md): 使用“--cli-profile”指定要删除的配置项的名称。删除指定配置项的命令为：hcloud configure delete --cli-profile=${profileName}删除配置项时，会同时删除其中的系统参数和custom参数。
- [删除指定配置项中的custom参数](https://support.huaweicloud.com/usermanual-hcli/hcli_03_006_02.md): 使用“--cli-profile”指定要删除的配置项的名称。删除指定配置项中的custom参数的命令可分为：删除指定配置项中的指定custom参数：hcloud configure delete --cli-profile=${profileName} [--cli-custom=true] --cli-custom-key=${cust
- [检查配置文件格式](https://support.huaweicloud.com/usermanual-hcli/hcli_03_007.md): 为快速检验本地配置文件的格式是否正确，可执行如下命令：hcloud configure test
- [删除所有配置项](https://support.huaweicloud.com/usermanual-hcli/hcli_03_008.md): 可执行如下命令，经交互确认后即可删除所有配置项：hcloud configure clear
- [配置HTTP代理](https://support.huaweicloud.com/usermanual-hcli/hcli_22_001.md): 用户在使用KooCLI管理和使用云服务的资源时，可能会因为用户所在公司的内网访问限制，导致调用云服务API失败。此时，用户可使用HTTP代理访问。使用HTTP代理需要配置环境变量http_proxy和https_proxy。请根据您系统选择并执行如下命令，配置http_proxy环境变量。Linux或MacOS系统临时环境变量配置http
- [解决证书x509问题](https://support.huaweicloud.com/usermanual-hcli/hcli_22_002.md): KooCLI管理和使用云服务的资源，用户在配置了HTTP代理的情况下，可能会出现调用云服务API时报错 x509 的问题。其原因是您公司代理修改了https网站颁发的根证书，导致访问外网的https资源时报证书无效的错误。您可以通过在命令中添加“--cli-skip-secure-verify=true”跳过证书校验（不建议）。推荐的做法
- [查看帮助信息](https://support.huaweicloud.com/usermanual-hcli/hcli_04_001.md): KooCLI支持在命令中添加“--help”参数查看帮助信息，例如：hcloud --help查看KooCLI的使用方法及支持的云服务列表。查看KooCLI的使用方法及支持的云服务列表。hcloud <service> --help查看指定云服务的operation列表。例如查看“ECS”服务的operation列表：hcloud ECS
- [自动补全](https://support.huaweicloud.com/usermanual-hcli/hcli_04_002.md): KooCLI开启自动补全后，在输入命令时使用“Tab”键，会根据已有命令提示其待补全的内容。开启自动补全功能：hcloud auto-complete on关闭自动补全功能：hcloud auto-complete off自动补全功能仅支持bash。自动补全提示参数时，若提示的参数名中有“[N]”，其含义为索引位，请使用数字代替该字符；若
- [交互式提示](https://support.huaweicloud.com/usermanual-hcli/hcli_04_007.md): KooCLI支持功能强大的多平台支持的交互式提示，方便命令构建，在命令中添加“--interactive”参数即可进入交互式提示。交互式中根据用户当前输入的内容，提示云服务名称，API的operation，参数及其描述信息，也提供部分参数值的补全功能。交互式的使用方式如下：交互模式中使用“Tab”或向上箭头、向下箭头键实现待补全内容的上下
- [元数据管理](https://support.huaweicloud.com/usermanual-hcli/hcli_04_003.md): 清理元数据缓存KooCLI会缓存API调用过程中获取并保存在用户本地的元数据缓存文件，放置在如下目录下：在线模式：Windows系统： C:\Users\{您的Windows系统用户名}\.hcloud\metaRepo\Linux系统: /home/{当前用户名}/.hcloud/metaRepo/Mac系统： 
- [查询当前版本](https://support.huaweicloud.com/usermanual-hcli/hcli_04_004.md): 查询KooCLI当前版本的命令为：hcloud version
- [版本更新](https://support.huaweicloud.com/usermanual-hcli/hcli_04_005.md): KooCLI支持本地更新， 运行更新命令经交互确认后可将其升级至最新版本。 更新命令如下：hcloud update执行版本更新命令时，在命令中添加“-y”参数，可跳过交互确认，直接更新：
- [日志管理](https://support.huaweicloud.com/usermanual-hcli/hcli_04_006.md): KooCLI提供日志记录和管理功能，会缓存API调用过程中产生的日志信息，日志文件保存目录如下：Windows系统： C:\Users\{您的Windows系统用户名}\.hcloud\log\Linux系统: /home/{当前用户名}/.hcloud/log/Mac系统： /Users/{当前用户名}
- [模板管理](https://support.huaweicloud.com/usermanual-hcli/hcli_04_008.md): KooCLI提供由多条KooCLI命令组合而成的shell脚本模板，方便用户理清业务逻辑，完成复杂场景下的操作。用户可根据实际需要下载相应的模板，修改后执行即可。可使用如下命令，进行模板的查看和下载操作。查询已有模板列表：hcloud template list用户可根据查询结果中的模板的“description”了解模板的用途；单击其“
- [管理OBS中的数据](https://support.huaweicloud.com/usermanual-hcli/hcli_04_009.md): 在KooCLI中，已经集成了以命令行方式管理OBS数据的工具obsutil的功能。您可以通过使用"hcloudobs"命令，快速管理您在OBS中的数据。您可以使用KooCLI进行如下操作，管理您OBS中的数据：使用KooCLI管理OBS数据之前，您需要配置其与OBS的对接信息，包括OBS终端节点地址（Endpoint）和访问密钥（AK和S
- [管理CCE集群](https://support.huaweicloud.com/usermanual-hcli/topic_0000002622078243.md): 在KooCLI中，集成了以命令行方式管理CCE集群的功能。您可以通过使用如下命令，管理您的CCE集群，具体使用方式请参见通过KooCLI+kubectl连接集群。
- [选项概述](https://support.huaweicloud.com/usermanual-hcli/hcli_05_01.md): KooCLI选项是指可以直接在调用API的命令中添加的系统参数，KooCLI支持的选项及其功能如下表所示。其中除“help”，“debug”，“dryrun”，“cli-output”，“cli-query”，“cli-output-num”，“cli-jsonInput”，“cli-endpoint”之外，其余选项支持被设置到配置项中。
- [打印帮助信息](https://support.huaweicloud.com/usermanual-hcli/hcli_05_02.md): KooCLI支持查看命令的帮助信息。例如查看“RDS”服务operation为“ListCollations”的API的帮助信息：
- [打印命令调用过程中的调试信息](https://support.huaweicloud.com/usermanual-hcli/hcli_05_03.md): KooCLI支持打印命令执行过程中的调试信息。在命令中添加“--debug”即可：
- [生成JSON格式API入参骨架](https://support.huaweicloud.com/usermanual-hcli/hcli_05_19.md): skeleton选项用于生成JSON格式API入参骨架。在命令中添加“--skeleton”选项，则在当前目录生成该API的JSON格式的入参文件，用户可填写文件中的参数值，以“--cli-jsonInput=${JSON文件名}”传入参数，调用API：该JSON文件的内容如下：生成的JSON文件分为上下两部分，上半部分为cli-json
- [检查命令正确性](https://support.huaweicloud.com/usermanual-hcli/hcli_05_14.md): dryrun选项用于检查所传入命令的正确性。在命令中添加“--dryrun”选项，执行校验后打印请求报文，跳过实际运行，不调用目标API：
- [指定区域](https://support.huaweicloud.com/usermanual-hcli/hcli_05_04.md): KooCLI除了可以从配置项读取区域信息外，还可以在命令中传入cli-region值，如下：不同区域，项目也不同，因此指定区域时，一般需要同时指定项目ID。
- [以无配置方式AKSK调用云服务API](https://support.huaweicloud.com/usermanual-hcli/hcli_05_06.md): KooCLI支持在命令中添加“--cli-access-key”，“--cli-secret-key”和“--cli-security-token”选项，以无配置方式AKSK调用云服务API。当命令中仅使用“--cli-access-key”和“--cli-secret-key”时，默认识别该AK，SK为永久AK/SK：当命令中同时使用“
- [以无配置方式AssumeRole调用云服务API](https://support.huaweicloud.com/usermanual-hcli/hcli_05_17.md): 当委托方用户创建委托，将资源交由其他账号管理后，被委托方可以在命令中添加“--cli-agency-domain-id”/“--cli-agency-domain-name”，“--cli-agency-name”和“--cli-source-profile”选项，使用以无配置方式AssumeRole调用云服务API，管理和使用委托方的资
- [指定用户所属账号ID](https://support.huaweicloud.com/usermanual-hcli/hcli_05_08.md): KooCLI以AKSK模式调用全局服务的API时，需添加账号ID（即cli-domain-id）。KooCLI会在调用全局服务的API的过程中，根据用户认证信息自动获取账号ID，用户也可在命令中添加“--cli-domain-id”选项，如下：
- [指定配置项](https://support.huaweicloud.com/usermanual-hcli/hcli_05_09.md): KooCLI支持多配置项，用户可将常用的AK/SK，区域等信息保存到配置项中。使用时通过“--cli-profile”指定目标配置项的名称即可，如下：
- [指定配置项的认证模式](https://support.huaweicloud.com/usermanual-hcli/hcli_05_10.md): KooCLI的配置项的认证模式取值为AKSK、ecsAgency、SSO、AssumeRole，推荐使用AKSK。当使用的配置项同时配置了多种认证模式相关的参数，用户可使用“--cli-mode”选项来指定配置项的认证模式：设置配置项时，需要以“--cli-profile”指定配置项的名称，同时还需根据认证模式“--cli-mode”添加
- [指定结果的输出格式](https://support.huaweicloud.com/usermanual-hcli/hcli_05_11.md): 命令中使用“--cli-query”传入JMESPath表达式，对结果执行JMESPath查询，方便提炼原返回结果中的关键信息；“--cli-output”指定响应数据的输出格式；“--cli-output-num”指定当使用table格式输出时，是否打印行号。使用“--cli-query”指定的JMESPath表达式不同，输出的结果中各
- [以JSON文件的方式传递API参数](https://support.huaweicloud.com/usermanual-hcli/hcli_05_12.md): KooCLI调用云服务的API时，如果API的参数过多，不便直接在命令中传入，用户可通过“--cli-jsonInput”将云服务API的部分或全部参数以JSON文件的形式输入。剩余的其他参数，例如KooCLI系统参数、未通过JSON文件传入的云服务API参数等，仍可在命令中传入，例如：通过“--cli-jsonInput”选项传入API
- [指定请求超时时间](https://support.huaweicloud.com/usermanual-hcli/hcli_05_13.md): cli-connect-timeout，cli-read-timeout 选项用于设置请求超时时间。其中请求连接超时时间“--cli-connect-timeout”默认值为5秒，I/O超时时间“--cli-read-timeout”默认值为10秒：命令中可同时使用“--cli-connect-timeout”和“--cli-read-t
- [指定请求连接重试次数](https://support.huaweicloud.com/usermanual-hcli/hcli_05_15.md): cli-retry-count选项用于指定请求连接重试次数。即：在请求超时（因网络连接问题导致请求失败）的情况下会自动重试。“--cli-retry-count”的默认取值为0次，参数取值范围为0~5次：若因网络连接问题导致请求失败，KooCLI会提示如下信息：hcloud RDS ListInstances --cli-region="
- [跳过https请求证书验证](https://support.huaweicloud.com/usermanual-hcli/hcli_05_16.md): cli-skip-secure-verify选项用于指定是否跳过https请求证书验证(不建议)。当用户已配置HTTP代理，KooCLI调用云服务的API时，可能会因证书校验失败，导致请求报错x509。用户可在命令中添加“--cli-skip-secure-verify=true”后执行原命令，在执行时会向用户交互以确认是否跳过https
- [自定义请求域名](https://support.huaweicloud.com/usermanual-hcli/hcli_05_18.md): cli-endpoint用于自定义请求云服务的域名。KooCLI默认会请求对应区域的目标云服务，您也可以针对该云服务指定Endpoint：
- [结果轮询](https://support.huaweicloud.com/usermanual-hcli/hcli_05_20.md): cli-waiter用于结果轮询，参数应为JSON格式且使用双引号包裹。您可以使用此参数进行结果轮询：cli-waiter的取值中，每个字段的含义如下：- expr required string 使用JMESPath表达式指定被轮询字段- to required string 被轮询字段的目标值- tim
- [指定签名算法](https://support.huaweicloud.com/usermanual-hcli/hcli_05_21.md): cli-auth-type用于指定AKSK的签名方式，在需指定特殊签名算法时添加此参数。目前参数支持的值为“derivedSign”，在使用aksk方式调用iotda服务时使用。
- [指定项目ID](https://support.huaweicloud.com/usermanual-hcli/hcli_05_22.md): cli-x-project-id用于指定项目ID，用于认证鉴权，在需指定请求头中项目ID时添加此参数。
- [在API Explorer上获取CLI示例](https://support.huaweicloud.com/usermanual-hcli/hcli_06.md): API Explorer上开放的各云服务API，除了支持在线调试，还能生成KooCLI命令示例（以下简称CLI示例）。您在API Explorer界面上填写API参数，在其对应的“CLI示例”中可直接拷贝使用。下图为API Explorer上CDN服务的创建加速域名API。在API Explorer页面填写完成各项请求参数后，CLI示例会
- [无配置方式使用概述](https://support.huaweicloud.com/usermanual-hcli/hcli_07_001.md): KooCLI既可以使用配置项调用云服务API，也提供了无配置的操作方式，无配置方式使用是指在使用KooCLI时不通过已有配置项传入当前用户的认证信息，而是直接在命令中传入当前用户认证相关的参数。此方式可使用户免于添加配置项，方便快捷地使用KooCLI。用户可以通过如下认证方式直接调用云服务API：无配置方式AKSK无配置方式ecsAgen
- [无配置方式AKSK](https://support.huaweicloud.com/usermanual-hcli/hcli_07_002.md): 访问密钥（永久AK/SK）用户可以在命令中直接输入永久AK（cli-access-key）和SK（cli-secret-key）调用云服务API：hcloud ECS NovaListServers --cli-region="cn-north-4" --project_id="4ff018c3******************f319
- [无配置方式ecsAgency](https://support.huaweicloud.com/usermanual-hcli/hcli_07_005.md): 在用户已成功建立向弹性云服务器（ECS）的委托的前提下，在ECS服务器中使用KooCLI时，可以在命令中指定“--cli-mode=ecsAgency”，KooCLI将基于ECS委托，自动获取临时的AK/SK和SecurityToken用于认证。此认证方式要求用户已经建立了ECS服务器委托。若该委托尚未建立，可以在IAM对该弹性云服务器进
- [获取永久AK/SK](https://support.huaweicloud.com/usermanual-hcli/hcli_09_001.md): 访问密钥（AK和SK）是IAM的一种认证机制，用于对请求加密签名，确保请求的机密性、完整性和请求双方身份的正确性：AK（Access Key ID）：访问密钥ID，是与私有访问密钥关联的唯一标识符。访问密钥ID和私有访问密钥一起使用，对请求进行加密签名。SK（Secret Access Key）：与访问密钥ID结合使用的密钥，对请求进行加
- [获取账号ID、项目ID](https://support.huaweicloud.com/usermanual-hcli/hcli_09_002.md): 在调用云服务API的时候，大多数场景需要填入项目ID。项目ID获取步骤如下：项目用于对云服务器资源进行物理隔离，默认有区域级别的隔离，也可在区域下建立多项目，做更细级别的隔离。因此，请参考下图，在项目列表中找到您的服务器资源对应的所属区域，在其左侧获取对应区域的项目ID，单击其左侧的图标可获取对应区域下的子项目ID。KooCLI可在API
- [获取区域](https://support.huaweicloud.com/usermanual-hcli/hcli_09_003.md): 在调用云服务API的时候，需要指定区域。请参见终端节点及区域说明。KooCLI在指定的区域中管理云服务资源。
- [获取临时AK/SK和securitytoken](https://support.huaweicloud.com/usermanual-hcli/hcli_09_005.md): 临时AK/SK和securitytoken是系统颁发给IAM用户的临时访问令牌，有效期可在15分钟至24小时范围内设置，过期后需要重新获取。临时AK/SK和securitytoken遵循权限最小化原则。请参见获取临时AK/SK和securitytoken。

## 常见问题

- [概述](https://support.huaweicloud.com/hcli_faq/hcli_10.md): KooCLI将调用命令时出现的错误分为五种类型，在错误提示信息的起始位置声明其具体类型：[NETWORK_ERROR]，[CLI_ERROR]，[USE_ERROR]，[OPENAPI_ERROR]和[APIE_ERROR]。各类错误的定位方法如下：[NETWORK_ERROR]：一般是HTTP请求异常，请检查网络连接；[CLI_ERRO
- [获取认证信息](https://support.huaweicloud.com/hcli_faq/hcli_11_001.md): 请参考获取永久AK/SK。请参考获取账号ID、项目ID。请参考终端节点及区域说明。请参考获取临时AK/SK和securitytoken。
- [认证方式优先级](https://support.huaweicloud.com/hcli_faq/hcli_11_002.md): KooCLI在命令解析过程中，依照如下优先级使用其认证方式，完成调用API时的认证流程：无配置方式AKSK认证：无配置方式AKSK：命令中直接输入访问密钥（永久AK/SK，即cli-access-key和cli-secret-key）或临时安全凭证（临时AK/SK和SecurityToken，即cli-access-key，cli-sec
- [获取认证信息](https://support.huaweicloud.com/hcli_faq/hcli_11_001.md): 请参考获取永久AK/SK。请参考获取账号ID、项目ID。请参考终端节点及区域说明。请参考获取临时AK/SK和securitytoken。
- [认证方式优先级](https://support.huaweicloud.com/hcli_faq/hcli_11_002.md): KooCLI在命令解析过程中，依照如下优先级使用其认证方式，完成调用API时的认证流程：无配置方式AKSK认证：无配置方式AKSK：命令中直接输入访问密钥（永久AK/SK，即cli-access-key和cli-secret-key）或临时安全凭证（临时AK/SK和SecurityToken，即cli-access-key，cli-sec
- [命令中未指定配置项时默认使用哪个配置项？](https://support.huaweicloud.com/hcli_faq/hcli_12_001.md): 通过KooCLI管理和使用您的各类云服务资源，在调用云服务的API时，KooCLI优先使用命令中“--cli-profile”选项指定的配置项。如您未在命令中指定配置项，会使用默认配置项来调用目标API。若该配置项的内容与目标API不匹配，或缺少访问目标API时需要的某参数，会提示相关错误，例如：[USE_ERROR]请输入cli-reg
- [命令中未指定配置项时默认使用哪个配置项？](https://support.huaweicloud.com/hcli_faq/hcli_12_001.md): 通过KooCLI管理和使用您的各类云服务资源，在调用云服务的API时，KooCLI优先使用命令中“--cli-profile”选项指定的配置项。如您未在命令中指定配置项，会使用默认配置项来调用目标API。若该配置项的内容与目标API不匹配，或缺少访问目标API时需要的某参数，会提示相关错误，例如：[USE_ERROR]请输入cli-reg
- [元数据缓存文件存于何处？如何清理？](https://support.huaweicloud.com/hcli_faq/hcli_13_001.md): 通过KooCLI管理和使用您的各类云服务资源时，会远程获取您命令中目标云服务及其API的详情信息。为减少远程调用次数，提高响应速度，KooCLI引入了缓存机制，在运行过程中将云服务及其API的相关信息保存在本地缓存文件中，该文件称为元数据缓存文件。在元数据缓存文件过期前，会使用该文件中的信息对命令中的参数进行校验和组装。元数据缓存文件的存
- [元数据缓存文件存于何处？如何清理？](https://support.huaweicloud.com/hcli_faq/hcli_13_001.md): 通过KooCLI管理和使用您的各类云服务资源时，会远程获取您命令中目标云服务及其API的详情信息。为减少远程调用次数，提高响应速度，KooCLI引入了缓存机制，在运行过程中将云服务及其API的相关信息保存在本地缓存文件中，该文件称为元数据缓存文件。在元数据缓存文件过期前，会使用该文件中的信息对命令中的参数进行校验和组装。元数据缓存文件的存
- [日志文件存于何处？](https://support.huaweicloud.com/hcli_faq/hcli_14_001.md): KooCLI会记录您使用过程中产生的日志信息。日志记录功能暂不支持关闭。日志文件名称为“hcloud.log”，日志文件的存放位置如下：Linux系统：/home/{当前用户名}/.hcloud/log/Windows系统：C:\Users\{当前用户名}\.hcloud\log\Mac系统：/Users/{当前用户名}/.hcloud/
- [日志文件存于何处？](https://support.huaweicloud.com/hcli_faq/hcli_14_001.md): KooCLI会记录您使用过程中产生的日志信息。日志记录功能暂不支持关闭。日志文件名称为“hcloud.log”，日志文件的存放位置如下：Linux系统：/home/{当前用户名}/.hcloud/log/Windows系统：C:\Users\{当前用户名}\.hcloud\log\Mac系统：/Users/{当前用户名}/.hcloud/
- [如何解决网络连接超时问题？](https://support.huaweicloud.com/hcli_faq/hcli_15_001.md): KooCLI调用云服务API的过程中，会对您输入参数的合法性进行校验，此校验过程可能需要远程获取该云服务和API的详情信息；在参数校验完成后，亦需要远程调用您的目标API。如在调用过程中因网络连接问题导致请求失败，会提示相关错误，例如：[NETWORK_ERROR]连接超时,请检查网络连通性[USE_ERROR]调用API超时,请先检查配
- [如何解决网络连接超时问题？](https://support.huaweicloud.com/hcli_faq/hcli_15_001.md): KooCLI调用云服务API的过程中，会对您输入参数的合法性进行校验，此校验过程可能需要远程获取该云服务和API的详情信息；在参数校验完成后，亦需要远程调用您的目标API。如在调用过程中因网络连接问题导致请求失败，会提示相关错误，例如：[NETWORK_ERROR]连接超时,请检查网络连通性[USE_ERROR]调用API超时,请先检查配
- [提示不支持的服务时如何处理？](https://support.huaweicloud.com/hcli_faq/hcli_16_001.md): KooCLI调用云服务API的过程中，会对您输入参数的合法性进行校验。如果您命令中云服务的名称输入有误，或调用的云服务未在KooCLI上线，会提示相关错误：[USE_ERROR]不支持的服务名称:*如遇如上情形，您可先通过执行“hcloud --help”命令，查看当前支持的所有云服务，确认服务名称是否有误；如您确认服务名无误，但是上一步
- [提示不支持的服务时如何处理？](https://support.huaweicloud.com/hcli_faq/hcli_16_001.md): KooCLI调用云服务API的过程中，会对您输入参数的合法性进行校验。如果您命令中云服务的名称输入有误，或调用的云服务未在KooCLI上线，会提示相关错误：[USE_ERROR]不支持的服务名称:*如遇如上情形，您可先通过执行“hcloud --help”命令，查看当前支持的所有云服务，确认服务名称是否有误；如您确认服务名无误，但是上一步
- [提示不支持的operation时如何处理？](https://support.huaweicloud.com/hcli_faq/hcli_17_001.md): KooCLI调用云服务API的过程中，会对您输入参数的合法性进行校验。如果您命令中API的operation输入有误，或该API未在KooCLI上线，会提示如下错误：[USE_ERROR]不支持的operation: *如遇如上情形，您可先通过执行“hcloud <service> --help”命令，查看该云服务支持的operation
- [如何指定云服务的API和版本号？](https://support.huaweicloud.com/hcli_faq/hcli_17_002.md): KooCLI调用云服务API的过程中，会对您输入参数的合法性进行校验。若您当前调用的云服务是多版本服务，即意味着该服务中的部分或全部API有多个版本。因同一API不同版本的参数、使用场景等可能存在差异，故需获取多版本服务API的版本信息。版本查询您可以通过“hcloud <service> --help”命令，查看该云服务的operati
- [云服务API的响应体为空时，如何判断命令是否执行成功？](https://support.huaweicloud.com/hcli_faq/hcli_17_003.md): 使用KooCLI调用部分云服务的API时，API的返回结果为空，CLI不会打印相应返回体，用户无法确认是否调用成功。在原命令中添加“--debug”参数，可打印命令调用过程中的调试信息。其中包含一行内容为“API response status code is xxx.”。用户可以根据该返回体的状态码判断命令是否成功调用。
- [提示不支持的operation时如何处理？](https://support.huaweicloud.com/hcli_faq/hcli_17_001.md): KooCLI调用云服务API的过程中，会对您输入参数的合法性进行校验。如果您命令中API的operation输入有误，或该API未在KooCLI上线，会提示如下错误：[USE_ERROR]不支持的operation: *如遇如上情形，您可先通过执行“hcloud <service> --help”命令，查看该云服务支持的operation
- [如何指定云服务的API和版本号？](https://support.huaweicloud.com/hcli_faq/hcli_17_002.md): KooCLI调用云服务API的过程中，会对您输入参数的合法性进行校验。若您当前调用的云服务是多版本服务，即意味着该服务中的部分或全部API有多个版本。因同一API不同版本的参数、使用场景等可能存在差异，故需获取多版本服务API的版本信息。版本查询您可以通过“hcloud <service> --help”命令，查看该云服务的operati
- [云服务API的响应体为空时，如何判断命令是否执行成功？](https://support.huaweicloud.com/hcli_faq/hcli_17_003.md): 使用KooCLI调用部分云服务的API时，API的返回结果为空，CLI不会打印相应返回体，用户无法确认是否调用成功。在原命令中添加“--debug”参数，可打印命令调用过程中的调试信息。其中包含一行内容为“API response status code is xxx.”。用户可以根据该返回体的状态码判断命令是否成功调用。
- [提示缺少cli-region参数时如何处理？](https://support.huaweicloud.com/hcli_faq/hcli_18_001.md): 使用KooCLI调用所有云服务的API时，都需要指定区域（即cli-region）。如果您未在命令中指定cli-region值，且您当前使用的配置项中也未配置cli-region值，会提示如下错误：[USE_ERROR]请输入cli-region如遇如上情形，若您未在命令中指定cli-region值，您可在当前命令中添加“--cli-re
- [提示不支持的cli-region时如何处理？](https://support.huaweicloud.com/hcli_faq/hcli_18_002.md): 使用KooCLI调用所有云服务的API时，都需要提供合适的cli-region。如果您遇到如下几种情况：命令中cli-region值输入有误；命令指定了cli-region值，但目标API不支持该cli-region；命令中未指定cli-region值，目标API不支持从当前配置项中获取的cli-region。会提示如下错误：[USE_E
- [提示缺少cli-region参数时如何处理？](https://support.huaweicloud.com/hcli_faq/hcli_18_001.md): 使用KooCLI调用所有云服务的API时，都需要指定区域（即cli-region）。如果您未在命令中指定cli-region值，且您当前使用的配置项中也未配置cli-region值，会提示如下错误：[USE_ERROR]请输入cli-region如遇如上情形，若您未在命令中指定cli-region值，您可在当前命令中添加“--cli-re
- [提示不支持的cli-region时如何处理？](https://support.huaweicloud.com/hcli_faq/hcli_18_002.md): 使用KooCLI调用所有云服务的API时，都需要提供合适的cli-region。如果您遇到如下几种情况：命令中cli-region值输入有误；命令指定了cli-region值，但目标API不支持该cli-region；命令中未指定cli-region值，目标API不支持从当前配置项中获取的cli-region。会提示如下错误：[USE_E
- [KooCLI系统参数包括哪些？](https://support.huaweicloud.com/hcli_faq/hcli_19_001.md): KooCLI系统参数是指其内置参数，各系统参数的描述信息及其使用方式如下表所示：对上表中所列的各参数使用方式解释如下：仅支持配置于配置项后使用：指该参数只可以通过“hcloud configure set --key1=value1 --key2=value2 ...”命令配置到配置项后再使用。使用时在命令中通过“--cli-profil
- [提示不正确的参数时如何处理？](https://support.huaweicloud.com/hcli_faq/hcli_19_002.md): 通过KooCLI管理和使用您的各类云服务资源时，在调用云服务API的过程中，会对您输入参数的合法性进行校验。若您在命令中输入了当前API不支持的参数，或将只允许配置在配置项中使用的参数在命令直接传入，会提示如下错误：[USE_ERROR]不正确的参数:*如遇如上情形，您可以通过执行“hcloud <service> <operation
- [为什么会有新旧KooCLI系统参数，如cli-region与region，推荐使用哪个？](https://support.huaweicloud.com/hcli_faq/hcli_19_003.md): 在KooCLI系统参数列表中，部分参数同时存在两种形式，如“--cli-region”和“--region”。其中，未添加“cli-”前缀的称为旧系统参数；添加了“cli-”前缀的称为新系统参数。之所以支持新系统参数，是因为在KooCLI上开放的云服务中，存在部分API的某参数与旧系统参数重名的情况。该场景可能会使命令中两个同名的参数用于
- [提示重复的参数时如何处理？](https://support.huaweicloud.com/hcli_faq/hcli_19_006.md): KooCLI在命令执行过程中会对参数的合法性进行检查，若命令中存在重复参数，视具体场景不同，会提示不同错误，例如：[USE_ERROR]重复的参数:*[USE_ERROR]重复的参数*,如非误输,请以cli-*为key输入其中的KooCLI系统参数[USE_ERROR]重复的*,如非误输,请将其中的API参数通过'--cli-jsonIn
- [如何使用cli-jsonInput？注意事项有哪些？](https://support.huaweicloud.com/hcli_faq/hcli_19_004.md): 命令提示符（cmd.exe）等工具对使用时输入的字符串的最大长度有限制。当需要执行的命令的参数过多或参数值过长时，可能会因为其长度限制导致命令输入不完整。因此KooCLI除了支持参数在命令中直接输入之外，也支持使用“--cli-jsonInput=${jsonFileName}”传入JSON文件，向KooCLI传递云服务API参数。Koo
- [使用cli-jsonInput的场景有哪些？](https://support.huaweicloud.com/hcli_faq/hcli_19_007.md): 云服务的API参数名称中带有“.”，KooCLI可能无法正确解析该参数，此时需通过cli-jsonInput传入该API的参数；云服务的API在不同位置中有同名的参数时，KooCLI无法正确解析该API的参数，此时需通过cli-jsonInput传入该API的参数；用户输入的云服务API参数值中包含空格或特殊符号，通过终端调用KooCLI
- [提示不支持的参数位置/类型时如何处理？](https://support.huaweicloud.com/hcli_faq/hcli_19_005.md): 通过KooCLI管理和使用您的各类云服务资源，在调用云服务API的过程中，KooCLI会对您输入参数的合法性进行校验。在此校验过程中，KooCLI会获取该API中所有参数的详情信息，其中包括每个参数的类型、在request中的位置等信息。若您本地缓存的元数据文件被修改，可能会使KooCLI在运行过程中无法根据缓存文件正确解析到该API的参
- [云服务API的body位置参数值如何置空？](https://support.huaweicloud.com/hcli_faq/hcli_19_008.md): 对于云服务API的body位置的参数，KooCLI支持在任意层级置空：若当前层级的值实际类型为map，则置空时参数值应为“{}”。若当前层级的值实际类型为数组，则置空时参数值应为“[]”。以云服务“ECS”的operation“BatchStopServers”为例，其body位置存在参数“os-stop.servers.[N].id”和
- [KooCLI系统参数包括哪些？](https://support.huaweicloud.com/hcli_faq/hcli_19_001.md): KooCLI系统参数是指其内置参数，各系统参数的描述信息及其使用方式如下表所示：对上表中所列的各参数使用方式解释如下：仅支持配置于配置项后使用：指该参数只可以通过“hcloud configure set --key1=value1 --key2=value2 ...”命令配置到配置项后再使用。使用时在命令中通过“--cli-profil
- [提示不正确的参数时如何处理？](https://support.huaweicloud.com/hcli_faq/hcli_19_002.md): 通过KooCLI管理和使用您的各类云服务资源时，在调用云服务API的过程中，会对您输入参数的合法性进行校验。若您在命令中输入了当前API不支持的参数，或将只允许配置在配置项中使用的参数在命令直接传入，会提示如下错误：[USE_ERROR]不正确的参数:*如遇如上情形，您可以通过执行“hcloud <service> <operation
- [为什么会有新旧KooCLI系统参数，如cli-region与region，推荐使用哪个？](https://support.huaweicloud.com/hcli_faq/hcli_19_003.md): 在KooCLI系统参数列表中，部分参数同时存在两种形式，如“--cli-region”和“--region”。其中，未添加“cli-”前缀的称为旧系统参数；添加了“cli-”前缀的称为新系统参数。之所以支持新系统参数，是因为在KooCLI上开放的云服务中，存在部分API的某参数与旧系统参数重名的情况。该场景可能会使命令中两个同名的参数用于
- [提示重复的参数时如何处理？](https://support.huaweicloud.com/hcli_faq/hcli_19_006.md): KooCLI在命令执行过程中会对参数的合法性进行检查，若命令中存在重复参数，视具体场景不同，会提示不同错误，例如：[USE_ERROR]重复的参数:*[USE_ERROR]重复的参数*,如非误输,请以cli-*为key输入其中的KooCLI系统参数[USE_ERROR]重复的*,如非误输,请将其中的API参数通过'--cli-jsonIn
- [如何使用cli-jsonInput？注意事项有哪些？](https://support.huaweicloud.com/hcli_faq/hcli_19_004.md): 命令提示符（cmd.exe）等工具对使用时输入的字符串的最大长度有限制。当需要执行的命令的参数过多或参数值过长时，可能会因为其长度限制导致命令输入不完整。因此KooCLI除了支持参数在命令中直接输入之外，也支持使用“--cli-jsonInput=${jsonFileName}”传入JSON文件，向KooCLI传递云服务API参数。Koo
- [使用cli-jsonInput的场景有哪些？](https://support.huaweicloud.com/hcli_faq/hcli_19_007.md): 云服务的API参数名称中带有“.”，KooCLI可能无法正确解析该参数，此时需通过cli-jsonInput传入该API的参数；云服务的API在不同位置中有同名的参数时，KooCLI无法正确解析该API的参数，此时需通过cli-jsonInput传入该API的参数；用户输入的云服务API参数值中包含空格或特殊符号，通过终端调用KooCLI
- [提示不支持的参数位置/类型时如何处理？](https://support.huaweicloud.com/hcli_faq/hcli_19_005.md): 通过KooCLI管理和使用您的各类云服务资源，在调用云服务API的过程中，KooCLI会对您输入参数的合法性进行校验。在此校验过程中，KooCLI会获取该API中所有参数的详情信息，其中包括每个参数的类型、在request中的位置等信息。若您本地缓存的元数据文件被修改，可能会使KooCLI在运行过程中无法根据缓存文件正确解析到该API的参
- [云服务API的body位置参数值如何置空？](https://support.huaweicloud.com/hcli_faq/hcli_19_008.md): 对于云服务API的body位置的参数，KooCLI支持在任意层级置空：若当前层级的值实际类型为map，则置空时参数值应为“{}”。若当前层级的值实际类型为数组，则置空时参数值应为“[]”。以云服务“ECS”的operation“BatchStopServers”为例，其body位置存在参数“os-stop.servers.[N].id”和
- [使用交互式/自动补全需要注意什么？](https://support.huaweicloud.com/hcli_faq/hcli_21_001.md): 在bash环境下，使用“hcloud auto-complete on”可开启自动补全，使用自动补全时需注意：自动补全提示参数时，若提示的参数名中有“[N]”，其含义为索引位，请使用数字代替该字符；若提示的参数名中有“{*}”，其含义为自定义参数名称，请使用任意不含“.”的字符串代替该字符；若同一机器同一用户的多个目录下有KooCLI，且
- [使用交互式/自动补全需要注意什么？](https://support.huaweicloud.com/hcli_faq/hcli_21_001.md): 在bash环境下，使用“hcloud auto-complete on”可开启自动补全，使用自动补全时需注意：自动补全提示参数时，若提示的参数名中有“[N]”，其含义为索引位，请使用数字代替该字符；若提示的参数名中有“{*}”，其含义为自定义参数名称，请使用任意不含“.”的字符串代替该字符；若同一机器同一用户的多个目录下有KooCLI，且
- [KooCLI支持的输出格式有哪些？](https://support.huaweicloud.com/hcli_faq/hcli_23_001.md): KooCLI支持三种输出格式：json，table，tsv。默认以json格式输出。您可以使用“--cli-output”参数指定如前所述的任意一种输出格式，您也可以配合使用“--cli-query”选项传入JMESPath表达式，对json结果执行JMESPath查询，以过滤出您需要的信息。输出效果可参考此示例：指定结果的输出格式。构造
- [如何定义JMESPath表达式](https://support.huaweicloud.com/hcli_faq/hcli_23_002.md): 华为云帮助中心，为用户提供产品简介、价格说明、购买指南、用户指南、API参考、最佳实践、常见问题、视频帮助等技术文档，帮助您快速上手使用华为云服务。
- [JMESPath表达式的用法有哪些？](https://support.huaweicloud.com/hcli_faq/hcli_23_002_01.md): JMESPath表达式的用法如下：基本表达式标识符：最简单的JMESPath表达式是标识符，它在json对象中选择一个键：{"a": "foo", "b": "bar", "c": "baz"}对于如上的 json 内容，当表达式为"a" 时，可获取结果："foo"。另请注意，如果指定一个不存在的键，KooCLI会提示错误告警信息并输出原
- [JMESPath支持的内置函数有哪些？](https://support.huaweicloud.com/hcli_faq/hcli_23_002_02.md): JMESPath的内置函数支持的数据类型包括：number（json中的整数和双精度浮点格式）stringboolean（true 或 false）array（有序的，值序列）object（键值对的无序集合）expression（用&expression表示的表达式）null各内置函数支持的数据类型不同。具体如下表。函数参数中一个特殊字符
- [KooCLI与输出相关的系统参数有哪些，推荐使用哪些？](https://support.huaweicloud.com/hcli_faq/hcli_23_003.md): KooCLI与输出相关的参数如下：与旧输出参数相比，新输出参数不仅新增了支持除table，json两种输出格式外的tsv输出格式，同时也使输出参数得以统一，方便用户使用。KooCLI之后关于输出格式相关的功能，将在新输出参数的基础上开发。对旧输出参数将仅维持其已有功能，不再持续升级。故用户在构造命令时，推荐使用新输出参数。
- [新输出参数cli-output，cli-query，cli-output-num在使用时的注意事项有哪些？](https://support.huaweicloud.com/hcli_faq/hcli_23_004.md): 新输出参数的使用方法请参考：指定结果的输出格式。命令中使用“--cli-query”用于传入JMESPath表达式，对结果执行JMESPath查询，方便提炼原返回结果中的关键信息；“--cli-output”用于指定响应数据的输出格式；“--cli-output-num”用于指定当使用table格式输出时，是否打印行号。使用如上各参数时，
- [旧输出参数cli-output-rows，cli-output-cols，cli-output-num如何使用，注意事项有哪些？](https://support.huaweicloud.com/hcli_faq/hcli_23_005.md): 华为云帮助中心，为用户提供产品简介、价格说明、购买指南、用户指南、API参考、最佳实践、常见问题、视频帮助等技术文档，帮助您快速上手使用华为云服务。
- [旧输出参数cli-output-rows，cli-output-cols，cli-output-num如何使用？](https://support.huaweicloud.com/hcli_faq/hcli_23_005_01.md): 通过KooCLI调用云服务API，默认会返回json格式的调用结果。KooCLI支持使用“--cli-output-rows”，“--cli-output-cols”，“--cli-output-num”参数，以table格式输出，方便提炼调用结果中的关键信息，如下：以默认的json格式输出原调用结果：hcloud ECS NovaLis
- [旧输出参数cli-output-rows，cli-output-cols，cli-output-num使用时的注意事项有哪些？](https://support.huaweicloud.com/hcli_faq/hcli_23_005_02.md): 当命令中使用了“--cli-output-rows”，“--cli-output-cols”，“--cli-output-num”时，将会以table格式输出。使用table输出有利于用户对返回值中的关键信息进行提取。使用时各参数的功能如下：--cli-output-cols：table输出时，指定需要打印的字段；--cli-output
- [旧输出参数cli-json-filter如何使用，注意事项有哪些？](https://support.huaweicloud.com/hcli_faq/hcli_23_006.md): 华为云帮助中心，为用户提供产品简介、价格说明、购买指南、用户指南、API参考、最佳实践、常见问题、视频帮助等技术文档，帮助您快速上手使用华为云服务。
- [旧输出参数cli-json-filter如何使用？](https://support.huaweicloud.com/hcli_faq/hcli_23_006_01.md): 通过KooCLI调用云服务API，默认会返回json格式的调用结果。KooCLI支持使用“--cli-json-filter”对json结果执行JMESPath查询，方便提炼其中的关键信息，如下：以默认的json格式输出原调用结果：hcloud ECS NovaListServers --cli-region="cn-north-4" -
- [旧输出参数cli-json-filter使用时的注意事项有哪些？](https://support.huaweicloud.com/hcli_faq/hcli_23_006_02.md): KooCLI支持使用“--cli-json-filter”传入JMESPath表达式，对json结果执行JMESPath查询，提炼其中的关键信息。使用“--cli-json-filter”时需注意：当命令中使用了“--cli-json-filter”时，将以json格式输出调用结果。在同一命令中，“--cli-json-filter”不可
- [KooCLI支持的输出格式有哪些？](https://support.huaweicloud.com/hcli_faq/hcli_23_001.md): KooCLI支持三种输出格式：json，table，tsv。默认以json格式输出。您可以使用“--cli-output”参数指定如前所述的任意一种输出格式，您也可以配合使用“--cli-query”选项传入JMESPath表达式，对json结果执行JMESPath查询，以过滤出您需要的信息。输出效果可参考此示例：指定结果的输出格式。构造
- [JMESPath表达式的用法有哪些？](https://support.huaweicloud.com/hcli_faq/hcli_23_002_01.md): JMESPath表达式的用法如下：基本表达式标识符：最简单的JMESPath表达式是标识符，它在json对象中选择一个键：{"a": "foo", "b": "bar", "c": "baz"}对于如上的 json 内容，当表达式为"a" 时，可获取结果："foo"。另请注意，如果指定一个不存在的键，KooCLI会提示错误告警信息并输出原
- [JMESPath支持的内置函数有哪些？](https://support.huaweicloud.com/hcli_faq/hcli_23_002_02.md): JMESPath的内置函数支持的数据类型包括：number（json中的整数和双精度浮点格式）stringboolean（true 或 false）array（有序的，值序列）object（键值对的无序集合）expression（用&expression表示的表达式）null各内置函数支持的数据类型不同。具体如下表。函数参数中一个特殊字符
- [JMESPath表达式的用法有哪些？](https://support.huaweicloud.com/hcli_faq/hcli_23_002_01.md): JMESPath表达式的用法如下：基本表达式标识符：最简单的JMESPath表达式是标识符，它在json对象中选择一个键：{"a": "foo", "b": "bar", "c": "baz"}对于如上的 json 内容，当表达式为"a" 时，可获取结果："foo"。另请注意，如果指定一个不存在的键，KooCLI会提示错误告警信息并输出原
- [JMESPath支持的内置函数有哪些？](https://support.huaweicloud.com/hcli_faq/hcli_23_002_02.md): JMESPath的内置函数支持的数据类型包括：number（json中的整数和双精度浮点格式）stringboolean（true 或 false）array（有序的，值序列）object（键值对的无序集合）expression（用&expression表示的表达式）null各内置函数支持的数据类型不同。具体如下表。函数参数中一个特殊字符
- [KooCLI与输出相关的系统参数有哪些，推荐使用哪些？](https://support.huaweicloud.com/hcli_faq/hcli_23_003.md): KooCLI与输出相关的参数如下：与旧输出参数相比，新输出参数不仅新增了支持除table，json两种输出格式外的tsv输出格式，同时也使输出参数得以统一，方便用户使用。KooCLI之后关于输出格式相关的功能，将在新输出参数的基础上开发。对旧输出参数将仅维持其已有功能，不再持续升级。故用户在构造命令时，推荐使用新输出参数。
- [新输出参数cli-output，cli-query，cli-output-num在使用时的注意事项有哪些？](https://support.huaweicloud.com/hcli_faq/hcli_23_004.md): 新输出参数的使用方法请参考：指定结果的输出格式。命令中使用“--cli-query”用于传入JMESPath表达式，对结果执行JMESPath查询，方便提炼原返回结果中的关键信息；“--cli-output”用于指定响应数据的输出格式；“--cli-output-num”用于指定当使用table格式输出时，是否打印行号。使用如上各参数时，
- [旧输出参数cli-output-rows，cli-output-cols，cli-output-num如何使用？](https://support.huaweicloud.com/hcli_faq/hcli_23_005_01.md): 通过KooCLI调用云服务API，默认会返回json格式的调用结果。KooCLI支持使用“--cli-output-rows”，“--cli-output-cols”，“--cli-output-num”参数，以table格式输出，方便提炼调用结果中的关键信息，如下：以默认的json格式输出原调用结果：hcloud ECS NovaLis
- [旧输出参数cli-output-rows，cli-output-cols，cli-output-num使用时的注意事项有哪些？](https://support.huaweicloud.com/hcli_faq/hcli_23_005_02.md): 当命令中使用了“--cli-output-rows”，“--cli-output-cols”，“--cli-output-num”时，将会以table格式输出。使用table输出有利于用户对返回值中的关键信息进行提取。使用时各参数的功能如下：--cli-output-cols：table输出时，指定需要打印的字段；--cli-output
- [旧输出参数cli-output-rows，cli-output-cols，cli-output-num如何使用？](https://support.huaweicloud.com/hcli_faq/hcli_23_005_01.md): 通过KooCLI调用云服务API，默认会返回json格式的调用结果。KooCLI支持使用“--cli-output-rows”，“--cli-output-cols”，“--cli-output-num”参数，以table格式输出，方便提炼调用结果中的关键信息，如下：以默认的json格式输出原调用结果：hcloud ECS NovaLis
- [旧输出参数cli-output-rows，cli-output-cols，cli-output-num使用时的注意事项有哪些？](https://support.huaweicloud.com/hcli_faq/hcli_23_005_02.md): 当命令中使用了“--cli-output-rows”，“--cli-output-cols”，“--cli-output-num”时，将会以table格式输出。使用table输出有利于用户对返回值中的关键信息进行提取。使用时各参数的功能如下：--cli-output-cols：table输出时，指定需要打印的字段；--cli-output
- [旧输出参数cli-json-filter如何使用？](https://support.huaweicloud.com/hcli_faq/hcli_23_006_01.md): 通过KooCLI调用云服务API，默认会返回json格式的调用结果。KooCLI支持使用“--cli-json-filter”对json结果执行JMESPath查询，方便提炼其中的关键信息，如下：以默认的json格式输出原调用结果：hcloud ECS NovaListServers --cli-region="cn-north-4" -
- [旧输出参数cli-json-filter使用时的注意事项有哪些？](https://support.huaweicloud.com/hcli_faq/hcli_23_006_02.md): KooCLI支持使用“--cli-json-filter”传入JMESPath表达式，对json结果执行JMESPath查询，提炼其中的关键信息。使用“--cli-json-filter”时需注意：当命令中使用了“--cli-json-filter”时，将以json格式输出调用结果。在同一命令中，“--cli-json-filter”不可
- [旧输出参数cli-json-filter如何使用？](https://support.huaweicloud.com/hcli_faq/hcli_23_006_01.md): 通过KooCLI调用云服务API，默认会返回json格式的调用结果。KooCLI支持使用“--cli-json-filter”对json结果执行JMESPath查询，方便提炼其中的关键信息，如下：以默认的json格式输出原调用结果：hcloud ECS NovaListServers --cli-region="cn-north-4" -
- [旧输出参数cli-json-filter使用时的注意事项有哪些？](https://support.huaweicloud.com/hcli_faq/hcli_23_006_02.md): KooCLI支持使用“--cli-json-filter”传入JMESPath表达式，对json结果执行JMESPath查询，提炼其中的关键信息。使用“--cli-json-filter”时需注意：当命令中使用了“--cli-json-filter”时，将以json格式输出调用结果。在同一命令中，“--cli-json-filter”不可
- [无配置方式使用KooCLI需要注意什么？](https://support.huaweicloud.com/hcli_faq/hcli_20_001.md): 无配置方式使用是指在使用KooCLI时不通过已有配置项传入当前用户的认证信息，而是直接在命令中传入当前用户认证相关的参数。此方式可使用户免于添加配置项，方便快捷。具体使用方式请参考：无配置方式使用KooCLI。无配置方式使用KooCLI时，需要注意如下事项：无配置方式AKSK访问密钥（永久AK/SK）方式使用永久AK/SK通过KooCLI
- [命令中服务名、operation、参数的value值是否需要使用双引号引起？](https://support.huaweicloud.com/hcli_faq/hcli_20_002.md): 需要视参数value的具体内容而定。一般情况下，命令中的服务名、operation、参数的value值可不必使用双引号引起。但若您命令中的服务名、operation、参数的value值中有特殊符号、空格、或需要转义的符号，请您在命令中传入该值时，将其使用双引号引起。您可通过直接在API Explorer上获取CLI示例，避免在命令中手动输
- [在线/离线模式分别适用什么场景？](https://support.huaweicloud.com/hcli_faq/hcli_20_004.md): 查看/切换当前模式KooCLI支持在线/离线模式。默认为在线模式。添加配置项之后，您可以执行“hcloud configure list --cli-query=offline”命令查看当前是否已使用离线模式。执行命令“hcloud configure set --cli-offline=true”可切换至离线模式；执行命令“hcloud
- [如何卸载KooCLI？](https://support.huaweicloud.com/hcli_faq/hcli_20_003.md): KooCLI无需安装，下载解压后即可使用。因此您在卸载时仅需要删除该工具及相关本地缓存文件即可。请参考如下步骤：执行“hcloud auto-complete off”命令关闭自动补全；删除缓存文件，配置文件及日志文件：Linux系统： /home/{当前用户名}/.hcloud/Windows系统：C:\Users\{当前用户名}\.h
- [无配置方式使用KooCLI需要注意什么？](https://support.huaweicloud.com/hcli_faq/hcli_20_001.md): 无配置方式使用是指在使用KooCLI时不通过已有配置项传入当前用户的认证信息，而是直接在命令中传入当前用户认证相关的参数。此方式可使用户免于添加配置项，方便快捷。具体使用方式请参考：无配置方式使用KooCLI。无配置方式使用KooCLI时，需要注意如下事项：无配置方式AKSK访问密钥（永久AK/SK）方式使用永久AK/SK通过KooCLI
- [命令中服务名、operation、参数的value值是否需要使用双引号引起？](https://support.huaweicloud.com/hcli_faq/hcli_20_002.md): 需要视参数value的具体内容而定。一般情况下，命令中的服务名、operation、参数的value值可不必使用双引号引起。但若您命令中的服务名、operation、参数的value值中有特殊符号、空格、或需要转义的符号，请您在命令中传入该值时，将其使用双引号引起。您可通过直接在API Explorer上获取CLI示例，避免在命令中手动输
- [在线/离线模式分别适用什么场景？](https://support.huaweicloud.com/hcli_faq/hcli_20_004.md): 查看/切换当前模式KooCLI支持在线/离线模式。默认为在线模式。添加配置项之后，您可以执行“hcloud configure list --cli-query=offline”命令查看当前是否已使用离线模式。执行命令“hcloud configure set --cli-offline=true”可切换至离线模式；执行命令“hcloud
- [如何卸载KooCLI？](https://support.huaweicloud.com/hcli_faq/hcli_20_003.md): KooCLI无需安装，下载解压后即可使用。因此您在卸载时仅需要删除该工具及相关本地缓存文件即可。请参考如下步骤：执行“hcloud auto-complete off”命令关闭自动补全；删除缓存文件，配置文件及日志文件：Linux系统： /home/{当前用户名}/.hcloud/Windows系统：C:\Users\{当前用户名}\.h