使用GetVectors按key获取指定向量数据-对象存储-阿里云-对象存储(OSS)-阿里云帮助中心

权限说明

阿里云账号默认拥有全部权限。阿里云账号下的RAM用户或RAM角色默认没有任何权限，需要阿里云账号或账号管理员通过RAM Policy概述或Bucket Policy授予操作权限。

API	Action	说明
GetVectors	`oss:GetVectors`	获取向量数据。

请求语法

POST /?getVectors HTTP/1.1
Host: examplebucket-123***456.cn-hangzhou-internal.oss-vectors.aliyuncs.com
Date: GMT Date
Authorization: SignatureValue
Content-type: application/json

{
   "indexName": "string",
   "keys": [string, string, string],
   "returnData": boolean,
   "returnMetadata": boolean
}

请求头

此接口仅涉及公共请求头。更多信息，请参见公共HTTP头定义。

请求参数

名称	数据类型	是否必选	示例值	描述
indexName	字符串	是	vectorindex1	索引名称。
keys	字符串数组	是	["doc-001", "doc-002"]	要查询的向量的主键，允许出现重复主键。限制： key数量 ∈ [1, 100] key长度 ∈ [1, 1024]
returnData	布尔值	否	false	是否返回向量数据。取值： true false（默认值）
returnMetadata	布尔值	否	false	是否返回元数据。取值： true false（默认值）

响应头

此接口仅涉及公共响应头。更多信息，请参见公共HTTP头定义。

响应元素

名称	数据类型	示例值	说明
vectors	对象数组	-	返回向量列表。如果查询的主键不存在，无报错但不返回当前key结果。
key	字符串	doc-001	向量主键。按主键查询时，若请求中的某个 key 对应的向量不存在，请求不会报错；返回结果仅包含已存在的向量，不包含该 key 的数据。父节点：vectors
data	对象	-	向量数据（仅当returnData为true时返回）。父节点：vectors
metadata	对象	-	元数据（仅当returnMetadata为true时返回）。父节点：vectors

示例

请求示例

POST /?getVectors HTTP/1.1
Host: examplebucket-123***456.cn-hangzhou-internal.oss-vectors.aliyuncs.com
Date: Thu, 17 Apr 2025 01:33:47 GMT
Authorization: OSS4-HMAC-SHA256 Credential=LTAI********************/20250417/cn-hangzhou/oss/aliyun_v4_request,Signature=a7c3554c729d71929e0b84489addee6b2e8d5cb48595adfc51868c299c0c218
Content-type: application/json

{
   "indexName": "vectorindex1",
   "keys": ["doc-001", "doc-002"],
   "returnData": true,
   "returnMetadata": true
}

返回示例

HTTP/1.1 200 OK
x-oss-request-id: 534B371674E88A4D8906****
Date: Thu, 17 Apr 2025 01:33:47 GMT
Connection: keep-alive
Server: AliyunOSS
Content-type: application/json

{
   "vectors": [ 
      { 
         "data": {
            "float32": [0.1, 0.2, 0.3, 0.4, 0.5]
         },
         "key": "doc-001",
         "metadata": {
             "category": ["technology", "ai"],
             "title": "Introduction to Vector Search"
         }
      },
      { 
         "data": {
            "float32": [0.2, 0.3, 0.4, 0.5, 0.6]
         },
         "key": "doc-002",
         "metadata": {
             "category": ["science"],
             "title": "Advanced Vector Operations"
         }
      }
   ]
}

SDK

GetVectors接口所对应的各语言SDK如下：

命令行工具ossutil

GetVectors接口所对应的ossutil命令，请参见get-vectors。

错误码

错误码	HTTP状态码	描述
VectorIndexParameterInvalid	400	请求中提供的向量索引参数不合法。
MalformedJson	400	请求体中的 JSON 格式不符合规范。
AccessDenied	403	返回该错误的可能原因如下：发起请求时没有传入用户验证信息。没有操作权限。
NoSuchVectorIndex	404	指定的向量索引不存在。
QpsLimitExceeded	503	QPS 限流（请求速率受限）。