阿里云CLI命令行选项

选项

说明

--profile,-p

指定配置名称后，阿里云CLI将忽略默认身份凭证配置及环境变量设置，优先使用指定的配置调用命令。

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

aliyun ecs DescribeInstances --profile akProfile

--region

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

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

aliyun ecs DescribeInstances --region cn-beijing

--endpoint

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

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

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

--version

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

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

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

--header

为命令添加指定的请求头，可重复添加。

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

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

--body

在调用ROA风格API命令时，传入字符串格式参数作为请求主体。

示例：以容器服务 Kubernetes 版的RunClusterCheck接口为例，为命令添加请求主体，主体使用JSON字符串形式。

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

--body-file

在调用ROA风格API命令时，传入指定文件作为请求主体。该选项优先级高于--body选项。

示例：以容器服务 Kubernetes 版的RunClusterCheck接口为例，为命令添加请求主体。

aliyun cs POST /clusters/{cluster_id}/checks --body-file /usr/local/bin/example.json

{
    "type": "NodePoolUpgrade",
    "target": "np1f6779297c4444a3a1cdd29be8e5****"
}

--read-timeout

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

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

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

--connect-timeout

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

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

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

--retry-count

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

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

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

--secure

使用后可强制使用HTTPS协议调用OpenAPI。若目标接口不支持HTTPS协议，启用该选项将导致请求失败。

--insecure

使用后可强制使用HTTP协议调用OpenAPI。若目标接口不支持HTTP协议，启用该选项将导致请求失败。

--quiet,-q

关闭正常调用命令时的返回结果输出。

--help

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

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

--output,-o

提取OpenAPI返回结果中的字段，且以表格形式展示返回结果输出。

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

--pager

在调用各云产品的分页类接口时，不分页获取所有的结果。

更多详情，请参见聚合分页数据。

--force

强制调用元数据列表以外的API和参数。

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

--waiter

使用此选项可开启结果轮询，直到某个字段出现特定值时停止轮询，并返回响应数据。

更多详情，请参见结果轮询。

--dryrun

使用此选项将完整打印向服务器发起的请求信息，用于调试和验证，不会对任何云上资源进行实际更改或操作。

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