【TcaplusDB知識庫】RESTfulAPI. for List表-[PB] ListDeleteAllRecords.介紹
阿新 • • 發佈:2022-02-16
簡介
在List PB表中刪除對應Key下的所有記錄。
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.ListDeleteAllRecords
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.ListDeleteAllRecords |
x-tcaplus-version | 是 | 無 | Tcaplus3.50.0 |
x-tcaplus-app-id | 是 | 無 | 對應業務id編號(aka,叢集接入id) |
x-tcaplus-zone-id | 是 | 無 | 對應zone編號(aka,表格組id) |
x-tcaplus-protocol-version | 是 | 無 | 對應protocol版本號,預設2.0 |
x-tcaplus-table-name | 是 | 無 | 對應表名 |
x-tcaplus-pwd-md5 |
是 | 無 | 業務密碼(aka,叢集訪問密碼),傳入計算後的md5值 |
x-tcaplus-idl-type | 是 | 無 | protobuf |
x-tcaplus-result-flag | 否 | 無 | 0:操作成功後不返回資料1:操作成功後返回和請求一致的資料2:操作成功後返回本次update操作後的資料3:操作成功後返回tcapsvr端操作前的資料 |
x-tcaplus-data-version-check | 否 | 1:檢測記錄版本號,只有當該版本號與伺服器端的版本號相同時,該版本號才會自增2:不檢測記錄版本號,強制把客戶端的記錄版本號寫入到伺服器中3:不檢測記錄版本號,將伺服器端的版本號自增 | |
x-tcaplus-data-version |
否 | 具體的version值 |
示例:
x-tcaplus-target:Tcaplus.ListDeleteAllRecords
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格式表示記錄相關資訊。指定
-
Record: 指定要刪除記錄的主鍵
{
"Record": {
"openid": 1,
"timekey": "1",
"tconndid": 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
}
}'
返回語法
返回引數說明
引數名 | 說明 |
---|---|
ErrorCode | 返回碼 |
ErrorMsg | 返回資訊 |
RecordVersion | 當前記錄的版本號 |
TotalNum | 刪除的記錄條數 |
返回示例
成功示例
{
"ErrorCode": 0,
"ErrorMsg": "Succeed",
"RecordVersion": -1,
"TotalNum": 16
}
失敗示例
{
"ErrorCode": 261,
"ErrorMsg": "Record does not exist"
}