如何使用阿里云CLI的帮助文档 - 阿里云CLI

阿里云CLI集成了产品和API信息，输入--help选项可获取详细的命令帮助信息。

获取支持产品列表及可用命令行选项

在aliyun命令后使用--help选项，获取通用命令行选项及支持产品列表。

执行以下命令。
```
aliyun --help
```

预期返回如下信息（部分截取）。

shell@Alicloud:~$ aliyun --help
阿里云CLI命令行工具 3.0.276

Usage:
  aliyun <product> <operation> [--parameter1 value1 --parameter2 value2 ...]

Flags:
  --mode                    使用 `--mode {AK|StsToken|RamRoleArn|EcsRamRole|RsaKeyPair|RamRoleArnWithRoleName}` 指定认证方式
  --profile,-p              使用 `--profile <profileName>` 指定操作的配置集
  ...
  --help                    打印帮助信息

Sample:
  aliyun ecs DescribeRegions

Products:
  actiontrail                  操作审计
  adb                          云原生数据仓库AnalyticDB MySQL版
  adcp                         分布式云容器平台
  ...

获取产品可用OpenAPI列表

在产品code后使用--help选项，获取产品可用OpenAPI列表。RPC风格OpenAPI通常会在列表中显示接口简述，ROA风格OpenAPI通常在列表中显示访问路径。

RPC风格

执行如下命令，以获取云服务器 ECS（Elastic Compute Service）产品可用OpenAPI列表为例。
```
aliyun ecs --help
```

预期返回如下信息。

shell@Alicloud:~$ aliyun ecs --help
阿里云CLI命令行工具 3.0.276

Usage:
  aliyun ecs <ApiName> --parameter1 value1 --parameter2 value2 ...

Product: Ecs (云服务器 ECS)
Version: 2014-05-26 

Available Api List: 
  AcceptInquiredSystemEvent                          调用AcceptInquiredSystemEvent接受并授权执行系统事件操作。对问询中（Inquiring）状态的系统事件，接受系统事件的默认操作，授权系统执行默认操作。
  ActivateRouterInterface                            [Deprecated]激活处于Inactive状态的路由器接口。
  AddBandwidthPackageIps                             [Deprecated]
  AddTags                                            添加或者覆盖一个或者多个标签到云服务器ECS的各项资源上。您可以添加标签到实例、磁盘、快照、镜像、安全组等，便于管理资源。
  ...

ROA风格

执行如下命令，以获取容器服务 Kubernetes 版 ACK（Container Service for Kubernetes）产品可用OpenAPI列表为例。
```
aliyun cs --help
```

预期返回如下信息。

shell@Alicloud:~$ aliyun cs --help
阿里云CLI命令行工具 3.0.276

Usage 1:
  aliyun cs [GET|PUT|POST|DELETE] <PathPattern> --body "..." 

Usage 2 (For API with NO PARAMS in PathPattern only.):
  aliyun cs <ApiName> --parameter1 value1 --parameter2 value2 ... --body "..."

Product: CS (容器服务Kubernetes版)
Version: 2015-12-15 

Available Api List: 
  AttachInstances                         : POST /clusters/[ClusterId]/attach
  AttachInstancesToNodePool               : POST /clusters/[ClusterId]/nodepools/[NodepoolId]/attach
  CancelClusterUpgrade                    : POST /api/v2/clusters/[ClusterId]/upgrade/cancel
  CancelComponentUpgrade                  : POST /clusters/[clusterId]/components/[componentId]/cancel
  ...

获取OpenAPI参数详情

在接口名称后使用--help选项，获取OpenAPI可用参数的详细信息，包括参数名称、参数类型等。ROA风格OpenAPI会额外显示请求方式及访问路径。

RPC风格

执行如下命令，以获取云服务器 ECSDescribeRegions接口的参数信息为例。
```
aliyun ecs DescribeRegions --help
```

预期返回如下信息。

shell@Alicloud:~$ aliyun ecs DescribeRegions --help
阿里云CLI命令行工具 3.0.276

Product: Ecs (云服务器 ECS)

Parameters:
  --AcceptLanguage String  Optional

  根据汉语、英语和日语筛选返回结果。更多详情，请参见[RFC7231](https://tools.ietf.org/html/rfc7231)。取值范围：  
           
  - zh-CN：中文。
  - en-US：英文。
  - ja：日文。
  
  默认值为zh-CN。

  --InstanceChargeType String  Optional

  实例的计费方式，更多详情，请参见[计费概述](~~25398~~)。取值范围：
  
  - PrePaid：包年包月。此时，您必须确认自己的账号支持余额支付或者信用支付，否则将报错InvalidPayMethod。
  - PostPaid：按量付费。
  
  默认值为PostPaid。

  --ResourceType String  Optional

  资源类型。取值范围：
  -  instance：ECS实例
  -  disk：磁盘
  -  reservedinstance：预留实例券
  -  scu：存储容量单位包
  
  默认值：instance

ROA风格

执行如下命令，以获取容器服务 Kubernetes 版AttachInstances接口的参数信息为例。
```
aliyun cs AttachInstances --help
```

预期返回如下信息。

shell@Alicloud:~$ aliyun cs AttachInstances --help
阿里云CLI命令行工具 3.0.276

Product:     CS (容器服务Kubernetes版)
Method:      POST
PathPattern: /clusters/[ClusterId]/attach

Parameters:
  --ClusterId String  Required

  集群ID。

  --body Struct  Optional

  请求体参数。