文档中心

CLI工具

使用CLI

本文介绍使用火山引擎CLI工具调用云产品API，需要使用的命令及命令结构。编写命令前，您需要了解API的请求方法、服务、Region等信息，您可以在云产品API文档或API Explorer中查看相关信息。如有问题，请通过Github Issues反馈给我们。

特别提醒

推荐使用API Exolorer的CLI示例自动生成工具，自动生成命令，无需手动编写。

调用API

命令结构

使用CLI工具调用API时，基本命令结构如下：

参数说明：

参数名	描述	取值样例
ve	火山引擎CLI工具的简称	ve
service name	被调用的云服务、云产品或工具命令名。取值：火山引擎云产品或云服务名，表示您需要对相应云上资源进行操作。可通过ve -h获取CLI工具支持的云产品列表，例如ecs（云服务器）、iam（访问控制）。调用不同版本API时，service name请带上版本号，如：iam20210801、rdsmysqlV2 cli工具本身的功能，表示您要对CLI工具进行操作。例如help、configure。	ecs
action	对CLI工具进行的具体操作或调用的API名称。可通过 ve 云产品ServiceCode --help获取所支持的API名称。	DescribeAvailableResource
parameter	操作CLI工具的选项或调用接口的具体参数。	ZoneId
--profile	CLI系统固定参数，非必填，可用于本次调用临时指定profile。使用三横线 ---，不会和 API 的双横线参数产生冲突。	profilename
--region	CLI系统固定参数，非必填，可用于本次调用临时指定region。使用三横线 ---，不会和 API 的双横线参数产生冲突。	cn-beijing
--endpoint	CLI系统固定参数，非必填，可用于本次调用临时指定endpoint。使用三横线 ---，不会和 API 的双横线参数产生冲突。	ecs.cn-beijing.volcengineapi.com

以GET或POST（ ContentType:application/x-www-form-urlencoded ）方法调用：

以POST方法（ ContentType:application/json ）调用：

高阶功能参数说明

注意

以下参数仅在1.0.48及以上版本支持，低版本请参考安装说明升级后使用。

参数	作用
--profile	本次调用使用指定 profile，不修改 current。如果指向不存在的 profile，会直接报错。
--region	本次调用覆盖 region。
--endpoint	本次调用覆盖 endpoint，并清空 endpoint resolver。