指标视图结果查询

接口描述

本接口用于根据指定的指标视图名称，检索并返回相应的指标视图数据结果集。

接口URL

GET Http://{semantic_host:semantic_port}/semantic/api/v1.1/analysisView/query?viewName=view_test

semantic_host:semantic_port 获取方式请参考：调用方式

请求参数

公共请求参数(HEADERS)

参数	类型	是否必选	最大长度	描述
tenant-id	String	是	32	租户ID，用于指标查询内容所在的租户
auth-type	String	是	32	认证方式，用于设置身份认证方式 UID：使用 UID 进行身份认证TOKEN：使用 TOKEN 进行身份认证
auth-value	String	是	32	UID或者TOKEN值，与auth-type 类型选择一致

公共参数获取方式

tenant-id 与 auth-value：在 Aloudata CAN 顶部导航栏选择指标应用，左边菜单栏选择 API 集成。在 API 集成界面获取取到tenant-id 与auth-value。

请求参数

参数	类型	是否必选	描述
viewName	String	是	指标视图名称
pageIndex	Integer	否	当前页，默认为0
pageSize	Integer	否	数据量，默认为1001
queryResultType	String	否	结果返回类型：DATA:返回结果数据以及元数据信息META:返回元数据信息

响应参数

参数	类型	是否必选	描述
metas	Object	是	元数据信息，具体参数说明参见：4.1metas 参数说明
analysisView	Array	是	结果数组
queryId	String	否	查询id
waring	String	否	waring信息

metas 参数说明

参数	类型	是否必选	描述
name	String	是	字段名称
dataTypeName	String	是	字段类型名称
schemaName	String	是	schema名称
tableName	String	是	table名称

请求示例

http://127.0.0.1/semantic/api/v1.1/analysisView/query?viewName=view_test

响应示例

{
    "data": {
        "queryId": "afc66f6274714b9480952762c648a8af",
        "warning": null,
        "table": {
            "columns": {
                "haha": [
                    {
                        "value": 512881,
                        "flag": null,
                        "count": 1
                    }
                ],
                "metric_time": [
                    {
                        "value": "2024-04-23",
                        "flag": null,
                        "count": 1
                    }
                ]
            }
        },
        "metas": [
            {
                "name": "metric_time",
                "dataType": null,
                "dataTypeName": "DATE",
                "displaySize": null,
                "schemaName": null,
                "scale": null,
                "precision": null,
                "tableName": null
            },
            {
                "name": "haha",
                "dataType": null,
                "dataTypeName": "BIGINT",
                "displaySize": null,
                "schemaName": null,
                "scale": null,
                "precision": null,
                "tableName": null
            }
        ]
    },
    "success": true,
    "code": null,
    "message": null,
    "traceId": "c7a7eb497e5f40d7a16a97b17a52a131.524.17138708081470003"
}