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

OpenSearch:ベクターエンジン統計構文

最終更新日:May 23, 2025

URL

/vector-service/aggregate

  • 上記の URL には、リクエストヘッダーパラメーターやエンコーディングなどの要素は含まれていません。

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

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

プロトコル

HTTP

リクエストメソッド

POST

サポートされているフォーマット

JSON

署名メカニズム

以下の方法で署名(権限付与)を計算できます。前提条件

パラメーター

タイプ

説明

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);
    }
}

認証ヘッダー値の有効な形式:

cm9vdDp******mdhbA==

HTTP リクエストを使用する場合は、認証ヘッダーに Basic プレフィックスを追加する必要があります。

例:

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

リクエスト本文

パラメーター

タイプ

必須

デフォルト値

説明

tableName

String

はい

-

収集対象のテーブルの名前。

filter

String

いいえ

""

フィルター条件。

groupKeys

List[String]

いいえ

[]

グループ統計のフィールド。

aggFuncs

List[AggFuncDesc]

はい

-

統計関数。

orderBy

List[OrderByDesc]

いいえ

[]

統計結果のソート方法。多次元ソートがサポートされています。

timeout

Integer

いいえ

10000

タイムアウト期間(ミリ秒)。

  • AggFuncDesc:

    パラメーター

    タイプ

    必須

    デフォルト値

    説明

    name

    String

    いいえ

    ""

    結果セット内の統計値のフィールド名。デフォルトの結果フィールドは FUNC_NAME(args) です。

    func

    String

    はい

    -

    統計関数名。有効な値:

    • max

    • min

    • avg

    • sum

    • count

    args

    List[String]

    はい

    -

    統計関数の引数。

  • OrderByDesc:

    パラメーター

    タイプ

    必須

    デフォルト値

    説明

    field

    String

    はい

    -

    ソートフィールドの名前。結果セット内のフィールドである必要があります。

    direction

    String

    いいえ

    DESC

    データをソートする順序。有効な値:

    • DESC: 降順

    • ASC: 昇順

レスポンスパラメーター

パラメーター

タイプ

説明

totalCount

Integer

結果セット内の結果の数。

coveredPercent

1.0

正常な結果を返したシャードの割合。

result

List[Map]

返された結果。

totalTime

Float

統計に要した時間(ミリ秒)。

errorCode

Integer

エラーコード。このフィールドは、エラーが発生した場合にのみ返されます。

errorMsg

String

エラーメッセージ。このフィールドは、エラーが発生した場合にのみ返されます。

リクエストの例:

{
    "aggFuncs":
    [
        {
            "args":
            [
                "count"
            ],
            "func": "max"
        }
    ],
    "tableName": "test1"
}

レスポンスの例:

{
    "totalCount": 1,
    "result":
    [
        {
            "MAX(count)": 66
        }
    ],
    "totalTime": 3.286,
    "coveredPercent": 1.0
}