[PB] ListGetRecord2.0
Initial version: 3.50.0
Brief Introduction
Get the record with the specified subscript from the corresponding 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
#TcaplusDB Local docker RESTful Endpoint, ip: 31001, port: 31001 by default
http://9.135.8.93:31001
Http Head
x-tcaplus-target:Tcaplus.ListGetRecord
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 or not | Limitations | Description |
|---|---|---|---|
| x-tcaplus-target | Yes | None | Tcaplus.ListGetRecord |
| x-tcaplus-version | Yes | None | Tcaplus3.50.0 |
| x-tcaplus-app-id | Yes | None | Correspond to the app id number(aka, cluster access id) |
| x-tcaplus-zone-id | Yes | None | Correspond to the zone number (aka, table group id) |
| x-tcaplus-protocol-version | Yes | None | Correspond to the protocol version number, default 2.0 |
| x-tcaplus-table-name | Yes | None | Correspond to the table name |
| x-tcaplus-pwd-md5 | Yes | None | App password (aka, cluster access password), that is, the md5 value after the calculation |
| x-tcaplus-idl-type | Yes | None | protobuf |
| x-tcaplus-result-flag | No | None | 0: No data will be returned after successful operation; 1: After the operation is successful, the data that is consistent with the request will be returned; 2: After the operation is successful, the data after this update operation will be returned; 3: After the operation is successful, the data before the tcapsvr operation will be returned |
| x-tcaplus-data-version-check | No | 1: Detect the record version number. Only when the version number is the same as the server version number, the version number will automatically increase; 2: Do not detect the record version number, but force the client record version number to be written to the server; 3: Do not detect the record version number, and automatically increase the server version number | |
| x-tcaplus-data-version | No | Version number |
Example:
x-tcaplus-target:Tcaplus.ListGetRecord
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
Use json format to represent the record related information. Specify the primary key of the record to return and the subscript of the corresponding record. It can be understood that one primary key corresponds to N records, and the primary keys of N records are the same. Then get the complete record of the corresponding position by specifying the subscript.
- Index: specifies the subscript of the record to return.
- Record: specifies the primary key of the record to return.
{
"Record": {
"openid": 1,
"timekey": "1",
"tconndid": 1
},
"Index": 0
}
Complete Request Example
curl -i -XPOST -H 'x-tcaplus-target: Tcaplus.ListGetRecord' -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 '{
"Record": {
"openid": 1,
"timekey": "1",
"tconndid": 1,
},
"Index": 0
}'
Return Syntax
Return Parameter Description
| Parameter name | Description |
|---|---|
| Parameter name | Description |
| ErrorCode | Return code |
| ErrorMsg | Return message |
| RecordVersion | Version number of the current record |
| Index | Subscript of the current record |
| Record | Successful record in json format |
Return Example
Successful Return Example
{
"ErrorCode": 0,
"ErrorMsg": "Succeed",
"RecordVersion": 27,
"Index": 0,
"Record": {
"openid": 1,
"tconndid": 1,
"timekey": "1",
"gamesvrid": "2",
"logintime": 2,
"lockid": [],
"pay": {
"total_money": 2,
"pay_times": 2
}
}
}
Failed Return Example
{
"ErrorCode": 261,
"ErrorMsg": "Record does not exist"
}
Error code
Refer to Common Error Codes