检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
在API Explorer上获取CLI示例 API Explorer上开放的各云服务API,除了支持在线调试,还能生成KooCLI命令示例(以下简称CLI示例)。您在API Explorer界面上填写API参数,在其对应的“CLI示例”中可直接拷贝使用。 下图为API Explo
云服务API相关 提示不支持的operation时如何处理? 如何指定云服务的API和版本号? 云服务API的响应体为空时,如何判断命令是否执行成功?
以JSON文件的方式传递API参数 KooCLI调用云服务的API时,如果API的参数过多,不便直接在命令中传入,用户可通过“--cli-jsonInput”将云服务API的部分或全部参数以JSON文件的形式输入。剩余的其他参数,例如KooCLI系统参数、未通过JSON文件传入的云服务API参数等,仍可在命令中传入,例如:
生成JSON格式API入参骨架 skeleton选项用于生成JSON格式API入参骨架。在命令中添加“--skeleton”选项,则在当前目录生成该API的JSON格式的入参文件,用户可填写文件中的参数值,以“--cli-jsonInput=${JSON文件名}”传入参数,调用API: hcloud
以无配置方式AKSK调用云服务API KooCLI支持在命令中添加“--cli-access-key”,“--cli-secret-key”和“--cli-security-token”选项,以无配置方式AKSK调用云服务API。 当命令中仅使用“--cli-access-key
切换默认配置项。 参数 参数可分为API参数和KooCLI系统参数。API参数是指云服务的API中定义的参数;系统参数是指KooCLI的内置参数,具有其固定的使用方式和特定含义。请查看系统参数列表。 选项 KooCLI选项是指可以直接在调用API的命令中添加的KooCLI系统参数
CLI)是为发布在API Explorer上的云服务API提供的命令行管理工具。您可以通过此工具调用API Explorer中各云服务开放的API,管理和使用您的各类云服务资源。 KooCLI只提供了一种通过CLI调用云服务API的方法。在使用KooCLI之前,您需要熟悉该API。KooC
云服务API的body位置参数值如何置空? 对于云服务API的body位置的参数,KooCLI支持在任意层级置空: 若当前层级的值实际类型为map,则置空时参数值应为“{}”。 若当前层级的值实际类型为数组,则置空时参数值应为“[]”。 以云服务“ECS”的operation“B
如何指定云服务的API和版本号? 问题背景 KooCLI调用云服务API的过程中,会对您输入参数的合法性进行校验。若您当前调用的云服务是多版本服务,即意味着该服务中的部分或全部API有多个版本。因同一API不同版本的参数、使用场景等可能存在差异,故须获取多版本服务API的版本信息。 云服务API的版本查询与指定
版本更新 日志管理 模板管理 常用选项 配置项管理 配置项用于存储一组调用云服务API时所需的公共信息,由用户通过调用KooCLI命令完成配置。各配置项组成配置文件,存储在用户本地。用户在调用云服务API时,可通过指定配置项,代替这组公共信息的输入。 KooCLI配置命令包含初始化配置、配置项的增删改查等。
i-”前缀的称为新系统参数。之所以支持新系统参数,是因为在KooCLI上开放的云服务中,存在部分API的某参数与旧系统参数重名的情况。该场景可能会使命令中两个同名的参数用于不同的用途,即:其一作为目标API参数,另一作为系统参数。在命令执行过程中会对参数的合法性进行检查,若命令中存在重复参数,则会提示如下错误:
云服务API的响应体为空时,如何判断命令是否执行成功? 问题背景 使用KooCLI调用部分云服务的API时,API的返回结果为空,CLI不会打印相应返回体,用户无法确认是否调用成功。 解决步骤 在原命令中添加“--debug”参数,可打印命令调用过程中的调试信息。其中包含一行内容为“API
息。 API 已输入的云服务/系统命令经校验无误后,会继续提示该服务的API列表/该系统命令的子命令(或参数)。 所提示的系统命令列表中,左列展示该系统命令的子命令(或参数),右列展示该子命令(或参数)的描述信息。 图2 交互式中提示云服务的API列表 所提示的云服务API列表中
华为云命令行工具服务(Koo Command Line Interface,KooCLI),是为发布在API Explorer上的华为云服务API提供的命令行管理工具。您可以通过此工具调用API Explorer中各云服务开放的API,管理和使用您的各类云服务资源。 在线体验 详细文档 仅两个按钮时选用 立即使用
身份认证与访问控制 KooCLI通过华为云API Gateway对华为云OpenAPI进行调用,其身份认证与访问控制与华为云OpenAPI保持一致。 身份认证 KooCLI的API调用分两种模式,一种是无身份认证的调用,当调用华为云OpenAPI中不需认证的API时用户不需要设置身份认证凭据即
图1 入门流程 注册华为帐号,创建IAM用户并授权,获取访问密钥等,请参见步骤一:准备工作。 使用KooCLI调用API Explorer中各云服务开放的API,管理和使用您的各类云服务资源前,需要先下载对应操作系统的KooCLI,请参见步骤二:快速安装。 使用KooCLI时,
提示不支持的operation时如何处理? 问题背景 KooCLI调用云服务API的过程中,会对您输入参数的合法性进行校验。如果您命令中API的operation输入有误,或该API未在KooCLI上线,会提示如下错误: [USE_ERROR]不支持的operation: * 解决步骤
认证证书 合规证书 华为云服务及平台通过了多项国内外权威机构(ISO/SOC/PCI等)的安全合规认证,用户可自行申请下载合规资质证书。 图1 合规证书下载 资源中心 华为云还提供以下资源来帮助用户满足合规性要求,具体请查看资源中心。 图2 资源中心 销售许可证&软件著作权证书
会根据当前API的参数列表自动识别各个参数的用途: 若目标API中存在“region”同名参数,或可自定义参数名称,KooCLI会在命令执行过程中自动将“--cli-region”识别为系统参数,其值用于获取目标API的详情信息;而将“--region”识别为目标API的参数,其值将用于目标API的调用。
如何解决网络连接超时问题? 问题背景 KooCLI调用云服务API的过程中,会对您输入参数的合法性进行校验,此校验过程可能需要远程获取该云服务和API的详情信息;在参数校验完成后,亦需要远程调用您的目标API。如在调用过程中因网络连接问题导致请求失败,会提示相关错误,例如: [NETWORK_ERROR]连接超时