检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
KooCLI以AKSK模式调用全局服务的API时,需添加账号ID(即cli-domain-id)。KooCLI会在调用全局服务的API的过程中,根据用户认证信息自动获取账号ID,用户也可在命令中添加“--cli-domain-id”选项,如下: hcloud CDN ListDomains
KooCLI开启自动补全后,在输入命令时使用“Tab”键,会根据已有命令提示其待补全的内容。 发布区域:全部 自动补全 交互式提示 KooCLI支持功能强大的多平台支持的交互式提示,方便命令构建,在命令中添加“--interactive”参数即可进入交互式提示。交互式中根据用户当前输入的内容,提示云服
None 操作指导 华为云命令行工具服务 如何使用华为云命令行工具服务 08:41 了解基本使用 云审计服务 CTS 如何创建追踪器 03:01 创建追踪器
隐私声明 详见《隐私政策声明》。 KooCLI的3.2.8及以后的版本在首次使用时,请您根据交互提示信息,选择是否同意其互联网连接及隐私政策声明。 对于不方便交互的场景,如以自动化脚本执行KooCLI命令,可通过如下命令,配置同意隐私声明: hcloud configure set
在项目列表中找到您的服务器资源对应的所属区域,在其左侧获取对应区域的项目ID,单击其左侧的图标可获取对应区域下的子项目ID。 图1 账号ID、项目ID KooCLI可在API调用过程中, 根据当前用户认证信息自行获取请求头中需要的账号ID、项目ID,因此命令中可不输入该参数。 父主题:
本节以Windows系统为例介绍KooCLI的使用,Linux和MacOS系统的使用基本相同,可参考。 KooCLI最基础的入门操作包括:快速安装、初始化配置信息,查看与执行云服务操作命令。 图1为KooCLI大致的入门流程,本入门指导旨在帮助您对其操作有初步的认识。 图1 入门流程 注册华为
[CLI_ERROR]:一般是因KooCLI处理命令过程中本身的异常导致的错误,请联系KooCLI的oncall协助处理; [USE_ERROR]:一般是因命令中参数不正确造成的错误,请根据错误提示做相应修改; [OPENAPI_ERROR]:一般是调用云服务API时发生的错误,请联系相关云服务oncall协助处理;
1 KooCLI集成OBS数据的工具obsutil KooCLI版本:3.4.6 KooCLI集成OBS数据的工具obsutil的功能。可以通过使用"hcloud obs"命令,快速管理OBS中的数据。 商用 管理OBS中的数据 2 支持将云服务API的body位置参数从任一层级置空
选项说明 选项概述 打印帮助信息 打印命令调用过程中的调试信息 生成JSON格式API入参骨架 检查命令正确性 指定区域 以无配置方式AKSK调用云服务API 指定用户所属账号ID 指定配置项 指定配置项的认证模式 指定结果的输出格式 以JSON文件的方式传递API参数 指定请求超时时间
其他 无配置方式使用KooCLI需要注意什么? 命令中服务名、operation、参数的value值是否需要使用双引号引起? 在线/离线模式分别适用什么场景? 如何卸载KooCLI?
安全 责任共担 身份认证与访问控制 数据保护技术 审计与日志 更新管理 认证证书 风险防范
使用“--cli-query”指定的JMESPath表达式不同,输出的结果中各参数的排列顺序可能不同。部分表达式的输出结果不会带有输出数据的属性名(即参数的key值),故用户需对输出数据的顺序有所把握,以便于数据处理。不同类型的JMESPath表达式,输出结果的顺序如下表所示: 表1 不同JMESPath表达式的数据输出顺序
以JSON文件的方式传递API参数 KooCLI调用云服务的API时,如果API的参数过多,不便直接在命令中传入,用户可通过“--cli-jsonInput”将云服务API的部分或全部参数以JSON文件的形式输入。剩余的其他参数,例如KooCLI系统参数、未通过JSON文件传入的云服务API参数等,仍可在命令中传入,例如:
表。 元数据 KooCLI在命令执行过程中需要获取云服务及其API的详情信息,用于命令中参数的校验及解析,该数据称为元数据。远程获取的元数据会被保存在用户本地供后续使用,以减少命令执行过程中的网络IO,提高命令响应速度,保存元数据的文件称为元数据缓存文件。请查看如何管理元数据缓存文件。
在线体验 在线体验KooCLI 在线体验功能特性
配置项的名称,同时还需根据认证模式“--cli-mode”添加相应的认证参数: 若配置项的认证模式为“AKSK”,则配置时命令中“--cli-access-key”和“--cli-secret-key”的值不能为空; 若配置项的认证模式为“ecsAgency”,则配置时命令中需指
只允许配置永久AK/SK。如果您要使用其他认证方式,或修改初始化的配置项中的参数值,可使用“hcloud configure set --cli-profile=default --key1=value1...”命令,详情请参考新增或修改配置项。
什么是KooCLI 华为云命令行工具服务(Koo Command Line Interface,KooCLI,原名HCloud CLI)是为发布在API Explorer上的云服务API提供的命令行管理工具。您可以通过此工具调用API Explorer中各云服务开放的API,管理和使用您的各类云服务资源。
oCLI上开放的云服务中,存在部分API的某参数与系统参数重名的情况。 解决方案 若提示的错误信息为上述第一种,则命令中可能存在重复的非系统参数,请您检查是否误输。此错误也可能与系统解析处理命令内容有关,若参数值有特殊符号,请使用双引号引起,避免解析错误。 若提示的错误信息为上述
指定区域 KooCLI除了可以从配置项读取区域信息外,还可以在命令中传入cli-region值,如下: hcloud EVS DeleteVolume --cli-region="cn-north-4" --volume_id="aed9****-****-****-****-****0e3219cf"