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命令可用選項。