【TcaplusDB知识库】TcaplusDB CLI工具介绍

前言

TcaplusDB提供了丰富的功能接口来满足不同用户使用TcaplusDB的需求。针对腾讯云控制台一些的操作，目前已将TcaplusDB控制台相关操作集成在TencentCloud SDK中，用户可通过腾讯云API-Explorer平台进行在线代码调试。为进一步满足用户更便利使用控制台相关操作的需求，针对现有的TencentCloud SDK中关于TcaplusDB控制台操作相关的API作进一步的整合，主要目的是提供一个通用工具来实现所有相关控制台的操作，同时又能满足TcaplusDB本地Docker环境相关表操作。

TcaplusDB CLI工具主要用于腾讯云控制台和本地Docker版本进行TcaplusDB相关操作，如集群、表格组、表的创建、删除、查询、扩容等操作。

获取方式

工具包	下载
tcapluscli.tgz	Download

功能列表

本工具支持腾讯云TcaplusDB控制台相关操作命令，也支持Docker本地版相关操作命令，具体支持功能如下:

支持云控制台Secret安全信息设置(secret_id, secret_key)
支持云控制台表集群创建、删除、查询
支持云控制台表格组创建、删除、查询
支持本地Docker版表格组创建、删除、查询
支持云控制台表创建、删除、清理、查询、扩容、回收站恢复、批量创建、批量清理、批量扩容
支持本地Docker版表创建、删除、清理

工具依赖

环境依赖

针对不同的操作系统平台，已编译好相关操作系统平台的二进制执行文件，用户可选择对应OS平台的工具来进行相关操作。如下：

操作系统	版本	平台	工具名称
MacOS	Darwin-17.7.0	intel/x86_64	tcapluscli-macos
CentOS	7	intel/x86_64	tcapluscli-centos7-i386
CentOS	8	indel/x86_64	tcapluscli-centos8-i386
Debian	8.2	amd/x86_64	tcapluscli-debian8-amd64
Windows	10	intel/x86_64	tcapluscli-win10

如果需要在其它平台编译，可联系腾讯云TcaplusDB售后协助处理。

配置依赖

工具依赖于安全密钥的设置，主要考虑线上腾讯云环境的连接使用。对于本地Docker版本，安全密钥可以设置随机值，无需设置真实密钥。

安全密钥设置方法，请参考：访问安全密钥设置。

访问依赖

tcapluscli在访问本地Docker环境时，依赖本地docker暴露的endpoint, 这里统一默认暴露80端口作为api访问资源的入口地址, 带上参数endpoint-url, 并指定access-id集群访问id(业务id, 2:tdr集群, 3:pb集群), 如：

#查看tdr业务集群的表格组信息，access-id=2./tcapluscli tablegroup describe --endpoint-url=http://localhost --access-id=2 --list#查看pb业务集群的表格组信息, access-id=3./tcapluscli tablegroup describe --endpoint-url=http://localhost --access-id=3 --list

授权

由于docker后端服务有设置IP访问白名单机制，所有操作接口在执行前需要先授权IP访问，授权方式:

#指定docker容器endpoint地址，端口默认用80, 指定要授权的业务id(2: tdr, 3: pb), #授权所有IP，允许访问docker本地镜像#tdr授权./tcapluscli privilege --endpoint-url=http://localhost --access-id=2 --allow-all-ip#PB授权./tcapluscli privilege --endpoint-url=http://localhost --access-id=3 --allow-all-ip