すべてのプロダクト
Search
ドキュメントセンター

OpenSearch:主キーベースのクエリ

最終更新日:Dec 28, 2024

URL

/vector-service/fetch

  • サンプル URL には、リクエストヘッダーやエンコード方式などの情報は含まれていません。

  • サンプル URL には、OpenSearch アプリケーションへの接続に使用するエンドポイントも含まれていません。

  • 上記の URL に連結されているすべてのリクエストパラメータの定義、使用方法、およびサンプル値の詳細については、このトピックの「リクエストパラメータ」セクションを参照してください。

プロトコル

HTTP

リクエストメソッド

POST

サポートされている形式

JSON

リクエスト署名

次の方法を使用してリクエスト署名を計算できます。リクエスト署名は authorization ヘッダーに格納されます。

パラメータ

タイプ

説明

accessUserName

string

ユーザー名。インスタンスの詳細ページのAPI エンドポイントタブでユーザー名を確認できます。

accessPassWord

string

パスワード。API エンドポイント タブのインスタンス詳細ページでパスワードを変更できます。

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 プレフィックスを追加する必要があります。

例:

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

リクエストパラメータ

パラメータ

説明

タイプ

必須

tableName

テーブル名。

string

はい

ids

ID。

list[string]

はい

指定された主キーフィールドのデータをクエリする例:

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

レスポンスパラメータ

パラメータ

説明

タイプ

result

返された結果。

list[Doc]

totalCount

結果の数。

int

totalTime

レスポンスタイム。単位: ミリ秒。

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
}