API命令可用选项

更新时间:

本文将为您列举阿里云CLI调用API时可用的命令行选项及其作用。在阿里云CLI中,您可根据需要使用命令行选项,用来修改命令的默认行为或为命令提供额外功能。

选项格式

命令行选项options可用于API命令之后,通用格式如下:

aliyun <product> <ApiName> --option [optionParams]
  • 命令行选项与参数之间使用空格隔开。若选项包含子字段subfield,则通常以subfield=value形式作为参数。有关参数类型及对应格式的详细信息,请参见参数格式说明

  • 若选项后无需设置参数,文档中将进行额外说明。

可用选项列表

选项

详细信息

--profile,-p

使用--profile选项并指定有效配置名称profileName后,阿里云CLI将忽略默认身份凭证配置及环境变量设置,优先使用指定的配置调用命令。

示例:使用指定凭证配置akProfile调用云服务器ECS产品APIDescribeInstances

aliyun ecs DescribeInstances --profile akProfile

--region

使用--region选项并指定有效地域后,阿里云CLI将忽略默认身份凭证配置及环境变量设置中的地域信息,优先使用指定的地域region调用命令。

示例:以指定地域cn-beijing调用云服务器ECS产品APIDescribeInstances

aliyun ecs DescribeInstances --region cn-beijing

--endpoint

使用--endpoint选项可指定调用命令时使用的接入点地址。各云产品支持的接入点地址可在产品对应文档中心开发参考>API参考>服务接入点中查看。

示例:以指定接入点metrics.cn-qingdao.aliyuncs.com调用云监控CMS产品APIDescribeMonitorGroups

aliyun cms DescribeMonitorGroups --endpoint metrics.cn-qingdao.aliyuncs.com

--version

使用--version选项可指定调用命令时访问的API版本YYYY-MM-DD。使用时需结合--force选项,详情请参阅强制调用接口

示例:调用云监控CMS产品2017-03-01版本APIDescribeMetricList

aliyun cms QueryMetricList 
  --Project acs_ecs_dashboard 
  --Metric cpu_idle 
  --version 2017-03-01 
  --force

--header

使用--header选项为命令添加指定的请求头,可重复添加。

示例:为命令添加请求头X-foo=bar

aliyun <product> <ApiName> --header X-foo=bar

--body

使用--body选项可在调用RESTful风格API命令时,为命令添加指定的请求主体。可使用JSON格式字符串或以变量形式引用JSON格式文件。

示例:以容器服务 Kubernetes 版APIRunClusterCheck为例,为命令添加请求主体,主体使用JSON字符串形式。

aliyun cs POST /clusters/{cluster_id}/checks 
  --body "{\"type\":\"NodePoolUpgrade\",\"target\":\"np1f6779297c4444a3a1cdd29be8e5****\"}"

--read-timeout

使用--read-timeout选项可指定命令的I/O超时时间,单位为秒。使用此选项并设置有效参数后,阿里云CLI调用命令时将忽略默认凭证配置中的I/O超时时间。

示例:指定命令I/O超时时间为20秒。

aliyun <product> <ApiName> --read-timeout 20

--connect-timeout

使用--connect-timeout选项可指定命令的连接超时时间,单位为秒。使用此选项并设置有效参数后,阿里云CLI调用命令时将忽略默认凭证配置中的连接超时时间。

示例:指定命令连接超时时间为20秒。

aliyun <product> <ApiName> --connect-timeout 20

--retry-count

使用--retry-count选项可指定命令的重试次数。使用此选项并设置有效参数后,阿里云CLI调用命令时将忽略默认凭证配置中的重试次数。

示例:指定命令重试次数为5次。

aliyun <product> <ApiName> --retry-count 5

--secure

使用--secure选项可强制使用HTTPS方式调用当前命令。

该选项后无需设置参数。

--quiet,-q

使用--quiet选项可关闭正常调用命令时的返回结果输出。

该选项后无需设置参数。

--help

在需要获取帮助的命令层级处键入--help命令,即可获取该命令的帮助信息。

该选项后无需设置参数。

更多详情,请参见获取帮助信息

--output,-o

使用--output选项提取结果中感兴趣的字段,且以表格形式展示返回结果输出。

更多详情,请参见过滤且表格化输出结果

--pager

使用--pager选项,可在调用各云产品的分页类接口时,不分页获取所有的结果。

更多详情,请参见分页类接口结果聚合

--force

使用--force选项可强制调用元数据列表以外的API和参数。

该选项后无需设置参数。

更多详情,请参见强制调用接口

--waiter

使用--waiter选项开启结果轮询,直到某个字段出现特定值时停止轮询,并返回数据。

更多详情,请参见结果轮询

--dryrun

使用--dryrun选项,可打印并检查向服务器发送的请求,不对云资源进行任何实际操作。

该选项后无需设置参数。

更多详情,请参见模拟调用功能