文档中心

使用CLI

最近更新时间：2023.12.01 10:22:13

首次发布时间：2023.09.27 10:09:36

本文介绍使用volcengine-cli调用ECS接口时，需要使用的命令及命令结构。

常用命令

查询volcengine-cli支持的服务列表

您可以执行如下，命令查询支持的火山引擎云产品或云服务列表。

volcengine-cli -h

查询支持的ECS接口列表

您可以执行如下命令，查询volcengine-cli支持调用的云服务器（ecs）接口列表。

volcengine-cli ecs --help

调用接口

命令结构

使用volcengine-cli调用API时，基本命令结构如下：

volcengine-cli <service name> <action> [--parameter1 value1 --parameter2 value2 ...]

参数说明：

参数名	描述	取值样例
volcengine-cli	火山引擎CLI工具名称	volcengine-cli
service name	云服务、云产品或工具命令名。取值：火山引擎云产品或云服务名，表示您需要对相应云上资源进行操作。可查询volcengine-cli支持的服务列表获取，例如ecs（云服务器）、clb（负载均衡）。 volcengine-cli本身的功能，表示您要对CLI工具进行操作。例如`help`、`configure`。	ecs
action	对CLI工具进行的具体操作或调用的API名称。ECS相关产品支持的操作可查询支持的ecs接口列表获取。	DescribeAvailableResource
parameter	操作CLI工具的选项或调用接口的具体参数。说明您可以使用`volcengine-cli <service name> <action> --help`命令，查看目标API的参数列表。如需查看接口返回参数、错误码等详情，可查看ECS API概览。

调用示例

调用DescribeAvailableResource接口，查询可用区中计算资源的库存信息。

volcengine-cli ecs DescribeAvailableResource --DestinationResource InstanceType --ZoneId cn-beijing-b --InstanceTypeId ecs.g2i.large

调用RunInstances接口，创建实例。

volcengine-cli ecs RunInstances --InstanceType ecs.g1ie.xlarge --InstanceName CLI-Test --Volumes.1.Size 50 --Volumes.2.Size 40 --NetworkInterfaces.1.SubnetId subnet-rrqqyxui8f7xxxxxx --NetworkInterfaces.1.SecurityGroupIds.1 sg-13fs52smtolq83n6nxxxxx --ZoneId cn-beijing-b --ImageId image-yc0efeiy0p4qmxxxxxx --Password xxxxxx

调用DescribeSystemEvents接口，查询实例的系统事件信息。

volcengine-cli ecs DescribeSystemEvents --ResourceIds.1 i-yco5idxon4qcxxxxxx

调用InstallCloudAssistant接口，为云服务器实例安装批量作业客户端。
```
volcengine-cli ecs InstallCloudAssistant --InstanceIds.1 i-yco5idxon4qc6xxxxxx
```
调用DescribeCloudAssistantStatus接口，查询实例批量作业客户端的安装状态。
```
volcengine-cli ecs DescribeCloudAssistantStatus --InstanceIds.1 i-yco5idxon4qxxxxxx
```