检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
使用“--cli-query”指定的JMESPath表达式不同,输出的结果中各参数的排列顺序可能不同。部分表达式的输出结果不会带有输出数据的属性名(即参数的key值),故用户需对输出数据的顺序有所把握,以便于数据处理。不同类型的JMESPath表达式,输出结果的顺序如下表所示: 表1 不同JMESPath表达式的数据输出顺序
无配置方式使用KooCLI需要注意什么? 无配置方式使用是指在使用KooCLI时不通过已有配置项传入当前用户的认证信息,而是直接在命令中传入当前用户认证相关的参数。此方式可使用户免于添加配置项,方便快捷。具体使用方式请参考:无配置方式使用KooCLI。 无配置方式使用KooCLI时,需要注意如下事项:
常用命令 查看帮助信息 自动补全 交互式提示 元数据管理 查询当前版本 版本更新 日志管理 模板管理 管理OBS中的数据
华为云命令行工具服务(Koo Command Line Interface,KooCLI),是为发布在API Explorer上的华为云服务API提供的命令行管理工具。您可以通过此工具调用API Explorer中各云服务开放的API,管理和使用您的各类云服务资源。 在线体验 详细文档 仅两个按钮时选用 立即使用
通过KooCLI管理和使用您的各类云服务资源,在调用云服务的API时,KooCLI优先使用命令中“--cli-profile”选项指定的配置项。 如您未在命令中指定配置项,会使用默认配置项来调用目标API。 若该配置项的内容与目标API不匹配,或缺少访问目标API时需要的某参数,会提示相关错误,例如:
生成JSON格式API入参骨架 skeleton选项用于生成JSON格式API入参骨架。在命令中添加“--skeleton”选项,则在当前目录生成该API的JSON格式的入参文件,用户可填写文件中的参数值,以“--cli-jsonInput=${JSON文件名}”传入参数,调用API: hcloud
配置KooCLI环境。 环境配置请参考快速初始化配置。 获取云服务API调用命令。 获取云服务API调用命令有两种方式: (推荐)API Explorer上获取 云服务的API可在API Explorer上查看。您可以在API Explorer上先填写好各参数的值,即可从“CLI示例”页签中直接获取命令。
如何解决网络连接超时问题? 问题背景 KooCLI调用云服务API的过程中,会对您输入参数的合法性进行校验,此校验过程可能需要远程获取该云服务和API的详情信息;在参数校验完成后,亦需要远程调用您的目标API。如在调用过程中因网络连接问题导致请求失败,会提示相关错误,例如: [NETWORK_ERROR]连接超时
配置HTTP代理 用户在使用KooCLI管理和使用云服务的资源时,可能会因为用户所在公司的内网访问限制,导致调用云服务API失败。此时,用户可使用HTTP代理访问。使用HTTP代理需要配置环境变量http_proxy和https_proxy。 配置http_proxy环境变量 请
云服务API的响应体为空时,如何判断命令是否执行成功? 问题背景 使用KooCLI调用部分云服务的API时,API的返回结果为空,CLI不会打印相应返回体,用户无法确认是否调用成功。 解决步骤 在原命令中添加“--debug”参数,可打印命令调用过程中的调试信息。其中包含一行内容为“API
a84546" { "job_id": "70a5****-****-****-****-****441e862b" } 不同区域,项目也不同,因此指定区域时,一般需要同时指定项目ID。 父主题: 选项说明
云服务API相关 提示不支持的operation时如何处理? 如何指定云服务的API和版本号? 云服务API的响应体为空时,如何判断命令是否执行成功?
具,工具本身记录的日志可以作为审计目的使用,但是需要用户对日志进行访问权限控制以达到审计日志不可篡改的目的。此外, 同使用SDK一样,KooCLI将用户命令解析成https请求发送到API Gateway后,API Gateway记录的相关信息也可用作审计目的。 详情请见日志管理。
称为新系统参数。之所以支持新系统参数,是因为在KooCLI上开放的云服务中,存在部分API的某参数与旧系统参数重名的情况。该场景可能会使命令中两个同名的参数用于不同的用途,即:其一作为目标API参数,另一作为系统参数。在命令执行过程中会对参数的合法性进行检查,若命令中存在重复参数,则会提示如下错误:
打印命令调用过程中的调试信息 生成JSON格式API入参骨架 检查命令正确性 指定区域 以无配置方式AKSK调用云服务API 指定用户所属账号ID 指定配置项 指定配置项的认证模式 指定结果的输出格式 以JSON文件的方式传递API参数 指定请求超时时间 指定请求连接重试次数 跳过https请求证书验证
安全 责任共担 身份认证与访问控制 数据保护技术 审计与日志 更新管理 认证证书 风险防范
其他 无配置方式使用KooCLI需要注意什么? 命令中服务名、operation、参数的value值是否需要使用双引号引起? 在线/离线模式分别适用什么场景? 如何卸载KooCLI?
认证相关 获取认证信息 认证方式优先级
误,请根据错误提示做相应修改; [OPENAPI_ERROR]:一般是调用云服务API时发生的错误,请联系相关云服务oncall协助处理; [APIE_ERROR]:一般是调用API Explorer获取元数据时发生的错误,请联系API Explorer云服务oncall协助处理。
息。 API 已输入的云服务/系统命令经校验无误后,会继续提示该服务的API列表/该系统命令的子命令(或参数)。 所提示的系统命令列表中,左列展示该系统命令的子命令(或参数),右列展示该子命令(或参数)的描述信息。 图2 交互式中提示云服务的API列表 所提示的云服务API列表中