文档

获取帮助信息

更新时间:
一键部署

阿里云CLI中集成了产品列表、API列表和API参数信息,在需要获取帮助的命令层级处键入--help命令,即可获取该命令的帮助信息。

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

  • 语法

    aliyun --help
  • 示例

    image

获取产品可用API列表

列表包含API名称及API简述,RESTful风格API简述为访问路径PathPattern

  • 语法

    aliyun <product> --help
  • 示例

    以获取云服务器ECS产品可用API列表为例,执行命令。

    aliyun ecs --help

    image

获取API参数详情

参数详情包括参数名、参数类型、参数是否必选等信息。

  • 语法

    aliyun <product> <ApiName> --help
  • 示例

    以获取云服务器ECS产品DescribeInstances接口的参数信息为例,执行命令。

    aliyun ecs DescribeRegions --help

    image

相关文档

如果帮助信息中并没有您需要的API信息,同时,您确定产品下存在该API,并了解其使用方法,可通过使用强制调用功能调用该接口。详情请参见强制调用接口