文档中心

使用 volcengine-cli

最近更新时间：2023.04.18 19:06:03

首次发布时间：2023.04.18 19:06:03

本文介绍了使用 volcengine-cli 调用接口过程中需要用到的命令以及命令结构。

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

使用以下命令查询支持的服务列表。

volcengine-cli -h

云数据库 MySQL 版已发布了两个版本的 Open API 接口，在 volcengine-cli 中分别注册了服务。

Open API 版本	volcengine-cli 服务
V2（2022-01-01）	rds_mysql_v2
V1（2018-01-01）	rds_mysql

查询服务支持的接口列表

查询服务支持的接口列表的命令结构如下：

volcengine-cli <service name> --help

以云数据库 MySQL 版 V2 版本的 Open API 接口为例，MySQL V2 版本的 Open API 接口在 volcengine-cli 注册的服务名称为 rds_mysql_v2，查询 MySQL 支持的接口列表的命令如下：

volcengine-cli rds_mysql_v2 --help

调用接口

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

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

说明

支持按照 JSON 结构直接传入参数。
对于 ContentType 为 application/json 的请求，volcengine-cli 还支持直接将 body 作为 JSON 数据传入。

您可以使用 volcengine-cli <service name> <action> --help 查看想要调用的API的参数列表、返回结果等信息，如 volcengine-cli rds_mysql_v2 DescribeDBInstances --help。若需要查看 MySQL 更详细的信息，请参见 API 说明中进行查阅。

接口调用示例

调用 MySQL 查询实例接口

volcengine-cli rds_mysql_v2 DescribeDBInstanceDetail --InstanceId mysql-55951954****

调用 MySQL 创建白名单接口（以 JSON 结构直接传入参数）

volcengine-cli rds_mysql_v2 CreateAllowList --AllowListName "test2" --AllowList "10.1.1.1,10.2.3.0/24"

调用 MySQL 创建实例接口（将 body 作为 JSON 数据传入）

volcengine-cli rds_mysql_v2 CreateDatabase --body '{
"InstanceId":"mysql-55951954****",
"DBName":"test3",
"DatabasePrivileges":[
    {
        "AccountName":"user1",
        "AccountPrivilege":"ReadWrite"
    }
] 
}'

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

查询服务支持的接口列表

调用接口