全部產品
Search
文件中心

OpenSearch:主鍵查詢

更新時間:Jul 13, 2024

URL

/vector-service/fetch

  • 以上 URL 省略了請求Header參數及編碼等因素。

  • 以上 URL 中省略了訪問應用的 host 地址。

  • 以上URL 中拼接的所有查詢參數,請查看下方“查詢參數”的參數定義、使用方式及範例。

請求協議

HTTP

請求方式

POST

支援格式

JSON

簽名機制

可用以下方法計算簽名(authorization

參數

類型

描述

accessUserName

string

使用者名稱,可在執行個體詳情頁>網路資訊查看

accessPassWord

string

密碼,可在執行個體詳情頁>網路資訊修改

import com.aliyun.darabonba.encode.Encoder;
import com.aliyun.darabonbastring.Client;

public class GenerateAuthorization {
 public static void main(String[] args) throws Exception {
 String accessUserName = "username";
 String accessPassWord = "password";
 String realmStr = "" + accessUserName + ":" + accessPassWord + "";
 String authorization = Encoder.base64EncodeToString(Client.toBytes(realmStr, "UTF-8"));
 System.out.println(authorization);
 }
}

authorization正確返回格式:

cm9vdDp******mdhbA==

使用HTTP請求設定authorization參數是需加上Basic首碼

樣本:(加在header中)

authorization: Basic cm9vdDp******mdhbA==

請求body文法

參數

描述

類型

是否必須

tableName

表名

string

ids

id列表

list[string]

樣本:(擷取指定主鍵的資料)

{
    "tableName": "gist",
    "ids": [
        "1",
        "2",
        "3"
    ]
}

返回參數

欄位名

描述

類型

result

結果清單

list[Doc]

totalCount

結果數量

int

totalTime

引擎查詢耗時,單位ms

float

errorCode

錯誤碼,有錯誤時才有該欄位

int

errorMsg

錯誤資訊,有錯誤時才有該欄位

string

  • Doc定義

欄位名稱

描述

類型

id

主鍵欄位

建立表時選擇的類型

vector

向量欄位

list[float]

fields

向量的屬性欄位

map<string, FieldType>

樣本

{
    "result": [
        {
            "id": "1",
            "vector": [
                0.1,
                0.2,
                0.3
            ],
            "fields": {
                "a": 11
            }
        }
    ],
    "totalCount": 1,
    "totalTime": 1.2
}