检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
身份认证与访问控制 KooCLI通过华为云API Gateway对华为云OpenAPI进行调用,其身份认证与访问控制与华为云OpenAPI保持一致。 身份认证 KooCLI的API调用分两种模式,一种是无身份认证的调用,当调用华为云OpenAPI中不需认证的API时用户不需要设置身份认证凭据即
设置配置项中的系统参数 设置配置项中的系统参数的示例如下: 增加配置项 新增配置项时,以“--cli-profile”声明配置项的名称,示例如下: 新增认证模式为AK/SK的配置项,其中认证参数为访问密钥,即永久AK(cli-access-key)和SK(cli-secret-key):
使用cli-jsonInput的场景有哪些? 云服务的API参数名称中带有“.”,KooCLI可能无法正确解析该参数,此时需通过cli-jsonInput传入该API的参数; 云服务的API在不同位置中有同名的参数时,KooCLI无法正确解析该API的参数,此时需通过cli-jsonInput传入该API的参数; 用户
环境配置请参考快速初始化配置。 获取云服务API调用命令。 获取云服务API调用命令有两种方式: (推荐)API Explorer上获取 云服务的API可在API Explorer上查看。您可以在API Explorer上先填写好各参数的值,即可从“CLI示例”页签中直接获取命令。 KooCLI帮助信息查询
Line Interface,KooCLI),是为发布在API Explorer上的华为云服务API提供的命令行管理工具。您可以通过此工具调用API Explorer中各云服务开放的API,管理和使用您的各类云服务资源。 在线体验 详细文档 仅两个按钮时选用 立即使用 成长地图 由浅入深,带您玩转KooCLI
通过KooCLI管理和使用您的各类云服务资源,在调用云服务的API时,KooCLI优先使用命令中“--cli-profile”选项指定的配置项。 如您未在命令中指定配置项,会使用默认配置项来调用目标API。 若该配置项的内容与目标API不匹配,或缺少访问目标API时需要的某参数,会提示相关错误,例如:
n、参数的value值中有特殊符号、空格、或需要转义的符号,请您在命令中传入该值时,将其使用双引号引起。 您可通过直接在API Explorer上获取CLI示例,避免在命令中手动输入参数。 父主题: 其他
"2022-05-13T08:05:17Z", "status": "SHUTOFF" } } 使用KooCLI调用API时,您可以在API Explorer上获取CLI示例。 KooCLI可在API调用过程中根据用户认证信息自动获取IAM用户所属账号ID、项目ID,同时若配置信息中已配置cli-region值,命令中可不输入。
指定用户所属账号ID KooCLI以AKSK模式调用全局服务的API时,需添加账号ID(即cli-domain-id)。KooCLI会在调用全局服务的API的过程中,根据用户认证信息自动获取账号ID,用户也可在命令中添加“--cli-domain-id”选项,如下: hcloud
使用KooCLI调用所有云服务的API时,都需要提供合适的cli-region。如果您遇到如下几种情况: 命令中cli-region值输入有误; 命令指定了cli-region值,但目标API不支持该cli-region; 命令中未指定cli-region值,目标API不支持从当前配置项中获取的cli-region。
提示不支持的参数位置/类型时如何处理? 问题背景 通过KooCLI管理和使用您的各类云服务资源,在调用云服务API的过程中,KooCLI会对您输入参数的合法性进行校验。在此校验过程中,KooCLI会获取该API中所有参数的详情信息,其中包括每个参数的类型、在request中的位置等信息。若您本地缓存
打印帮助信息 KooCLI支持查看命令的帮助信息,例如查看“RDS”服务operation为“ListCollations”的API的帮助信息: hcloud RDS ListCollations --cli-region="cn-north-1" --help 父主题: 选项说明
切换默认配置项。 参数 参数可分为API参数和KooCLI系统参数。API参数是指云服务的API中定义的参数;系统参数是指KooCLI的内置参数,具有其固定的使用方式和特定含义。请查看系统参数列表。 选项 KooCLI选项是指可以直接在调用API的命令中添加的KooCLI系统参数
误,请根据错误提示做相应修改; [OPENAPI_ERROR]:一般是调用云服务API时发生的错误,请联系相关云服务oncall协助处理; [APIE_ERROR]:一般是调用API Explorer获取元数据时发生的错误,请联系API Explorer云服务oncall协助处理。
旧输出参数cli-json-filter如何使用? 通过KooCLI调用云服务API,默认会返回json格式的调用结果。KooCLI支持使用“--cli-json-filter”对json结果执行JMESPath查询,方便提炼其中的关键信息,如下: 以默认的json格式输出原调用结果:
日志进行访问权限控制以达到审计日志不可篡改的目的。此外, 同使用SDK一样,KooCLI将用户命令解析成https请求发送到API Gateway后,API Gateway记录的相关信息也可用作审计目的。 详情请见日志管理。 父主题: 安全
时AK/SK认证身份时,需同时使用此参数。 可用于以无配置方式AKSK调用云服务API。 以无配置方式AKSK调用云服务API: 使用访问密钥(永久AK/SK): hcloud RDS ListApiVersion --cli-region="cn-north-4" --cli-access-key=********
KooCLI既可以使用配置项调用云服务API,也提供了无配置的操作方式,无配置方式使用是指在使用KooCLI时不通过已有配置项传入当前用户的认证信息,而是直接在命令中传入当前用户认证相关的参数。此方式可使用户免于添加配置项,方便快捷地使用KooCLI。用户可以通过如下认证方式直接调用云服务API: 无配置方式AKSK
提示不正确的参数时如何处理? 问题背景 通过KooCLI管理和使用您的各类云服务资源时,在调用云服务API的过程中,会对您输入参数的合法性进行校验。若您在命令中输入了当前API不支持的参数,或将只允许配置在配置项中使用的参数在命令直接传入,会提示如下错误: [USE_ERROR]不正确的参数:*
检查命令正确性 dryrun选项用于检查所传入命令的正确性。在命令中添加“--dryrun”选项,执行校验后打印请求报文,跳过实际运行,不调用目标API: hcloud RDS CreateConfiguration --cli-region="cn-north-4" --project_