本文介绍使用火山引擎CLI工具调用云产品API，需要使用的命令及命令结构。编写命令前，您需要了解API的请求方法、服务、Region等信息，您可以在[云产品API文档](https://www.volcengine.com/docs)或[API Explorer](https://api.volcengine.com/api-explorer)中查看相关信息。 :::warning 特别提醒推荐使用API Exolorer的[CLI示例自动生成](https://api.volcengine.com/api-explorer?tab=cli)[工具](https://api.volcengine.com/api-explorer?tab=cli)，自动生成命令，无需手动编写。 ::: ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_3294958c3570b93724f6fa362d4a7c25.png =1094x) ## 调用API ### 命令结构使用CLI工具调用API时，基本命令结构如下： ```Shell ve [--parameter1 value1 --parameter2 value2 ...] ``` 参数说明： |参数名 |描述 |取值样例 | |---|---|---| |ve |火山引擎CLI工具的简称 |ve | |service name |被调用的云服务、云产品或工具命令名。取值：|ecs |\ | || |\ | |* 火山引擎云产品或云服务名，表示您需要对相应云上资源进行操作。可通过`ve -h`获取CLI工具支持的云产品列表，例如ecs（云服务器）、iam（访问控制）。调用不同版本API时，service name请带上版本号，如：iam20210801、rdsmysqlV2| |\ | |* cli工具本身的功能，表示您要对CLI工具进行操作。例如`help`、`configure`。 | | |action |对CLI工具进行的具体操作或调用的API名称。可通过 `ve 云产品ServiceCode --help`获取所支持的API名称。 |DescribeAvailableResource | |parameter |操作CLI工具的选项或调用接口的具体参数。 |ZoneId | ### 以GET或POST（ ContentType:application/x\-www\-form\-urlencoded ）方法调用： ```Shell ve ecs DescribeInstances ``` * 支持传入 JSON，示例： ```Shell ve rds_mysql ModifyDBInstanceIPList --InstanceId "xxxxxx" --GroupName "xxxxxx" --IPList '["10.20.30.40", "50.60.70.80"]' ``` ### 以POST方法（ ContentType:application/json ）调用： * CLI支持直接将 body 作为 JSON 数据传入，示例 ```Shell ve billing ListBill --body '{"BillPeriod":"2026-02","Limit":10}' ``` ## 常用命令 ### 查询CLI工具支持的服务列表您可以执行如下，命令查询支持的火山引擎云产品或云服务列表。如所需云产品或API缺失，请点击页面右下角“文档反馈”给我们。 ```Shell ve -h ``` ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_cc8476fc7d990677e760f4cc996dec28.png) ### 查询云产品支持的API列表您可以执行如下命令，查询cli工具支持调用的API列表，以云服务器ECS为例。 ```Shell ve ecs --help ``` ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_7b41ac03cfe82435ee6d71b62c769680.png) ## 调用API示例 ### 调用云服务 ECS的接口 * 调用[DescribeAvailableResource](https://www.volcengine.com/docs/6396/76279)接口，查询可用区中计算资源的库存信息。 ```Shell ve ecs DescribeAvailableResource --DestinationResource InstanceType --ZoneId cn-beijing-b --InstanceTypeId ecs.g2i.large ``` ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_298a15db1eb275c8cf01118d97b4671d.png) * 调用[RunInstances](https://www.volcengine.com/docs/6396/76275)接口，创建实例。 ```Shell 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 ``` ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_cae6b26a2ea08c24486ff2e122b51f76.png) * 调用[DescribeSystemEvents](https://www.volcengine.com/docs/6396/129399)接口，查询实例的系统事件信息。 ```Shell ve ecs DescribeSystemEvents --ResourceIds.1 i-ycw979n4qxxxxxx ``` ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_f26913ff7a7e2b5ecd0f439bb47c1521.png) * 调用[InstallCloudAssistant](https://www.volcengine.com/docs/6396/1133390)接口，为云服务器实例安装批量作业客户端。 ```Shell ve ecs InstallCloudAssistant --InstanceIds.1 i-ycw979n4qxxxxxx ``` ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_b821b7da8e4a97c49c99220fd6212450.png) * 调用[DescribeCloudAssistantStatus](https://www.volcengine.com/docs/6396/170931)接口，查询实例批量作业客户端的安装状态。 ```Shell ve ecs DescribeCloudAssistantStatus --InstanceIds.1 i-ycw979n4qxxxxxx ``` ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_1d45644bc85588acd7fc501d70b2fbe3.png) ### 调用访问控制 IAM的接口 * 调用[CreateUser](https://www.volcengine.com/docs/6257/65004)接口，添加子用户。 ```Shell ve iam CreateUser --UserName jake --DisplayName 张三 --MobilePhone 13********2 ``` ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_a4667c0f2a3e9b83edbf05619cc79674.png) * 调用[GetUser](https://www.volcengine.com/docs/6257/65005)接口，查询子用户信息。 ```Shell ve iam GetUser --UserName jake ``` ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_0ed7c0d739b19f14502a4b17a3c64233.png)