标量批量查询
更新时间:2025-04-18
POST
http://{host}/v{version}/row?batchQuery
基于主键值的批量查询操作。
权限说明
鉴权认证机制的详细内容请参见鉴权认证
请求参数
Headers 参数
除公共头域外,无其它特殊头域
URL 参数
version
string
API版本号,当前取1。
必选
host
string
"{实例IP}:{实例Port}"
必选
Query 参数
batchQuery
string
标量批量查询操作
可选
Body 参数
database
string
指定库的名称。
必选
table
string
指定表的名称。
必选
keys
array
目标记录的主键及分区键。主键必填,分区键可选。
必选
显示子属性
隐藏子属性
items
object
显示子属性
隐藏子属性
projections
array
投影字段列表,默认为空,为空时查询结果默认返回所有标量字段。
可选
显示子属性
隐藏子属性
items
string
readConsistency
string
检索请求的一致性级别,取值为:
可选
请求结构
POST /v{version}/row?batchQuery HTTP/1.1
HOST: {Endpoint}
Authorization: {Authorization}
{
"database": "db_test",
"table": "table_test",
"keys": [
{
"primaryKey": {"id": 123},
"partitionKey": {"username": 123}
},
{
"primaryKey": {"id": 456}
}
],
"projections": ["column1", "column2", "vector"],
"readConsistency": "EVENTUAL"
}
示例代码
请求示例
curl --location 'http://vdb.nXWNyPCOSLci.vdb.bj.baidubce.com/v1/row?batchQuery' \
--header 'Authorization: Bearer account=root&api_key=eC4bLRy2va******************************' \
--header 'Content-Type: application/json' \
--data '{
"database": "db_test",
"table": "table_test",
"keys": [
{
"primaryKey": {"id": 123},
"partitionKey": {"username": 123}
},
{
"primaryKey": {"id": 456}
}
],
"projections": ["column1", "column2", "vector"],
"readConsistency": "EVENTUAL"
}'
返回响应
Headers 参数
除公共头域外,无其它特殊头域
返回参数
msg
string
返回信息
可选
code
integer
返回码
可选
rows
array
检索结果记录列表。
可选
显示子属性
隐藏子属性
items
object
显示子属性
隐藏子属性
响应示例
{
"code": 0,
"msg": "Success",
"rows": [
{
"id": 123,
"vector": [
0.23432432,
0.8923744,
0.89238432
],
"other_scalar_column": "other_scalar_column"
},
{
"id": 456,
"vector": [
0.23432432,
0.8923744,
0.89238432
],
"other_scalar_column": "other_scalar_column"
}
]
}