Recupera a configuração de um índice vetorial, incluindo tipo de dados, dimensões e métrica de distância.
Permissões
As contas Alibaba Cloud têm permissões completas por padrão. Usuários e funções RAM exigem autorização explícita por meio de uma política do RAM ou de uma política de bucket.
|
API |
Ação |
Descrição |
|
GetVectorIndex |
|
Recupera informações do índice vetorial. |
Sintaxe da requisição
POST /?getVectorIndex HTTP/1.1
Host: examplebucket-123***456.cn-hangzhou-internal.oss-vectors.aliyuncs.com
Date: GMT Date
Authorization: SignatureValue
{
"indexName": "string"
}Cabeçalhos da requisição
Esta operação usa apenas cabeçalhos de requisição comuns.
Parâmetros da requisição
|
Nome |
Tipo de dado |
Obrigatório |
Exemplo |
Descrição |
|
indexName |
string |
Sim |
vectorindex1 |
Nome do índice. |
Cabeçalhos da resposta
Esta operação usa apenas cabeçalhos de resposta comuns.
Elementos da resposta
|
Nome |
Tipo de dado |
Exemplo |
Descrição |
|
index |
container |
- |
Contêiner das informações do índice vetorial. |
bucketArn | string | acs:ossvector:cn-hangzhou:174****:my-vector-bucket | Nome do recurso (ARN) do bucket vetorial ao qual o índice pertence, no formato acs:ossvector:{region}:{accountId}:{bucketName}. Nó pai: index |
|
indexName |
string |
vectorindex1 |
Nome do índice. Nó pai: index |
|
createTime |
string |
2025-04-17T10:56:21.000Z |
Data e hora de criação do índice em GMT. Nó pai: index |
|
dataType |
string |
float32 |
Tipo de dados do vetor. Nó pai: index |
|
dimension |
Integer |
1024 |
Número de dimensões do vetor. Nó pai: index |
|
distanceMetric |
string |
euclidean |
Função da métrica de distância. Nó pai: index |
|
metadata |
container |
- |
Configuração de metadados. Nó pai: index |
|
nonFilterableMetadataKeys |
string array |
["category", "timestamp"] |
Campos de metadados não filtráveis. Nó pai: metadata |
|
status |
string |
enable |
Status do índice. Valores válidos:
|
Exemplos
Exemplo de requisição
POST /?getVectorIndex 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
{
"indexName": "vectorindex1"
}Exemplo de resposta
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
{
"index": {
"bucketArn": "acs:ossvector:cn-hangzhou:174****:my-vector-bucket",
"createTime": "2025-04-17T10:56:21.000Z",
"indexName": "vectorindex1",
"dataType": "float32",
"dimension": 1024,
"distanceMetric": "euclidean",
"metadata": {
"nonFilterableMetadataKeys": ["category", "timestamp"]
},
"status": "enable"
}
}SDK
SDKs disponíveis para GetVectorIndex:
Interface de linha de comando ossutil
Execute GetVectorIndex na linha de comando com ossutil get-vector-index.
Códigos de erro
|
Código de erro |
Código de status HTTP |
Descrição |
|
VectorIndexParameterInvalid |
400 |
Parâmetro de índice vetorial inválido na requisição. |
|
MalformedJson |
400 |
JSON inválido no corpo da requisição. |
|
AccessDenied |
403 |
Possíveis causas:
|
|
NoSuchVectorIndex |
404 |
O índice vetorial não existe. |