TcaplusDB PB表 RESTFul API 开始使用
目前TcaplusDB只为PB表提供了RESTFul API。
RESTFul API主要提供基于HTTP协议的PB表读写接口，RESTFul API具有易使用，易测试，不依赖专有SDK等优点。基于RESTFul形式的API对于许多用户来说都比较熟悉，无需理解过多底层协议机制（如PB协议），用户可以根据自己所熟悉的语言对RESTFul API进行二次包装，以满足自身需要。
使用RESTFul API的前期准备工作主要包括：
- 准备环境；
- 创建业务；
- 创建游戏区；
- 创建表格；
- 收集环境信息。
以上准备工作已经完成，可以直接跳过。
1. 准备环境
参考创建集群文档，部署TcaplusDB集群，或者申请TcaplusDB服务。
2. 创建业务
参考创建业务文档，创建业务（App）。
3. 创建游戏区
参考创建游戏区文档，创建游戏区（Zone）。
4. 创建表格
参考创建表格文档，创建PB数据表。
PB表分为Generic表和List表两种。
4.1. Generic表定义说明
<待补充>
4.2. List表定义说明
<待补充>
5. 收集环境信息
使用RESTFul API时，需要用到一些环境相关参数，具体参数和收集方法见下表。
| 参数 | 值 | 获取方法 |
|---|---|---|
| 目录服务器地址列表 | 国内idc&dev&其他自建环境：联系dba分配restproxy进程后由dba提供相应Tcaplus_REST_URL。 腾讯云环境：腾讯云控制台 RESTful Endpoint, ip:80, 端口默认80。 TcaplusDB本地docker版： RESTful Endpoint, ip:31001, 端口默认31001 | |
| 业务ID | 获取业务ID | |
| 业务访问密码 | 获取业务访问密码 | |
| 游戏区ID | 获取游戏区ID | |
| 数据表名 | test |
6. 使用RESTFul API
参见RESTFul API各接口的使用说明
7. 常见问题
使用RESTFul API的过程中，有疑问或者遇到报错，可参考“常见问题”和“错误码含义和处理方法”进行处理。
- 常见问题文档；
- 错误码含义和处理方法文档。