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

简介

在List PB表中查询对应Key下的所有记录，通过 Limit和Offset限制每次返回的记录条数。

• Limit: 限制返回的记录条数, 如果Limit为-1则返回所有记录数

• Offset: 指定记录偏移量

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.ListGetAllRecords
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.ListGetAllRecords
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格式表示记录相关信息。指定

• Offset: 指定获取记录的偏移量

• Limit: 指定每次返回记录的条数， 为-1表示返回所有记录数

• Record: 指定要获取记录的主键

{
    "Record": {
                "openid": 1,
                "timekey": "1",
                "tconndid": 1
        },
    "Offset": 0,
    "Limit": -1
}

完整请求示例

curl -i -XPOST -H 'x-tcaplus-target: Tcaplus.ListGetAllRecords' -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
        },
    "Offset": 0,
    "Limit": -1
}'

返回语法

返回参数说明

返回示例

成功示例

{"ErrorCode":0,"ErrorMsg":"Succeed","SucceedRecords":[{"RecordVersion":27,"Index":3,"Record":{"openid":1,"tconndid":1,"timekey":"1","gamesvrid":"4","logintime":4,"lockid":[],"pay":{"total_money":4,"pay_times":4}}},{"RecordVersion":27,"Index":4,"Record":{"openid":1,"tconndid":1,"timekey":"1","gamesvrid":"1","logintime":1,"lockid":[],"pay":{"total_money":1,"pay_times":1}}},{"RecordVersion":27,"Index":5,"Record":{"openid":1,"tconndid":1,"timekey":"1","gamesvrid":"2","logintime":2,"lockid":[],"pay":{"total_money":2,"pay_times":2}}},{"RecordVersion":27,"Index":6,"Record":{"openid":1,"tconndid":1,"timekey":"1","gamesvrid":"3","logintime":3,"lockid":[],"pay":{"total_money":3,"pay_times":3}}},{"RecordVersion":27,"Index":7,"Record":{"openid":1,"tconndid":1,"timekey":"1","gamesvrid":"4","logintime":4,"lockid":[],"pay":{"total_money":4,"pay_times":4}}},{"RecordVersion":27,"Index":8,"Record":{"openid":1,"tconndid":1,"timekey":"1","gamesvrid":"1","logintime":1,"lockid":[],"pay":{"total_money":1,"pay_times":1}}},{"RecordVersion":27,"Index":9,"Record":{"openid":1,"tconndid":1,"timekey":"1","gamesvrid":"2","logintime":2,"lockid":[],"pay":{"total_money":2,"pay_times":2}}},{"RecordVersion":27,"Index":10,"Record":{"openid":1,"tconndid":1,"timekey":"1","gamesvrid":"3","logintime":3,"lockid":[],"pay":{"total_money":3,"pay_times":3}}},{"RecordVersion":27,"Index":11,"Record":{"openid":1,"tconndid":1,"timekey":"1","gamesvrid":"4","logintime":4,"lockid":[],"pay":{"total_money":4,"pay_times":4}}},{"RecordVersion":27,"Index":13,"Record":{"openid":1,"tconndid":1,"timekey":"1","gamesvrid":"2","logintime":2,"lockid":[],"pay":{"total_money":2,"pay_times":2}}},{"RecordVersion":27,"Index":14,"Record":{"openid":1,"tconndid":1,"timekey":"1","gamesvrid":"3","logintime":3,"lockid":[],"pay":{"total_money":3,"pay_times":3}}},{"RecordVersion":27,"Index":15,"Record":{"openid":1,"tconndid":1,"timekey":"1","gamesvrid":"4","logintime":4,"lockid":[],"pay":{"total_money":4,"pay_times":4}}},{"RecordVersion":27,"Index":16,"Record":{"openid":1,"tconndid":1,"timekey":"1","gamesvrid":"1","logintime":1,"lockid":[],"pay":{"total_money":1,"pay_times":1}}},{"RecordVersion":27,"Index":17,"Record":{"openid":1,"tconndid":1,"timekey":"1","gamesvrid":"2","logintime":2,"lockid":[],"pay":{"total_money":2,"pay_times":2}}},{"RecordVersion":27,"Index":18,"Record":{"openid":1,"tconndid":1,"timekey":"1","gamesvrid":"3","logintime":3,"lockid":[],"pay":{"total_money":3,"pay_times":3}}},{"RecordVersion":27,"Index":19,"Record":{"openid":1,"tconndid":1,"timekey":"1","gamesvrid":"4","logintime":4,"lockid":[],"pay":{"total_money":4,"pay_times":4}}},{"RecordVersion":27,"Index":20,"Record":{"openid":1,"tconndid":1,"timekey":"1","gamesvrid":"1","logintime":1,"lockid":[],"pay":{"total_money":1,"pay_times":1}}},{"RecordVersion":27,"Index":21,"Record":{"openid":1,"tconndid":1,"timekey":"1","gamesvrid":"3","logintime":3,"lockid":[],"pay":{"total_money":3,"pay_times":3}}},{"RecordVersion":27,"Index":22,"Record":{"openid":1,"tconndid":1,"timekey":"1","gamesvrid":"4","logintime":4,"lockid":[],"pay":{"total_money":4,"pay_times":4}}}],"SucceedNum":19}

失败示例

{
    "ErrorCode": 261,
    "ErrorMsg": "Record does not exist"
}

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