全部產品
Search
文件中心

OpenSearch:向量引擎統計文法

更新時間:May 23, 2025

URL

/vector-service/aggregate

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

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

  • 以上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首碼

樣本:(在header中加入)

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

請求body

參數

類型

是否必須

預設值

說明

tableName

String

-

需要統計的表名

filter

String

""

過濾條件

groupKeys

List[String]

[]

分組統計的欄位列表

aggFuncs

List[AggFuncDesc]

-

統計函數列表

orderBy

List[OrderByDesc]

[]

統計結果排序方式,支援多維排序。

timeout

Integer

10000

逾時時間,單位毫秒

  • AggFuncDesc

    參數

    類型

    是否必須

    預設值

    說明

    name

    String

    ""

    可以指定統計值在結果集中欄位的名稱。預設結果欄位為:FUNC_NAM(args)

    func

    String

    -

    統計函數名:

    • max

    • min

    • avg

    • sum

    • count

    args

    List[String]

    -

    統計函數的參數

  • OrderByDesc

    參數

    類型

    是否必須

    預設值

    說明

    field

    String

    -

    排序欄位名稱,必須指定結果集中的欄位

    direction

    String

    DESC

    排序方向:

    • DESC: 降序排列

    • ASC: 升序排列

返回參數

參數

類型

說明

totalCount

Integer

result結果的數量

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
}