【TcaplusDB知识库】RESTfulAPI. for Generic表-[PB] InsertRecord介绍

【TcaplusDB知识库】RESTfulAPI2.0 for Generic表-[PB] InsertRecord介绍

简介

在表中插入单笔数据,如果数据已存在则返回错误。

POST http://{Tcaplus_REST_URL}

请求语法

Http请求

#腾讯云控制台 RESTful Endpoint, ip:80, 端口默认80

http://172.17.0.22
#TcaplusDB本地docker版 RESTful Endpoint, ip:31001, 端口默认31001

http://9.135.8.93:31001

Http头

x-tcaplus-target:Tcaplus.InsertRecord
x-tcaplus-app-id:{string}
x-tcaplus-zone-id:{string}
x-tcaplus-protocol-version:{string}
x-tcaplus-table-name:{string}
x-tcaplus-pwd-md5:{string}
x-tcaplus-result-flag:result_flag
x-tcaplus-version:{string}
x-tcaplus-data-version-check:{string}
x-tcaplus-idl-type:protobuf

参数说明:

名称

是否必填

限制条件

说明

x-tcaplus-target

Tcaplus.InsertRecord

x-tcaplu腾讯云s-version

Tcaplus3.50.0

x-tcaplus-app-id

nosql数据库是什么的缩写

对应业务id编号(aka,集群数据库接入id)

x-nosql数据库tcaplus-zone-id

对应tcaplusdbzone编号(aka,表格组id)

x-tcaplus-protocol-version

对应protocol版本号,默认2.0

x-tcaplus-table-name

对应表名

x-tcaplus-pwd-md5

业务密码(aka,集群访问密码),传入计算后的md5值

x-t数据库查询语句caplus-idl-type

数据库设计

protobuf

x-tcaplus-result-flag

0:操作成功后不返回数据1:操作成功后返回和请求一致的数据2:操作成功后返回本次upda腾讯云游戏startte操作后的数据3:操作成腾讯云官网首页功后返回tcapsvr端操作前的数据

x-tcaplus-data-version-check

1:检测记录版本号,只有当该版本号与服务器端的版本号相同时,该版本号才会自增腾讯云2:不检测记录版本号,强制把客户端的记录版本号写入到服务器中nosql期末考试题3:不检测记录版本号,将服务器端的版本号自增

x-tcaplus-data-version

具体的version值

示例:

x-tcaplus-target:Tcaplus.InsertRecord
x-tcaplus-app-id:3
x-tcaplus-zone-id:1
x-tcaplus-protocol-version:2.0
x-tcaplus-table-name:game_players
x-tcaplus-pwd-md5:4e81984efccfb4982333aeb1ff7968d5
x-tcaplus-result-flag:2
x-tcaplus-version:Tcaplus3.50.0
x-tcaplus-data-version-check: 3
x-tcaplus-idl-type:protobuf

Data参数

使用jso数据库n格式表示nosql三大基石记录相关信息,示例如下:

{
"Record": {
"player_id":4,
"player_name":"4",
"player_email":"4",
"game_server_id":4,
"login_timestamp":[],
"logout_timestamp":[],
"is_online":false,
"pay": {
"pay_id": 4,
"amount": 4,
"method": 4
}
}
}

完整请求示例

注意:示例中相关参数nosql数据库请替换成业务方TcaplusDB实际参数。

curl -i -XPOST -H 'x-tcaplus-target: Tcaplus.InsertRecord' -H 'x-tcaplus-app-id: 70' -H 'x-tcaplus-zone-id: 1' -H 'x-tcaplus-protocol-version: 2.0' -H 'x-tcaplus-table-name: game_players' -H 'x-tcaplus-pwd-md5: 0972ad76decf4d11a69e2e0d9af335da' -H 'x-tcaplus-result-flag: 2' -H 'x-tcaplus-version: Tcaplus3.50.0' -H 'x-tcaplus-data-version-check: 3' -H 'x-tcaplus-idl-type: protobuf' http://172.17.32.12 -d '{
"Record": {
"player_id":4,
"player_name":"4",
"player_email":"4",
"game_server_id":4,
"login_timestamp":[],
"logout_timestamp":[],
"is_online":false,
"pay": {
"pay_id": 4,
"amount": 4,
"method": 4
}
}
}'

返回语法

返回参数说明

参数名

nosql与mysql的区别

参数名

说明

ErrorCode

返回码

Erronosql数据库rMsg

返回信息

ReturnValues

用户设置的保留数据,随请求到达 tcaplus 并由应答原样带回数据库原理及应用

SucceedRecords

j数据库技术son格式,成功的记录返回数据,详见文中Data部分

SucceedNum

成功的记录数

FailedRecords

json格式,失败的记录返回数据,详见文中Data部分

FailedNum

失败的记录数

返回示例

成功返回示例

{
"ErrorCode": 0,
"ErrorMsg": "Succeed",
"Record": {
"player_id": 4,
"player_name": "4",
"player_email": "4",
"game_server_id": 4,
"login_timestamp": [],
"logout_timestamp": [],
"is_online": false,
"pay": {
"pay_id": 4,
"amount": 4,
"method": 4
}
}
}

错误返回

{
"ErrorCode": -1293,
"ErrorMsg": "Record exists"
}

​​https://tcaplusdb.tencent.com腾讯云服务器12元一年/UserGuide/05TcaplusDB​​ API/02RestFulAPI2.0接口列表/03[PB]常见错误码.html)


TcaplusDB是腾讯出品的分布式NoSQL数据库,存储和调度的代码完全自研。具备缓存+落地融合nosql数据库是什么的缩写架构、PB级存储、毫秒级腾讯云游戏下载时延、无损水平扩展和复杂数据结构等特性。同时具备丰富的生态、便捷的迁移、极低的运维成本和五个九高可用等特点。客户覆盖游戏、互联网腾讯云服务器12元一年、政务、金融、制造和物联网等领域。