CLI参考

CLI使用方式

安装和配置CLI

通过CLI调用ECS API

安装配置好CLI后，您可以在终端按照以下命令结构，调用ECS API。

aliyun ecs <API Name> --<参数1 取值1> --<参数2 取值2> ...

CLI调用示例

以下示例为您展示如何使用阿里云CLI调用云服务器ECS API。

创建ECS实例

以在杭州地域创建一个基于Alibaba Cloud Linux镜像的包年包月的ECS实例为例，指导您如何通过CLI创建ECS实例。

1. 准备工作。

   在创建ECS实例前，请确保您已经创建了专有网络VPC、交换机、安全组，并获取其ID。

   说明

   如果您已有上述资源且符合需求，可跳过该步骤。

   1. 调用CreateVpc创建VPC。

      假设在华东1（杭州）创建专有网络VPC，VPC网段为192.168.0.0/16。

      • 请求示例

        aliyun vpc CreateVpc \
        --RegionId cn-hangzhou \
        --CidrBlock 192.168.0.0/16 

      • 返回示例

        {
          "RequestId": "EC94C73B-8103-4B86-B353-E65C7C9E****",
          "ResourceGroupId": "rg-acfmzw2jz2z****",
          "RouteTableId": "vtb-bp1jxpr9ji5wcn4yv****",
          "VRouterId": "vrt-bp1dyxemup2q4ouga****",
          "VpcId": "vpc-bp1d9v4763ym2hlzt****"
        }

   2. 调用CreateVSwitch在VPC中创建交换机。

      假设交换机网段为192.168.0.0/24，VPC ID为vpc-bp1d9v4763ym2hlzt****。

      • 请求示例

        aliyun vpc CreateVSwitch \
        --CidrBlock 192.168.0.0/24 \
        --VpcId vpc-bp1d9v4763ym2hlzt**** \
        --ZoneId=cn-hangzhou-i

      • 返回示例

        {
                "RequestId": "AF1787C4-0D81-44F0-A324-D5C54EA0****",
                "VSwitchId": "vsw-bp11hf5r945gewysp****"
        }

   3. 调用CreateSecurityGroup创建安全组。

      • 请求示例

        aliyun ecs CreateSecurityGroup \
        --RegionId cn-hangzhou \
        --VpcId vpc-bp1d9v4763ym2hlzt****

      • 返回示例

        {
                "RequestId": "B1C25C34-9B84-49E3-9E50-FB7D7970****",
                "SecurityGroupId": "sg-bp18z2q1jg4gq95t****"
        }

   4. 调用AuthorizeSecurityGroup添加安全组规则。

      假设在安全组（ID为sg-bp18z2q1jg4gq95t****）的入方向放行22端口，协议为TCP。

      • 请求示例

        aliyun ecs AuthorizeSecurityGroup \
        --RegionId cn-hangzhou \
        --SecurityGroupId sg-bp18z2q1jg4gq95t**** \
        --IpProtocol tcp \
        --SourceCidrIp 0.0.0.0/0 \
        --PortRange 22/22

      • 返回示例

        {
         "RequestId": "FA8B1E61-C9C9-4D91-9628-64B8E2F4****"
        }

2. 创建ECS实例。

   调用RunInstances创建一个包年包月的ECS实例。

   1. 场景示例

      参数	示例取值
      RegionId	地域：cn-hangzhou
      ImageId	镜像：推荐使用Alibaba Cloud Linux镜像aliyun_3_x64_20G_alibase_20240528.vhd。
      InstanceType	实例规格： 个人应用：推荐选择2 vCPU 2 GiB的实例规格ecs.e-c1m1.large。 中小企业应用：推荐选择2 vCPU 4 GiB的实例规格ecs.c7.large。
      SecurityGroupId	安全组ID：根据CreateSecurityGroup返回结果。 示例：sg-bp18z2q1jg4gq95t****
      VSwitchId	交换机ID：根据CreateVSwitch返回结果。 示例：vsw-bp11hf5r945gewysp****
      InstanceName	实例名称。 示例：ecs_cli_demo
      InstanceChargeType	付费方式：实例按照包年包月的付费方式PrePaid。 说明 您需要确保账号余额能够完成支付。
      PeriodUnit	付费周期单位：Month
      Period	付费时长：1
      InternetMaxBandwidthOut	公网IP带宽：1
      Password	实例登录密码：<yourPassword> 说明 您需要自定义复杂密码以保护ECS实例的安全。
      SystemDisk.Category	系统盘类型：cloud_essd
      SystemDisk.Size	系统盘大小：40

   2. 请求示例

      aliyun ecs RunInstances \
      --RegionId cn-hangzhou \
      --ImageId aliyun_3_x64_20G_alibase_20240528.vhd \
      --InstanceType ecs.c7.large \
      --SecurityGroupId sg-bp18z2q1jg4gq95t**** \
      --VSwitchId vsw-bp11hf5r945gewys**** \
      --InstanceName ecs_cli_demo \
      --InstanceChargeType PrePaid \
      --PeriodUnit Month \
      --Period 1 \
      --InternetMaxBandwidthOut 1 \
      --Password <yourPassword>  \
      --SystemDisk.Category cloud_essd \
      --SystemDisk.Size 40

   3. 返回示例

      { 
              "InstanceIdSets": {
                      "InstanceIdSet": [
                              "i-bp1de173dp87k5uv****"
                      ]
              },
              "OrderId": 23577729747****,
              "RequestId": "B0855F1A-279F-5153-BAA9-C245E073****",
              "TradePrice": ****
      }

连接实例

1. 获取实例的公网IP信息。

   调用DescribeInstances，通过实例ID（i-bp1ducce5hs1jm98****）获取实例的公网IP信息。

   • 请求示例

     aliyun ecs DescribeInstances \
     --RegionId cn-hangzhou \
     --InstanceIds '["i-bp1ducce5hs1jm98****"]'

   • 返回示例

     参数PublicIpAddresses为实例的公网IP信息。

     

2. 连接ECS实例。

   ssh <用户名>@<公网IP>

   

启动实例

调用StartInstance接口启动一台ECS实例。

• 场景示例：实例ID为i-bp1aq39j2yul5y01****，地域为华东1（杭州）（cn-hangzhou），启动实例时不进行故障处理，并且预检查后直接启动ECS实例。

• 请求示例

  aliyun ecs StartInstance \
  --RegionId cn-hangzhou \
  --InstanceId i-bp1aq39j2yul5y01**** \
  --InitLocalDisk false \
  --DryRun false

• 返回示例

  {
   "RequestId": "2DD09CBD-1F4D-4923-94C7-F3BD67137BBE"
  }

查询实例的详细信息

您可以调用DescribeInstances接口查询一台或多台ECS实例的详细信息。

创建快照

调用CreateSnapshot接口创建快照。

• 场景示例：为ESSD云盘d-bp14bjlwo3t3owin****创建一个快照（快照名称为demoname，描述为demo，保留时间：3天）。

• 请求示例

  aliyun ecs CreateSnapshot \
  --DiskId d-bp14bjlwo3t3owin**** \
  --SnapshotName demoname \
  --Description demo \
  --RetentionDays 3

• 返回示例

  {
   "RequestId": "DFB0B01F-420D-4932-911E-7328920C2012",
   "SnapshotId": "s-bp1eyr9nxxoo9icj****"
  }

通过实例创建自定义镜像

调用CreateImage接口，基于ECS实例创建一个自定义镜像。

• 场景示例

  参数	示例取值
  实例ID	i-bp1aq39j2yul5y01****
  操作系统	Alibaba Cloud Linux（即Platform为Aliyun）
  地域	cn-hangzhou

• 请求示例

  aliyun ecs CreateImage \
  --RegionId cn-hangzhou \
  --InstanceId i-bp1aq39j2yul5y01**** \
  --ImageName demoimage \
  --Description demoimage \
  --Platform Aliyun

• 返回示例

  {
   "ImageId": "m-bp1503ydxxrppctb****",
   "RequestId": "011AE447-20CE-4043-81AC-7AF2BBC4****"
  }

停止实例

调用StopInstance停止一台运行中（Running）的ECS实例，正常关机（ForceStop为 false）且停机模式为普通停机模式（StoppedMode为KeepCharging，即停止后仍旧保留实例并继续收费），预检查后正常停止ECS实例。

• 场景示例：实例ID为i-bp1aq39j2yul5y01****，地域为华东1（杭州）（cn-hangzhou）。

• 请求示例

  aliyun ecs StopInstance \
  --RegionId cn-hangzhou \
  --InstanceId i-bp1aq39j2yul5y01**** \
  --ForceStop false \
  --StoppedMode KeepCharging \
  --DryRun false

• 返回示例

  {
      "RequestId": "121B5745-4983-57B1-BC97-C3A3536E****"
  }

相关文档

本示例仅使用部分API，更多ECS API信息，请参见API概览。

在阿里云CLI中，您可根据需要使用命令行选项，用来修改命令的默认行为或为命令提供额外功能，请参见API命令可用选项。