[tcallusdb knowledge base] restful API For list table - [PB] [PB] ListBatchGetRecord introduction

Posted by asy1mpo on Fri, 11 Feb 2022 03:07:20 +0100

[tcallusdb knowledge base] restfulapi2 0 for list table - [PB] [PB] ListBatchGetRecord introduction

brief introduction

Batch query the records under the specified Key in the List PB table.

  • Index: Specifies the subscript of the record to return.
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

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

Parameter Description:

name

Required

Restrictions

explain

x-tcaplus-target

yes

nothing

Tcaplus.ListBatchGetRecords

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.ListBatchGetRecords
x-tcaplus-app-id:3
x-tcaplus-zone-id:1
x-tcaplus-protocol-version:2.0
x-tcaplus-table-name:tb_online_list
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. Specify the Key to be obtained and the subscripts of corresponding multiple records,

  • Indexes: must be an array, which specifies the subscript of the record to be obtained. Multiple indexes are supported
  • Record: Specifies the primary key of the record to get
{
    "Indexes": [0,1],
    "Record": {
                "openid": 1,
                "timekey": "1",
                "tconndid": 1
    }
}

Full request example

curl -i -XPOST -H 'x-tcaplus-target: Tcaplus.ListBatchGetRecords' -H 'x-tcaplus-app-id: 70' -H 'x-tcaplus-zone-id: 1' -H 'x-tcaplus-protocol-version: 2.0' -H 'x-tcaplus-table-name: tb_online_list' -H 'x-tcaplus-pwd-md5: 0972ad76decf4d11a69e2e0d9af335da' -H 'x-tcaplus-result-flag: 1' -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 '{
    "Indexes": [4,5],
    "Record": {
                "openid": 1,
                "timekey": "1",
                "tconndid": 1
    }
}'

Return syntax

{
"ErrorCode":errCode,
"ErrorMsg":errMsg,
"SucceedRecords":RecordJsonObjs,
"ReturnValues":RetVal´╝î
"SucceedNum": int,
"SucceedRecords": RecordJsonObjs,
"FailedRecords": RecordJsonObjs,
"FailedNum":int
}

Return parameter description

Parameter name

explain

ErrorCode

Return code

ErrorMsg

Return information

RecordVersion

Version number of the current record

SucceedRecords

json format, the returned Data of successful records, see the Data section in the text for details

SucceedNum

Number of successful records

FailedRecords

json format, return Data of failed records, see the Data section in the text for details

FailedNum

Number of failed records

Return example

Successful examples

{
    "ErrorCode": 0,
    "ErrorMsg": "Succeed",
    "SucceedRecords": [{
        "RecordVersion": 28,
        "Index": 4,
        "Record": {
            "openid": 1,
            "tconndid": 1,
            "timekey": "1",
            "gamesvrid": "1",
            "logintime": 1,
            "lockid": [],
            "pay": {
                "total_money": 1,
                "pay_times": 1
            }
        }
    }, {
        "RecordVersion": 28,
        "Index": 5,
        "Record": {
            "openid": 1,
            "tconndid": 1,
            "timekey": "1",
            "gamesvrid": "2",
            "logintime": 2,
            "lockid": [],
            "pay": {
                "total_money": 2,
                "pay_times": 2
            }
        }
    }],
    "SucceedNum": 2
}

Failure example

{
    "ErrorCode": -1299,
    "ErrorMsg": "api_field_not_exist_error",
    "SucceedRecords": [{
        "RecordVersion": 28,
        "Index": 4,
        "Record": {
            "openid": 1,
            "tconndid": 1,
            "timekey": "1",
            "gamesvrid": "1",
            "logintime": 1,
            "lockid": [],
            "pay": {
                "total_money": 1,
                "pay_times": 1
            }
        }
    }],
    "SucceedNum": 1,
    "FailedRecords": [{
        "Index": 0
    }, {
        "Index": 3
    }],
    "FailedNum": 2
}

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.

Topics: Database nosql TcaplusDB