[tcallusdb knowledge base] restful API For generic table - [PB] FieldGetRecord introduction

[tcallusdb knowledge base] restfulapi2 0 for generic table - [PB] FieldGetRecord introduction

brief introduction

The corresponding field selected in the auto increment record only works on numeric type fields. It is often used in scenes such as players' experience value increase and level increase to avoid checking and updating first and reduce network interaction.

POST http://{Tcaplus_REST_URL}

Request syntax

Http request

#Tencent cloud console RESTful Endpoint, ip:80, port: 80 by default
http://172.17.0.22
#Tcallusdb local docker RESTful Endpoint, ip:31001, port default 31001
http://9.135.8.93:31001

Http head

name	Required	Restrictions	explain
x-tcaplus-target	yes	nothing	Tcaplus.FieldIncRecord
x-tcaplus-version	yes	nothing	Tcaplus3.50.0
x-tcaplus-app-id	yes	nothing	Corresponding service id number (aka, cluster access id)
x-tcaplus-zone-id	yes	nothing	Corresponding zone number (aka, table group id)
x-tcaplus-protocol-version	yes	nothing	The corresponding protocol version number is 2.0 by default
x-tcaplus-table-name	yes	nothing	Corresponding table name
x-tcaplus-pwd-md5	yes	nothing	Business password (aka, cluster access password), enter the calculated md5 value
x-tcaplus-idl-type	yes	nothing	protobuf
x-tcaplus-result-flag	no	nothing	0: no data will be returned after successful operation 1: data consistent with the request will be returned after successful operation 2: data after this update operation will be returned after successful operation 3: data before tcapsvr operation will be returned after successful operation
x-tcaplus-data-version-check	no		1: Detect the record version number. The version number will increase automatically only when it is the same as the server version number. 2: do not detect the record version number, and force the record version number of the client to be written to the server. 3: do not detect the record version number, and increase the server version number automatically
x-tcaplus-data-version	no		Specific version value

Example:

x-tcaplus-target:Tcaplus.FieldIncRecord
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

json format is used to represent relevant information. Parameter Description:

FieldPath: must specify the field name of the numeric type to increment
Record: required. The primary key field of the record and the value to be added by the self adding field

Example:

{
    "FieldPath": ["game_server_id"],
    "Record": {
        "player_id":5,
        "player_name":"5",
        "player_email":"5",
        "game_server_id": 1

    }
}

Complete request parameters

curl -i -XPOST -H 'x-tcaplus-target: Tcaplus.FieldIncRecord' -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: 1' -H 'x-tcaplus-idl-type: protobuf' http://172.17.32.17 -d '{
    "FieldPath": ["game_server_id"],
    "Record": {
        "player_id":5,
        "player_name":"5",
        "player_email":"5",
        "game_server_id": 1

    }
}'

Return parameters

Return parameter description

Parameter name	explain
ErrorCode	Return code
ErrorMsg	Return information
RecordVersion	Return record version
Record	json format, return successful records

Return example

Successful return example

{
    "ErrorCode": 0,
    "ErrorMsg": "Succeed",
    "RecordVersion": 6,
    "Record": {
        "game_server_id": 6
    }
}

Failure return example

#Example 1
{
    "ErrorCode": 261,
    "ErrorMsg": "Record does not exist"
}
#Example 2
{
    "ErrorCode": -1811,
    "ErrorMsg": "Missing FieldPath when call FieldOperate Target.\u0000"
}

Tcallusdb is a distributed NoSQL database produced by Tencent. The storage and scheduling code is completely self-developed. It has the characteristics of cache + floor fusion architecture, PB level storage, millisecond delay, lossless horizontal expansion and complex data structure. At the same time, it has the characteristics of rich ecology, convenient migration, extremely low operation and maintenance cost and five nine high availability. Customers cover games, Internet, government affairs, finance, manufacturing, Internet of things and other fields.

Keywords: Database nosql TcaplusDB

Added by frikus on Fri, 11 Feb 2022 17:14:30 +0200

Programming VIP