文档首页> 键值存储服务 KVS> API参考> API> KV接口> 删除单个kv
更新时间：2024-06-20 GMT+08:00
查看PDF
分享

删除单个kv

功能介绍

指定表，指定主键，删除该文档；允许指定条件执行。

URI

POST /v1/delete-kv

表1 Query参数

参数

是否必选

参数类型

描述

store_name

否

String

仓名，全域唯一，不同租户的仓名不能相同。

  • 格式：${prefix}-${region-code}-${account-id}，其中prefix为自定义前缀，region-code为kvs集群所在的区域代码，account-id为用户的账户id

  • 取值字符限制：[a-z0-9-]+

  • 长度：[16,52]

说明：

"-"不能出现在名字头部或尾部

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

table_name

是

String

表名，仓内唯一。

  • 长度：[3, 63]

  • 取值字符限制：[a-z0-9_-]+

primary_key

是

Document

用户自定义的主键名及值。

说明：

内容字段为主键字段名和值，组合索引多个元素。

condition_expression

否

condition_expression object

条件表达式，参见conditional小节。

说明：

禁止携带主键字段, 参见conditional小节的定义。
表3 condition_expression

参数

是否必选

参数类型

描述

single_field_expression

否

single_field_expression object

单字段条件。
表4 single_field_expression

参数

是否必选

参数类型

描述

field

是

String

条件字段。

func

是

String

条件函数，取值如"$gt", $lt","$gte", $lte" "$eq", "$ne", "$prefix", "$exists"。

value

否

Document

value和value_array二选一。

  • value条件值，适用于除"$in", "$nin"外的func。

  • 字段名无意义，可以传空，也可以传字段名。

  • $exists值为true/false。

说明：

$prefix操作只适用于string和binary类型。

value_array

否

Array of strings

"value"和"value_array"二选一。

  • "value_array" 条件值列表, 值用于"$in", "$nin"。

响应参数

状态码： 200

表5 响应Body参数

参数

参数类型

描述

kv_doc

Document

对kv_doc有效。

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

请求返回的错误码。

error_msg

String

请求返回的错误信息。

请求示例

删除单个kv，删除kv的分区键为user，排序键为test-file-1

POST https://{endpoint}/v1/delete-kv

{
  "table_name" : "test_table_1",
  "primary_key" : {
    "owner" : "user_1",
    "filename" : "test_file_1"
  }
}

响应示例

无

状态码

状态码

描述

200

表示删除单个kv请求成功

400

BadRequest

错误码

请参见错误码。

父主题： KV接口
分享：

    相关文档

    相关产品