选项概述
KooCLI选项是指可以直接在调用API的命令中添加的系统参数,KooCLI支持的选项及其功能如下表所示。其中除“help”,“debug”,“dryrun”,“cli-username”,“cli-password”,“cli-domain”,“cli-output”,“cli-query”,“cli-output-num”,“cli-jsonInput”,“cli-endpoint”之外,其余选项支持被设置到配置项中。执行命令时,命令中的参数值优先于配置项中该参数值。
命令选项 |
说明 |
使用示例 |
---|---|---|
打印帮助信息 |
hcloud RDS ListCollations --cli-region="ap-southeast-1" --help |
|
打印命令调用过程中的调试信息。如API调用过程中的执行步骤,完整的请求URL等。 |
hcloud VPC ShowVpc/v3 --cli-region="ap-southeast-1" --project_id="0dd8cb****************19b5a84546" --vpc_id="0bbe****-****-****-****-****235be6e7" --debug |
|
检查命令正确性。执行校验后打印请求报文,跳过实际运行,不调用目标API。 |
hcloud RDS CreateConfiguration --cli-region="ap-southeast-1" --project_id="4ff018c******************df31948" --datastore.type="MySQL" --datastore.version="5.7" --values.max_connections="10" --name="test-001" --description="test create configuration" --dryrun |
|
区域,表示在指定的区域中管理云服务资源。 |
hcloud EVS DeleteVolume --cli-region="ap-southeast-1" --volume_id="aed9****-****-****-****-****0e3219cf" --project_id="0dd8cb****************19b5a84546" |
|
用于以无配置方式Account调用云服务API。 |
hcloud EVS UpdateVolume --cli-region="ap-southeast-1" --volume_id="aed9****-****-****-****-****0e3219cf" --project_id="0dd8cb****************19b5a84546" --volume.name="ecs-abcd" --volume.description="volume test" --cli-username=s******1 --cli-password=****** --cli-domain=s******1 |
|
可用于以无配置方式AKSK调用云服务API。 |
以无配置方式AKSK调用云服务API:
|
|
系统颁发给IAM用户的访问令牌。可用于以无配置方式Token调用云服务API。 |
hcloud ECS ListServersDetails --cli-region="ap-southeast-1" --project_id="2cc60f5****************efa5019ef" --enterprise_project_id="441d5677-****-****-****-ef7fd6336666" --cli-x-auth-token=****** |
|
cli-agency-domain-id/cli-agency-domain-name,cli-agency-name,cli-source-profile 选项 |
可用于以无配置方式agency调用云服务API。 |
hcloud VPC ListAddressGroup/v3 --cli-region="ap-southeast-1" --project_id="2cc60****************caefa5019ef" --cli-agency-domain-id=13534326******************5cf67b --cli-agency-name=****** --cli-source-profile=test |
IAM用户所属帐号ID。以AKSK认证模式调用全局服务的API时需要。一般情况下,调用全局服务的API时,KooCLI会根据用户的认证信息自动获取此参数的值。 |
hcloud CDN ListDomains --cli-region="ap-southeast-1" --cli-domain-id="08e09a6e******************1bb800" |
|
KooCLI配置项名称,配置项用于存储一组调用云服务API时所需的公共信息,例如AK/SK,区域,项目ID等。 |
hcloud EVS ListSnapshots --cli-profile=test |
|
指定配置项的认证模式,取值为:
若同一配置项中已配置多种认证模式相关的参数,例如:同时配置了AK/SK和token,使用配置项中cli-mode指定的方式进行认证鉴权。可在命令中使用“--cli-mode”指定配置项的认证模式。 |
|
|
用于指定结果的输出格式。
|
|
|
指定JSON文件的方式传递API参数。当云服务API的参数过多时,可将参数定义在一个JSON文件中,KooCLI会解析该文件中的参数内容。 |
hcloud ECS CreateServers --cli-region="ap-southeast-1" --cli-read-timeout=60 --cli-jsonInput=C:\cli\Ecs_CreateServers.json |
|
请求超时时间。
|
hcloud ECS DeleteServerPassword --cli-region="ap-southeast-1" --project_id="2cc60f5****************efa5019ef" --server_id="e6b99563-****-****-****-1820d4fd2a67" --cli-connect-timeout=10 --cli-read-timeout=15 |
|
请求连接重试次数。即:若请求连接超时,会自动重试。默认取值为0次,取值范围为0~5次。 |
hcloud RDS ListInstances --cli-region="ap-southeast-1" --Content-Type="application/json" --project_id="2cc60****************caefa5019ef" --cli-retry-count=3 |
|
跳过https请求证书验证(不建议)。取值为true或false,默认为false。因跳过证书验证时存在安全风险,故当其取值为true时,KooCLI会向用户交互确认。 |
hcloud ECS NovaListServers --cli-region="ap-southeast-1" --project_id="2cc6****************6caefa5019ef" --cli-skip-secure-verify=true |
|
自定义请求域名。 默认会请求对应区域的目标云服务,您也可以针对该云服务指定Endpoint。 |
hcloud IoTDA UpdateDevice --cli-region="ap-southeast-1" --description="test update device" --device_id="testz*********************0802" --cli-endpoint="iot-mqtts.ap-southeast-1.myhuaweicloud.com" |