全部产品
Search
文档中心

阿里云CLI:生成并调用命令

更新时间:Jul 11, 2024

阿里云CLI支持多款阿里云产品,本文将向您展示如何使用阿里云CLI命令调用常用API,以及如何在OpenAPI门户中生成CLI命令示例。

说明

重要

部分 API 涉及资源计费,请在进行调试命令之前确保已经开通所需的云产品,并了解该产品的计费规则以及产品OpenAPI的使用方式。

  • 在本地调试命令之前,请确保您已经安装阿里云CLI并正确配置身份凭证信息,详情请参见安装指南配置凭证

  • 您可在OpenAPI门户中通过产品名获取产品的全部API文档以及对应阿里云CLI命令示例。具体操作请参见生成命令

命令结构

在阿里云CLI中,使用的命令行结构如下:

aliyun <command> <subcommand> [options and parameters]
  • command:指定一个顶级命令。

    • 可指定阿里云CLI支持的云产品code,例如ecsrds等。

    • 可指定阿里云CLI本身的功能命令,例如helpconfigure等。

  • subcommand:指定要执行操作的附加子命令,即具体的某一项操作。

    • 当顶级命令commandconfigure时,支持附加子命令请参见configure功能子命令

    • 当顶级命令command为云产品code时,支持附加子命令为可调用的OpenAPI名称。更多云产品OpenAPI,请参见查找API

  • options and parameters:指定用于控制阿里云CLI行为的选项或者API参数选项,其选项值可以是数字、字符串和JSON结构字符串等。更多参数格式信息,请参见参数格式说明

  • 阿里云云产品的API分为RPC和RESTful两种类型,大部分产品使用的是RPC风格。不同风格的API,调用方式不同。详情请参见调用RPC API和RESTful API

调用示例

以下代码示例将为您展示如何使用阿里云CLI调用云服务器 ECS中的CreateInstance命令,创建一台按量付费ECS实例。获取更多阿里云CLI命令,请参见生成命令

  1. 执行命令。

    aliyun ecs CreateInstance
        --InstanceName myvm1
        --ImageId centos_7_03_64_40G_alibase_20170625.vhd
        --InstanceType ecs.n4.small
        --SecurityGroupId sg-xxxxxx123
        --VSwitchId vsw-xxxxxx456
        --InternetChargeType PayByTraffic
        --Password xxx
  2. 输出结果。

    {
      "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
      "InstanceId": "i-bp67acfmxazb4p****",
      "OrderId": "1234567890",
      "TradePrice": 0.165
    }
  3. 您可以通过OpenAPI、SDK或者云服务器 ECS控制台等方式,检查操作是否正确完成。

生成命令

OpenAPI门户提供了阿里云CLI命令在线生成功能,您可通过此方式获取需要的阿里云CLI命令。

步骤一:登录OpenAPI门户

登录OpenAPI 门户

步骤二:查找需生成示例的API

OpenAPI门户提供了多种API查询入口,您可以选择任意方式完成操作。

首页搜索框

  • OpenAPI门户首页搜索框中输入目标API所属云产品信息,在搜索结果中定位所需云服务,单击查看API即可跳转至该产品API调试界面。

    image

  • 您也可以直接输入目标API名称,在搜索结果中定位所需API,单击去调试即可跳转至该API调试界面。不同云产品可能存在相同名称的API,请您根据需要选择正确的API。

    image

顶部导航栏

OpenAPI门户顶部导航栏中单击选择云产品,在面板中根据需要选择云产品。进入云产品主页后,单击主页右上角去调试,或左侧列表调试,即可跳转至该产品API调试界面。

image

顶部搜索框

  • OpenAPI门户顶部搜索框中输入目标API所属云产品信息,在搜索结果中定位所需云服务,单击查看API即可跳转至该产品API调试界面。

    image

  • 您也可以直接输入目标API名称,在搜索结果中定位所需API,单击去调试即可跳转至API调试界面。不同云产品可能存在相同名称的API,请您根据需要选择正确的API。

    image

步骤三:生成CLI示例

在API调试界面左侧搜索框中可搜索您需要使用的API,在参数配置中根据API文档信息填写参数,单击参数配置右侧的CLI示例标签页后即可生成携带参数的命令示例。

说明

带星号(*)标记的为必选参数,您必须提供该参数的值。

image

步骤四:调试命令(可选)

  • 单击命令示例右侧的复制按钮,复制命令示例后可粘贴到本地Shell工具中完成命令调试。

    说明
    • 复制CLI示例到本地Shell工具中进行调试时请注意参数格式。关于阿里云CLI命令参数使用格式的详细信息,请参见参数格式说明

    • OpenAPI门户生成示例中会默认添加--region子命令,复制命令到本地调用时会覆盖身份凭证配置中的region设置,您可根据需要对此命令进行删除或保留。

    image

    image

  • 单击命令示例右侧的运行命令按钮,可唤出云命令行并快速完成命令调试。

    image