# 分页查询数据实例的统计信息 - ShowStaticsPage #### 功能介绍 本接口用于根据指定的聚合函数与分组条件，对指定数据模型的实例数据进行统计计算，并支持对分组后的统计结果进行分页返回。 在调用本接口前，请确保目标数据模型已满足实例化条件： 1. 已在应用设计态完成数据模型（数据实体或关系实体）的创建与发布。具体操作请参见[创建数据实体](https://support.huaweicloud.com/usermanual-idme/idme_usermanual_0007.html)、[创建关系实体](https://support.huaweicloud.com/usermanual-idme/idme_usermanual_0022.html)和[应用发布](https://support.huaweicloud.com/usermanual-idme/idme_usermanual_0085.html)。 2. 已将对应应用成功部署至运行态。具体操作请参见[部署应用](https://support.huaweicloud.com/consog-idme/idme_consog_0022.html)。 #### 接口约束 请求参数中QueryRequestStaticsVo下的conditions字段已废弃，请使用filter字段来构建查询条件。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/iDMEClassicAPI/doc?api=ShowStaticsPage)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-idme/idme_api_0017.html)。 #### URI POST /rdm_{identifier}_app/publicservices/api/{modelName}/staticsPage/{pageSizePath}/{curPagePath} 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | modelName | 是 | String | **参数解释：** 数据模型的英文名称。 **约束限制：** 不涉及。 **取值范围：** 以大写字母开头，只能包含字母、数字、"_"，且长度为1-60个字符。 **默认取值：** 不涉及。 | | identifier | 是 | String | **参数解释：** 应用的唯一标识。 - 于2023年06月01日之前创建的应用，其唯一标识为该应用的名称。 - 于2023年06月01日之后创建的应用，其唯一标识为该应用的ID。 获取方法请参见[获取运行服务清单 - ListEnvs](https://support.huaweicloud.com/api-idme/ListApps.html)。 **约束限制：** 不涉及。 **取值范围：** - 于2023年06月01日之前创建的应用：由英文字母和数字组成，长度为1-36个字符。 - 于2023年06月01日之后创建的应用：由英文字母和数字组成，且长度为32个字符。 **默认取值：** 不涉及。 | | pageSizePath | 是 | Integer | **参数解释：** 分页大小，即每页返回的实例数量。 **约束限制：** 不涉及。 **取值范围：** 1-1000。 **默认取值：** 不涉及。 | | curPagePath | 是 | Integer | **参数解释：** 当前页数，从1开始计数。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 1。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | curPage | 否 | Integer | **参数解释：** 当前页码，从1开始计数。当路径参数curPagePath未指定时生效。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 1。 | | endIndex | 否 | Integer | **参数解释：** 结束索引，用于指定查询结果的结束位置。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 0。 | | maxPageSize | 否 | Integer | **参数解释：** 最大分页数，用于限制返回的最大页数。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 1000。 | | pageSize | 否 | Integer | **参数解释：** 分页大小，即每页返回的实例数量。当路径参数pageSizePath未指定时生效。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 1000。 | | startIndex | 否 | Integer | **参数解释：** 起始索引，用于指定查询结果的起始位置。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 0。 | | totalPages | 否 | Integer | **参数解释：** 总页数，用于指定查询的总页数。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 0。 | | totalRows | 否 | Integer | **参数解释：** 总行数，用于指定查询的总行数。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 0。 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** IAM用户的token。 获取方法请参见[获取IAM用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | 表4请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | applicationId | 否 | String | **参数解释：** 应用ID，用于指定实例所属的应用。 当URL路径中已能明确应用上下文时，此参数可不传。 获取方法请参见[获取租户下的应用清单 - ListApps](https://support.huaweicloud.com/api-idme/ListApps.html)。 **约束限制：** 不涉及。 **取值范围：** 由英文字母和数字组成，且长度固定为32个字符。 **默认取值：** 不涉及。 | | params | 是 | [QueryRequestStaticsVo] object | **参数解释：** 请求参数对象。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | 表5QueryRequestStaticsVo | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | characterSet | 否 | String | **参数解释：** SQL编码类型，用于指定数据统计查询的字符编码格式。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** UTF8。 | | conditions | 否 | Array of [QueryCondition] objects | **参数解释：** 查询条件组。 此参数已废弃，不建议继续使用，建议使用替代参数filter。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | decrypt | 否 | Boolean | **参数解释：** 是否对查询过程中的敏感数据进行加密。 **约束限制：** 不涉及。 **取值范围：** - true：加密。 - false：不加密。 **默认取值：** false。 | | entityType | 否 | String | **参数解释：** 实体类型，用于区分数据实体与关系实体。 **约束限制：** 不涉及。 **取值范围：** - ENTITY：数据实体。 - RRELATION：关系实体。 **默认取值：** 不涉及。 | | filter | 否 | [QueryCondition] object | **参数解释：** 数据统计过滤条件构建对象，用于限定参与聚合计算的数据范围。支持多层级嵌套查询，适用于复杂工业场景的精确统计。 **约束限制：** filter的属性仅joiner和conditions生效。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | funcs | 是 | Array of [FuncInfo] objects | **参数解释：** 指定聚合函数信息数组，用于定义对数据执行的统计计算方式。支持同时配置多个函数，如同时计算平均值和最大值。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | groupBy | 否 | String | **参数解释：** 分组属性名称，用于指定按哪个数据属性进行分组统计。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | isNeedTotal | 否 | Boolean | **参数解释：** 是否需要查询总记录数。 **约束限制：** 不涉及。 **取值范围：** - true：需要。 - false：不需要。 **默认取值：** false。 | | isPresentAll | 否 | Boolean | **参数解释：** 是否需要展示所有参考对象信息。 **约束限制：** 不涉及。 **取值范围：** - true：需要。 - false：不需要。 **默认取值：** 不涉及。 | | needPresentDetail | 否 | Array of strings | **参数解释：** 需要展示详细信息的参考对象名称列表。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | orderBy | 否 | String | **参数解释：** 按某个字段进行排序。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | orderByTableAlias | 否 | String | **参数解释：** 排序字段的表别名。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | publicData | 否 | String | **参数解释：** 多租查询参数，用于控制公共数据（如标准工艺库、通用物料库）的统计范围。 **约束限制：** 不涉及。 **取值范围：** - EXCLUDE_PUBLIC_DATA：仅统计当前租户私有数据，不包括公共数据。 - INCLUDE_PUBLIC_DATA：同时统计当前租户私有数据与公共数据。 - ONLY_NEED_PUBLIC_DATA：仅统计公共数据。 **默认取值：** 不涉及。 | | sort | 否 | String | **参数解释：** 排序方向。 **约束限制：** 不涉及。 **取值范围：** - ASC：表示升序。 - DESC：表示降序。 **默认取值：** ASC。 | | sorts | 否 | Array of [SortInfoVo] objects | **参数解释：** 排序。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | 表6QueryCondition | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | conditions | 否 | Array of [QueryCondition] objects | **参数解释：** 嵌套查询条件数组，用于构建多层级查询逻辑。其逻辑关系由同级的joiner属性决定。每个子条件可包含基础条件或嵌套条件： - 基础条件结构：由conditionName（属性英文名称）、operator（操作符）、conditionValues（条件值）组成单一查询条件。 - 嵌套条件结构：包含子级joiner和conditions数组，支持多层级逻辑嵌套。 **约束限制：** 当一个对象同时符合基础条件和嵌套条件时，系统将优先考虑嵌套条件，并忽略基础条件。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | conditionName | 否 | String | **参数解释：** 查询条件的名称（对应数据模型中属性的英文名称）。 **约束限制：** 该参数仅在conditions数组中生效。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | operator | 否 | String | **参数解释：** 操作符，用于定义查询条件的匹配规则。 **约束限制：** - 仅在conditions数组中生效。 - "多值"为"是"的属性支持使用contains、=、like、customLike、startWith、endWith、ISNULL。 - "多值"为"否"的属性不支持使用contains。 **取值范围：** - =：等于查询。 - \<：小于查询。 - \>：大于查询。 - \>=：大于等于查询。 - \<=：小于等于查询。 - \<\>：不等于查询。 - startWith：头匹配查询。 - endWith：尾匹配查询。 - like：模糊查询。 - customLike：支持输入\*或%的模糊查询。 - in：包含查询。 - not in：排除查询。 - ISNULL：值为空查询。 - NOTNULL：值不为空查询。 - contains：包含查询。 **默认取值：** 不涉及。 | | conditionValues | 否 | Array of strings | **参数解释：** 查询条件的值列表。 **约束限制：** 仅在conditions数组中生效。 **取值范围：** - 非多值约束属性：operator为in时有多个值，operator为其他操作符时均为单个值。 - 多值约束属性：operator为contains或=时，取值为多个值。operator为其他操作符时均为单个值。 **默认取值：** 不涉及。 | | conditionValue | 否 | String | **参数解释：** 查询条件值（已过时）。 此参数已废弃，不建议继续使用，建议使用替代参数conditionValues。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | ignoreStr | 否 | Boolean | **参数解释：** 是否忽略大小写。 **约束限制：** 仅在conditions数组中生效。 **取值范围：** - true：表示忽略。 - false：表示不忽略。 **默认取值：** false。 | | joinTableAlias | 否 | String | **参数解释：** 关联查询时被关联表的别名。 **约束限制：** 仅在conditions数组中生效。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | joiner | 否 | String | **参数解释：** 连接符，用于连接conditions中的条件对象，定义条件间的逻辑关系。 **约束限制：** 不涉及。 **取值范围：** - and：与连接。 - or：或连接。 **默认取值：** 不涉及。 | | preCondition | 否 | [QueryCondition] object | **参数解释：** 当前condition对象的上一层级条件，用于构建条件层级关系。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | 表7FuncInfo | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | func | 是 | String | **参数解释：** 指定聚合函数名称，用于定义对数据执行的统计计算方式。 **约束限制：** 不涉及。 **取值范围：** - AVG：求平均值。 - COUNT：求总数。 - MAX：求最大值。 - MIN：求最小值。 **默认取值：** 不涉及。 | | funcBy | 是 | String | **参数解释：** 指定聚合函数的操作维度属性名称，即对哪个数据属性进行聚合计算。 例如func为AVG且funcBy为"currentTemperature"时，表示计算平均运行温度。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | 表8SortInfoVo | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | characterSet | 否 | [CharacterSetEnum] object | **参数解释：** SQL编码类型，用于指定数据统计查询的字符编码格式。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | orderBy | 否 | String | **参数解释：** 排序字段，按指定字段对查询结果进行排序。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | sort | 否 | String | **参数解释：** 排序方向。 **约束限制：** 不涉及。 **取值范围：** - ASC：表示升序。 - DESC：表示降序。 **默认取值：** ASC。 | | sortInfo | 否 | String | **参数解释：** 排序信息。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | sortInfoOrderBy | 否 | String | **参数解释：** 排序信息字段。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | 表9CharacterSetEnum | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | cnName | 否 | String | **参数解释：** 中文名称。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | code | 否 | String | **参数解释：** 编码值。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | enName | 否 | String | **参数解释：** 英文名称。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | #### 响应参数 **状态码：200** 表10响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | result | String | **参数解释：** 请求处理结果状态。 **取值范围：** - SUCCESS：请求成功。 - FAIL：请求失败。 | | data | Array of objects | **参数解释：** 请求数据。 **取值范围：** 不涉及。 | | errors | Array of strings | **参数解释：** 异常信息列表。当result为FAIL时，返回具体的错误描述，包含失败原因及建议处理方式。 **取值范围：** 不涉及。 | | pageInfo | [PageInfoViewDTO] object | **参数解释：** 分页信息。 **取值范围：** 不涉及。 | 表11PageInfoViewDTO | 参数 | 参数类型 | 描述 | |:---|:---|:---| | curPage | Integer | **参数解释：** 当前页码，标识当前返回结果所在的页数。 **取值范围：** 不涉及。 | | pageSize | Integer | **参数解释：** 每页大小，标识每页返回的记录数量。 **取值范围：** 不涉及。 | | totalRows | Integer | **参数解释：** 总行数，标识符合查询条件的总记录数。 **取值范围：** 不涉及。 | | totalPages | Integer | **参数解释：** 总页数，标识符合查询条件的总页数。 **取值范围：** 不涉及。 | #### 请求示例 **示例：分组统计实例总数（按ID分组）** 按id分组，统计各分组下uniqueKey不为空的实例数量，每页1000条，返回第1页。 ``` POST https://dme.cn-north-4.huaweicloud.com/rdm_04219627d6794f37ae26e8aba250415d_app/publicservices/api/PersistableModel/staticsPage/1000/1 { "params" : { "groupBy" : "id", "funcs" : [ { "func" : "COUNT", "funcBy" : "uniqueKey" } ], "filter" : { "joiner" : "and", "conditions" : [ { "conditionName" : "rdmExtensionType", "operator" : "=", "conditionValues" : [ "PersistableModel" ] } ] } } } ``` #### 响应示例 **状态码：200** OK，表示请求成功。 ``` { "result" : "SUCCESS", "data" : [ { "count_by_uniquekey" : 1, "id" : 1 }, { "count_by_uniquekey" : 0, "id" : 2 }, { "count_by_uniquekey" : 0, "id" : 3 } ], "errors" : [ ], "pageInfo" : { "curPage" : 1, "pageSize" : 1000, "totalRows" : 0, "totalPages" : 0 } } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK，表示请求成功。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-idme/APIE-XDM-Runtime-ErrorCode.html)。