查询指定数据模型的实例统计信息 - ShowStaticsUsingPost
功能介绍
本接口用于根据指定的聚合函数与分组条件,对指定数据模型的实例数据进行统计计算(如计数、求平均值、求最大/最小值等)。
在调用本接口前,请确保目标数据模型已满足实例化条件:
接口约束
请求参数中QueryRequestStaticsVo下的conditions字段已废弃,请使用filter字段来构建查询条件。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
POST /rdm_{identifier}_app/publicservices/api/{modelName}/statics
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| identifier | 是 | String | 参数解释: 应用的唯一标识。 获取方法请参见获取运行服务清单 - ListEnvs。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
| modelName | 是 | String | 参数解释: 数据模型的英文名称。 约束限制: 不涉及。 取值范围: 以大写字母开头,只能包含字母、数字、“_”,且长度为1-60个字符。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: IAM用户的token。 获取方法请参见获取IAM用户Token。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| applicationId | 否 | String | 参数解释: 应用ID,用于指定实例所属的应用。 当URL路径中已能明确应用上下文时,此参数可不传。 获取方法请参见获取租户下的应用清单 - ListApps。 约束限制: 不涉及。 取值范围: 由英文字母和数字组成,且长度固定为32个字符。 默认取值: 不涉及。 |
| params | 是 | QueryRequestStaticsVo object | 参数解释: 请求参数对象。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| characterSet | 否 | String | 参数解释: SQL编码类型,用于指定数据统计查询的字符编码格式。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: UTF8。 |
| conditions | 否 | Array of QueryCondition objects | 参数解释: 查询条件组。 此参数已废弃,不建议继续使用,建议使用替代参数filter。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| decrypt | 否 | Boolean | 参数解释: 是否对查询过程中的敏感数据进行加密。 约束限制: 不涉及。 取值范围: 默认取值: false。 |
| entityType | 否 | String | 参数解释: 实体类型,用于区分数据实体与关系实体。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
| filter | 否 | QueryCondition object | 参数解释: 数据统计过滤条件构建对象,用于限定参与聚合计算的数据范围。支持多层级嵌套查询,适用于复杂工业场景的精确统计。 约束限制: filter的属性仅joiner和conditions生效。 取值范围: 不涉及。 默认取值: 不涉及。 |
| funcs | 是 | Array of FuncInfo objects | 参数解释: 指定聚合函数信息数组,用于定义对数据执行的统计计算方式。支持同时配置多个函数,如同时计算平均值和最大值。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| groupBy | 否 | String | 参数解释: 分组属性名称,用于指定按哪个数据属性进行分组统计。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| isNeedTotal | 否 | Boolean | 参数解释: 是否需要查询总记录数。 约束限制: 不涉及。 取值范围: 默认取值: false。 |
| isPresentAll | 否 | Boolean | 参数解释: 是否需要展示所有参考对象信息。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
| needPresentDetail | 否 | Array of strings | 参数解释: 需要展示详细信息的参考对象名称列表。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| orderBy | 否 | String | 参数解释: 按某个字段进行排序。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| orderByTableAlias | 否 | String | 参数解释: 排序字段的表别名。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| publicData | 否 | String | 参数解释: 多租查询参数,用于控制公共数据(如标准工艺库、通用物料库)的统计范围。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
| sort | 否 | String | 参数解释: 排序方向。 约束限制: 不涉及。 取值范围: 默认取值: ASC。 |
| sorts | 否 | Array of SortInfoVo objects | 参数解释: 排序。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| conditions | 否 | Array of QueryCondition objects | 参数解释: 嵌套查询条件数组,用于构建多层级查询逻辑。其逻辑关系由同级的joiner属性决定。每个子条件可包含基础条件或嵌套条件: 约束限制: 当一个对象同时符合基础条件和嵌套条件时,系统将优先考虑嵌套条件,并忽略基础条件。 取值范围: 不涉及。 默认取值: 不涉及。 |
| conditionName | 否 | String | 参数解释: 查询条件的名称(对应数据模型中属性的英文名称)。 约束限制: 该参数仅在conditions数组中生效。 取值范围: 不涉及。 默认取值: 不涉及。 |
| operator | 否 | String | 参数解释: 操作符,用于定义查询条件的匹配规则。 约束限制: 取值范围: 默认取值: 不涉及。 |
| conditionValues | 否 | Array of strings | 参数解释: 查询条件的值列表。 约束限制: 仅在conditions数组中生效。 取值范围: 默认取值: 不涉及。 |
| conditionValue | 否 | String | 参数解释: 查询条件值(已过时)。 此参数已废弃,不建议继续使用,建议使用替代参数conditionValues。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| ignoreStr | 否 | Boolean | 参数解释: 是否忽略大小写。 约束限制: 仅在conditions数组中生效。 取值范围: 默认取值: false。 |
| joinTableAlias | 否 | String | 参数解释: 关联查询时被关联表的别名。 约束限制: 仅在conditions数组中生效。 取值范围: 不涉及。 默认取值: 不涉及。 |
| joiner | 否 | String | 参数解释: 连接符,用于连接conditions中的条件对象,定义条件间的逻辑关系。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
| preCondition | 否 | QueryCondition object | 参数解释: 当前condition对象的上一层级条件,用于构建条件层级关系。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| func | 是 | String | 参数解释: 指定聚合函数名称,用于定义对数据执行的统计计算方式。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
| funcBy | 是 | String | 参数解释: 指定聚合函数的操作维度属性名称,即对哪个数据属性进行聚合计算。 例如func为AVG且funcBy为“currentTemperature”时,表示计算平均运行温度。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| characterSet | 否 | CharacterSetEnum object | 参数解释: SQL编码类型,用于指定数据统计查询的字符编码格式。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| orderBy | 否 | String | 参数解释: 排序字段,按指定字段对查询结果进行排序。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| sort | 否 | String | 参数解释: 排序方向。 约束限制: 不涉及。 取值范围: 默认取值: ASC。 |
| sortInfo | 否 | String | 参数解释: 排序信息。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| sortInfoOrderBy | 否 | String | 参数解释: 排序信息字段。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| result | String | 参数解释: 请求处理结果状态。 取值范围: |
| data | Array of objects | 参数解释: 请求数据。 取值范围: 不涉及。 |
| errors | Array of strings | 参数解释: 异常信息列表。当result为FAIL时,返回具体的错误描述,包含失败原因及建议处理方式。 取值范围: 不涉及。 |
| pageInfo | PageInfoViewDTO object | 参数解释: 分页信息。 取值范围: 不涉及。 |
请求示例
示例:单值统计(求最大值)
统计PersistableModel模型中满足条件(rdmExtensionType = "PersistableModel")的id字段最大值。
POST https://dme.cn-north-4.huaweicloud.com/rdm_04219627d6794f37ae26e8aba250415d_app/publicservices/api/PersistableModel/statics
{
"applicationId" : "04219627d6794f37ae26e8aba250415d",
"params" : {
"characterSet" : "UTF8",
"isNeedTotal" : true,
"isPresentAll" : true,
"publicData" : "INCLUDE_PUBLIC_DATA",
"decrypt" : false,
"filter" : {
"joiner" : "and",
"ignoreStr" : false,
"conditions" : [ {
"conditionName" : "rdmExtensionType",
"conditionValues" : [ "PersistableModel" ],
"operator" : "=",
"ignoreStr" : false
} ]
},
"sorts" : [ ],
"funcs" : [ {
"func" : "MAX",
"funcBy" : "id"
} ]
}
} 响应示例
状态码:200
OK,表示请求成功。
{
"result" : "SUCCESS",
"data" : [ {
"max_by_id" : 123
} ],
"errors" : [ ]
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | OK,表示请求成功。 |
错误码
请参见错误码。