平凯数据库云服务 CLI 参考（Beta）

平凯数据库云服务 CLI 是一个命令行界面，允许你通过几行命令在终端中操作平凯数据库云服务。在平凯数据库云服务 CLI 中，你可以轻松管理 平凯云 Starter 和 Essential 实例、向实例导入数据以及执行更多操作。

开始之前

请确保你已先完成平凯数据库云服务 CLI 环境的设置。安装好 ticloud CLI 后，你就可以通过命令行管理 平凯云 Starter 和 Essential 实例。

可用命令

下表列出了平凯数据库云服务 CLI 支持的命令。

要在终端中使用 ticloud CLI，请运行 ticloud [command] [subcommand]。如果你在使用 TiUP，请改用 tiup cloud [command] [subcommand]。

命令模式

平凯数据库云服务 CLI 针对部分命令提供了两种模式，便于使用：

• 交互模式

  你可以在不带参数的情况下运行命令（如 ticloud config create），CLI 会提示你输入相关信息。

• 非交互模式

  你需要在运行命令时提供所有必需的参数和选项，例如 ticloud config create --profile-name <profile-name> --public-key <public-key> --private-key <private-key>。

用户配置文件

对于平凯数据库云服务 CLI，用户配置文件是与用户相关的一组属性，包括配置文件名、公钥、私钥和 OAuth token。要使用平凯数据库云服务 CLI，你必须拥有一个用户配置文件。

使用平凯数据库云服务 API key 创建用户配置文件

使用 ticloud config create 创建用户配置文件。

使用 OAuth token 创建用户配置文件

使用 ticloud auth login 为当前配置文件分配 OAuth token。如果不存在任何配置文件，则会自动创建一个名为 default 的配置文件。

i

Note

在上述两种方式中，平凯数据库云服务 API key 的优先级高于 OAuth token。如果当前配置文件中同时存在两者，将优先使用 API key。

列出所有用户配置文件

使用 ticloud config list 列出所有用户配置文件。

示例输出如下：

Profile Name
default (active)
dev
staging

在此示例输出中，default 用户配置文件为当前激活状态。

查看用户配置文件详情

使用 ticloud config describe 获取用户配置文件的属性。

示例输出如下：

{
  "private-key": "xxxxxxx-xxx-xxxxx-xxx-xxxxx",
  "public-key": "Uxxxxxxx"
}

设置用户配置文件属性

使用 ticloud config set 设置用户配置文件中的属性。

切换到其他用户配置文件

使用 ticloud config use 切换到其他用户配置文件。

示例输出如下：

Current profile has been changed to default

编辑配置文件

使用 ticloud config edit 打开配置文件进行编辑。

删除用户配置文件

使用 ticloud config delete 删除用户配置文件。

全局参数

下表列出了平凯数据库云服务 CLI 的全局参数。

反馈

如果你对平凯数据库云服务 CLI 有任何问题或建议，欢迎在 issue 页面提交。同时，我们也欢迎任何贡献。