使用CLI
最近更新时间：2024.01.15 12:12:12
首次发布时间：2024.01.11 16:02:46
本文介绍使用火山引擎CLI工具调用云产品API时，需要使用的命令及命令结构。
调用API
命令结构
使用CLI工具调用API时，基本命令结构如下：
ve <service name> <action> [--parameter1 value1 --parameter2 value2 ...]
参数说明：
| 参数名 | 描述 | 取值样例 |
|---|---|---|
| ve | 火山引擎CLI工具的简称 | ve |
service name | 被调用的云服务、云产品或工具命令名。取值：
| ecs |
| action | 对CLI工具进行的具体操作或调用的API名称。可通过 ve 云产品ServiceCode --help获取所支持的API名称。 | DescribeAvailableResource |
| parameter | 操作CLI工具的选项或调用接口的具体参数。 | ZoneId |
常用命令
查询CLI工具支持的服务列表
您可以执行如下，命令查询支持的火山引擎云产品或云服务列表。如所需云产品或API缺失，请点击页面右下角“文档反馈”给我们。
ve -h
查询云产品支持的API列表
您可以执行如下命令，查询cli工具支持调用的API列表，以云服务器ECS为例。
ve ecs --help
调用API示例
调用云服务 ECS的接口
- 调用DescribeAvailableResource接口，查询可用区中计算资源的库存信息。
ve ecs DescribeAvailableResource --DestinationResource InstanceType --ZoneId cn-beijing-b --InstanceTypeId ecs.g2i.large
- 调用RunInstances接口，创建实例。
ve ecs RunInstances --InstanceType ecs.g1ie.xlarge --InstanceName CLI-Test --Volumes.1.Size 50 --Volumes.2.Size 40 --NetworkInterfaces.1.SubnetId subnet-fff70pge8f7xxxxxx --NetworkInterfaces.1.SecurityGroupIds.1 sg-fff707smtolq83n6nxxxxx --ZoneId cn-beijing-a --ImageId image-ycndlriy0p4qmxxxxxx --Password xxxxxx
- 调用DescribeSystemEvents接口，查询实例的系统事件信息。
ve ecs DescribeSystemEvents --ResourceIds.1 i-ycw979n4qxxxxxx
- 调用InstallCloudAssistant接口，为云服务器实例安装批量作业客户端。
ve ecs InstallCloudAssistant --InstanceIds.1 i-ycw979n4qxxxxxx
- 调用DescribeCloudAssistantStatus接口，查询实例批量作业客户端的安装状态。
ve ecs DescribeCloudAssistantStatus --InstanceIds.1 i-ycw979n4qxxxxxx
调用访问控制 IAM的接口
- 调用CreateUser接口，添加子用户。
ve iam CreateUser --UserName jake --DisplayName 张三 --MobilePhone 13********2
- 调用GetUser接口，查询子用户信息。
ve iam GetUser --UserName jake
