向量引擎统计语法

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
}