检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
KooCLI相关概念 在KooCLI指导中常用到的词语,以下做出详细介绍,方便您的阅读理解。 命令 KooCLI提供的各项操作指令,用于配置工作环境,或者调用云各服务开放的API。 API调用命令格式如下: hcloud [options] <service> <operation
使用cli-jsonInput的场景有哪些? 云服务的API参数名称中带有“.”,KooCLI可能无法正确解析该参数,此时需通过cli-jsonInput传入该API的参数; 云服务的API在不同位置中有同名的参数时,KooCLI无法正确解析该API的参数,此时需通过cli-jsonInput
什么是KooCLI 华为云命令行工具服务(Koo Command Line Interface,KooCLI,原名HCloud CLI)是为发布在API Explorer上的云服务API提供的命令行管理工具。您可以通过此工具调用API Explorer中各云服务开放的API,管理和使用您的各类云服务资源
最新动态 本文介绍了KooCLI各特性版本的功能发布和对应的文档动态,欢迎体验。 2024年7月 序号 功能名称 功能描述 阶段 相关文档 1 支持配置SSO登录参数 KooCLI版本:5.3.4 KooCLI支持使用"--cli-sso-account-name","--cli-sso-permission-set-name
指定结果的输出格式 命令中使用“--cli-query”传入JMESPath表达式,对结果执行JMESPath查询,方便提炼原返回结果中的关键信息;“--cli-output”指定响应数据的输出格式;“--cli-output-num”指定当使用table格式输出时,是否打印行号。
提示不支持的cli-region时如何处理? 问题背景 使用KooCLI调用所有云服务的API时,都需要提供合适的cli-region。如果您遇到如下几种情况: 命令中cli-region值输入有误; 命令指定了cli-region值,但目标API不支持该cli-region; 命令中未指定
提示不支持的参数位置/类型时如何处理? 问题背景 通过KooCLI管理和使用您的各类云服务资源,在调用云服务API的过程中,KooCLI会对您输入参数的合法性进行校验。在此校验过程中,KooCLI会获取该API中所有参数的详情信息,其中包括每个参数的类型、在request中的位置等信息
SSO登录 KooCLI的SSO登录命令通过完成SSO登录,将用户的认证信息存储在配置文件中,避免执行操作时频繁输入这些固定信息。可通过如下命令进行SSO登录: hcloud configure sso 输入以上命令并回车后,会逐步提示您输入SSO profile name(此SSO
概述 如果您需要同时在多个区域或多个项目下管理资源,或者同时使用多个账号,可以通过增加配置项的方式,存储多个不同场景的固定信息。已配置多个配置项的情况下,您可在命令中以“--cli-profile”指定要操作或使用的配置项的名称。 KooCLI配置项中可修改的参数如下表所示。 表1
打印帮助信息 KooCLI支持查看命令的帮助信息,例如查看“RDS”服务operation为“ListCollations”的API的帮助信息: hcloud RDS ListCollations --cli-region="cn-north-1" --help 父主题: 选项说明
如何使用KooCLI 下载KooCLI。 KooCLI绿色免安装,下载到本地后解压即可使用。KooCLI支持Windows 64位、Linux AMD 64位、Linux ARM 64位、macOS AMD 64位、macOS ARM 64位,请根据您本地系统下载对应的版本。 配置
概述 KooCLI将调用命令时出现的错误分为五种类型,在错误提示信息的起始位置声明其具体类型:[NETWORK_ERROR],[CLI_ERROR],[USE_ERROR],[OPENAPI_ERROR]和[APIE_ERROR]。各类错误的定位方法如下: [NETWORK_ERROR
设置配置项中的系统参数 设置配置项中的系统参数的示例如下: 增加配置项 新增配置项时,以“--cli-profile”声明配置项的名称,示例如下: 新增认证模式为AK/SK的配置项,其中认证参数为访问密钥,即永久AK(cli-access-key)和SK(cli-secret-key
审计与日志 由于KooCLI是部署在用户本地的客户端工具,工具本身记录的日志可以作为审计目的使用,但是需要用户对日志进行访问权限控制以达到审计日志不可篡改的目的。此外, 同使用SDK一样,KooCLI将用户命令解析成https请求发送到API Gateway后,API Gateway
检查命令正确性 dryrun选项用于检查所传入命令的正确性。在命令中添加“--dryrun”选项,执行校验后打印请求报文,跳过实际运行,不调用目标API: hcloud RDS CreateConfiguration --cli-region="cn-north-4" --project_id
提示不正确的参数时如何处理? 问题背景 通过KooCLI管理和使用您的各类云服务资源时,在调用云服务API的过程中,会对您输入参数的合法性进行校验。若您在命令中输入了当前API不支持的参数,或将只允许配置在配置项中使用的参数在命令直接传入,会提示如下错误: [USE_ERROR]不正确的参数
无配置方式使用概述 KooCLI既可以使用配置项调用云服务API,也提供了无配置的操作方式,无配置方式使用是指在使用KooCLI时不通过已有配置项传入当前用户的认证信息,而是直接在命令中传入当前用户认证相关的参数。此方式可使用户免于添加配置项,方便快捷地使用KooCLI。用户可以通过如下认证方式直接调用云服务
提示重复的参数时如何处理? 问题背景 KooCLI在命令执行过程中会对参数的合法性进行检查,若命令中存在重复参数,视具体场景不同,会提示不同错误,例如: [USE_ERROR]重复的参数:* [USE_ERROR]重复的参数*,如非误输,请以cli-*为key输入其中的KooCLI
交互式提示 KooCLI支持功能强大的多平台支持的交互式提示,方便命令构建,在命令中添加“--interactive”参数即可进入交互式提示。交互式中根据用户当前输入的内容,提示云服务名称,API的operation,参数及其描述信息,也提供部分参数值的补全功能。 交互式的使用方式如下
如何定义JMESPath表达式 JMESPath表达式的用法有哪些? JMESPath支持的内置函数有哪些? 父主题: 输出格式相关