You need to enable JavaScript to run this app.
文档中心
对象存储

对象存储

复制全文
下载 pdf
向量索引
GetIndex
复制全文
下载 pdf
GetIndex
功能描述​
获取向量桶的向量索引信息。​
请求消息样式​
Endpoint 需使用 Bucket Endpoint。​
​
POST /GetIndex HTTP/1.1​
Host: {VectorBucketName}-{AccountID}.tosvectors-cn-beijing.volces.com​
Authorization: authorization string​
Date: Mon, 10 Dec 2025 12:49:14 GMT​
​
{​
"vectorBucketName": "test-vector-bucket",​
"indexName": "test-index"​
}​
​
请求参数和消息头​
无。​
请求元素​
​
名称​
参数类型​
是否必选​
示例值​
说明​
vectorBucketName​
string​
是​
test-vector-bucket​
要获取的向量索引所属向量桶的名称。​
indexName​
string​
是​
test-index​
要获取的向量索引的名称。​
​
响应消息头​
返回公共的响应头,请参见公共参数。​
响应元素​
如果操作成功,服务将返回一个 HTTP 200 响应以及如下响应元素。​
如果操作失败,返回响应码中定义的错误码。​
​
名称​
参数类型​
示例值​
说明​
index​
Index​
参见 Index 定义​
索引创建的时间戳。​
​
Index 结构体参数说明:​
​
名称​
参数类型​
示例值​
说明​
vectorBucketName​
string​
test-vector-bucket​
向量桶的名称。​
indexName​
string​
test-index​
向量索引的名称。​
creationTime​
number​
1764319996​
索引创建的时间戳。​
dataType​
string​
float32​
向量的数据类型。​
dimension​
number​
5​
向量的维度。​
distanceMetric​
string​
euclidean​
用于相似性搜索的距离度量。​
indexTrn​
string​
trn:tosvectors:cn-beijing:11111:bucket/test-vector-bucket/index/test-index​
向量索引的 TRN。​
metadataConfiguration​
MetadataConfiguration​
{​
"nonFilterableMetadataKeys": [​
"key_c",​
"key_d"​
]​
}​
元数据配置。​
​
MetadataConfiguration 结构体参数说明:​
​
名称​
参数类型​
示例值​
说明​
nonFilterableMetadataKeys​
string[]​
["key_c", "key_d"]​
不可用于筛选的元数据键列表。​
​
请求示例​
​
POST /GetIndex HTTP/1.1​
Host: test-vector-bucket-1111.tosvectors-cn-beijing.volces.com​
Authorization: authorization string​
Date: Wed, 10 Dec 2025 12:49:14 GMT​
​
{​
"vectorBucketName": "test-vector-bucket",​
"indexName": "test-index"​
}​
​
响应示例​
​
HTTP/1.1 200 OK​
x-tos-id-2: 797014003c90a9b6940****-b15a995-1vV80n-CVB-cb-tos-1az-front-azd-vectors-2​
x-tos-request-id: 797014003c90a9b6940****-b15a995-1vV80n-CVB-cb-tos-1az-front-azd-vectors-2​
Date: Wed, 10 Dec 2025 12:49:14 GMT​
Server: TosServer​
Content-Length: 331​
​
{​
"index": {​
"creationTime": 1764319996,​
"dataType": "float32",​
"dimension": 5,​
"distanceMetric": "euclidean",​
"indexName": "test-index",​
"indexTrn": "trn:tosvectors:cn-beijing:1111:bucket/test-vector-bucket/index/test-index",​
"vectorBucketName": "test-vector-bucket",​
"metadataConfiguration": {​
"nonFilterableMetadataKeys": [​
"key_c",​
"key_d"​
]​
}​
}​
}​
​
​
最近更新时间:2026.09.18 14:23:38
这个页面对您有帮助吗?
有用
有用
无用
无用