分页查询模型历史版本信息 - ListHistoryData
功能介绍
本接口用于分页查询指定数据实例的历史版本信息。系统以数据实例的最后修改时间作为查询条件,根据您指定的时间范围返回该实例的历史版本变更记录。
在调用本接口前,请确保目标数据模型满足以下条件:
接口约束
目标数据模型已在应用设计态配置了“系统版本”功能。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
POST /rdm_{identifier}_app/publicservices/api/{modelName}/queryHistoryData/{pageSizePath}/{curPagePath}
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| pageSizePath | 是 | Integer | 参数解释: 分页大小,即每页返回的实例数量。 约束限制: 不涉及。 取值范围: 1-1000。 默认取值: 不涉及。 |
| curPagePath | 是 | Integer | 参数解释: 当前页数,从1开始计数。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 1。 |
| identifier | 是 | String | 参数解释: 应用的唯一标识。 获取方法请参见获取运行服务清单 - ListEnvs。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
| modelName | 是 | String | 参数解释: 数据模型的英文名称。 约束限制: 不涉及。 取值范围: 以大写字母开头,只能包含字母、数字、“_”,且长度为1-60个字符。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| curPage | 否 | Integer | 参数解释: 当前页码,从1开始计数。当路径参数curPagePath未指定时生效。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 1。 |
| endIndex | 否 | Integer | 参数解释: 结束索引,用于指定查询结果的结束位置。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 0。 |
| maxPageSize | 否 | Integer | 参数解释: 最大分页数,用于限制返回的最大页数。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 1000。 |
| pageSize | 否 | Integer | 参数解释: 分页大小,即每页返回的实例数量。当路径参数pageSizePath未指定时生效。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 1000。 |
| startIndex | 否 | Integer | 参数解释: 起始索引,用于指定查询结果的起始位置。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 0。 |
| totalPages | 否 | Integer | 参数解释: 总页数,用于指定查询的总页数。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 0。 |
| totalRows | 否 | Integer | 参数解释: 总行数,用于指定查询的总行数。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 0。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: IAM用户的token。 获取方法请参见获取IAM用户Token。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| applicationId | 否 | String | 参数解释: 应用ID,用于指定实例所属的应用。 当URL路径中已能明确应用上下文时,此参数可不传。 获取方法请参见获取租户下的应用清单 - ListApps。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
| params | 是 | MongoPageRequest object | 参数解释: 请求参数对象,包含查询时间区间及数据实例ID等条件。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| id | 是 | String | 参数解释: 数据实例ID,用于指定待查询历史版本的数据实例。 获取方法请参见分页查询实例 - ShowFindUsingPost。 约束限制: 不涉及。 取值范围: -9223372036854775808到9223372036854775807的整数。 默认取值: 不涉及。 |
| startLastModifiedTime | 否 | String | 参数解释: 开始时间,用于指定查询时间区间的起始点。系统以数据实例的最后修改时间作为查询条件。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| endLastModifiedTime | 否 | String | 参数解释: 结束时间,用于指定查询时间区间的结束点。系统以数据实例的最后修改时间作为查询条件。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| rdmVersion | 否 | Integer | 参数解释: 系统版本号,用于指定查询特定版本的历史记录。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| sourceId | 否 | String | 参数解释: 关系实体源端ID,用于查询关系实体的历史版本信息。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| sourceRdmVersion | 否 | Integer | 参数解释: 关系实体源端系统版本,用于指定源端实例的特定版本。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| targetId | 否 | String | 参数解释: 关系实体目标端ID,用于查询关系实体的历史版本信息。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| targetRdmVersion | 否 | Integer | 参数解释: 关系实体目标端系统版本,用于指定目标端实例的特定版本。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| targetType | 否 | String | 参数解释: 单边不确定关系的目标端类型,用于指定关系实体的目标端模型类型。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| result | String | 参数解释: 请求处理结果状态。 取值范围: |
| data | Array of HistoryDataModelHistoryViewDTO objects | 参数解释: 请求数据,返回数据实例的历史版本信息列表。 取值范围: 不涉及。 |
| errors | Array of strings | 参数解释: 异常信息列表。当result为FAIL时,返回具体的错误描述,包含失败原因及建议处理方式。 取值范围: 不涉及。 |
| pageInfo | PageInfoViewDTO object | 参数解释: 分页信息,包含当前页、每页大小、总行数和总页数。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释: 唯一标识。 取值范围: -9223372036854775808到9223372036854775807的整数。 |
| creator | String | 参数解释: 请求数据。 取值范围: 不涉及。 |
| createTime | String | 参数解释: 创建时间。使用UTC+0时间格式,格式为yyyy-MM-ddTHH:mm:ss.SSSZ。 取值范围: 不涉及。 |
| modifier | String | 参数解释: 更新者账号。 取值范围: 不涉及。 |
| lastUpdateTime | String | 参数解释: 修改时间。使用UTC+0时间格式,格式为yyyy-MM-ddTHH:mm:ss.SSSZ。 取值范围: 不涉及。 |
| rdmVersion | Integer | 参数解释: 系统版本。 取值范围: 不涉及。 |
| rdmOperationType | String | 参数解释: 操作类型。 取值范围: |
| rdmExtensionType | String | 参数解释: 扩展类型。 取值范围: 不涉及。 |
| rdmDeleteFlag | Integer | 参数解释: 删除标志。 取值范围: 不涉及。 |
| tenant | TenantHistoryViewDTO object | 参数解释: 租户信息。 取值范围: 不涉及。 |
| className | String | 参数解释: 类名称。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| className | String | 参数解释: 类名。 取值范围: 不涉及。 |
| code | String | 参数解释: 租户编码。 取值范围: 不涉及。 |
| createTime | String | 参数解释: 创建时间。使用UTC+0时间格式,格式为yyyy-MM-ddTHH:mm:ss.SSSZ。 取值范围: 不涉及。 |
| creator | String | 参数解释: 创建者账号。 取值范围: 不涉及。 |
| dataSource | String | 参数解释: 租户使用的数据源名称。 取值范围: 不涉及。 |
| description | String | 参数解释: 描述信息。 取值范围: 不涉及。 |
| disableFlag | Boolean | 参数解释: 失效标识。 取值范围: |
| id | String | 参数解释: 唯一标识。 取值范围: -9223372036854775808到9223372036854775807的整数。 |
| kiaguid | String | 参数解释: KIA密级。 取值范围: 不涉及。 |
| lastUpdateTime | String | 参数解释: 最后更新时间。使用UTC+0时间格式,格式为yyyy-MM-ddTHH:mm:ss.SSSZ。 取值范围: 不涉及。 |
| modifier | String | 参数解释: 更新者账号。 取值范围: 不涉及。 |
| name | String | 参数解释: 中文名称。 取值范围: 不涉及。 |
| rdmDeleteFlag | Integer | 参数解释: 软删除标识。 取值范围: |
| rdmExtensionType | String | 参数解释: 扩展类型。 取值范围: 不涉及。 |
| rdmOperationType | String | 参数解释: 操作类型。 取值范围: |
| rdmVersion | Integer | 参数解释: 系统版本。 取值范围: 不涉及。 |
| securityLevel | String | 参数解释: 安全密级。 取值范围: |
| tenant | TenantHistoryViewDTO object | 参数解释: 租户信息。 取值范围: 不涉及。 |
请求示例
示例:分页查询指定实例在时间范围内的历史版本
查询实例ID为1,最后修改时间在2024-03-13T11:25:28.000+0000到2024-03-15T11:25:28.000+0000之间的历史版本,每页返回10条,返回第1页。
POST https://dme.cn-north-4.huaweicloud.com/rdm_04219627d6794f37ae26e8aba250415d_app/publicservices/api/HistoryDataModel/queryHistoryData/10/1
{
"applicationId": "04219627d6794f37ae26e8aba250415d",
"params": {
"startLastModifiedTime": 2024-03-13T11:25:28.000+0000,
"endLastModifiedTime": 2024-03-15T11:25:28.000+0000,
"rdmVersion": 1,
"id": "1"
}
} 响应示例
状态码:200
OK,表示请求成功。
{
"result": "SUCCESS",
"data": [
{
"id": "1",
"creator": "test1",
"createTime": 2023-12-04T11:52:48.000+0000,
"modifier": "XDM_Developer xxx",
"lastUpdateTime": 2023-12-04T12:07:59.000+0000,
"rdmVersion": 1,
"rdmOperationType": "CREATE",
"rdmExtensionType": "PersistableModel",
"tenant": {
"id": "-1",
"creator": "xdmAdmin",
"createTime": 2023-12-01T01:25:21.000+0000,
"modifier": "xdmAdmin",
"lastUpdateTime": 2023-12-01T01:25:21.000+0000,
"rdmVersion": 1,
"rdmOperationType": null,
"rdmExtensionType": "Tenant",
"tenant": null,
"className": "Tenant",
"name": "basicTenant",
"description": "默认租户",
"code": "basicTenant",
"disableFlag": false,
"dataSource": "DefaultDataSource"
},
"className": "HistoryDataModel"
}
],
"errors": [],
"pageInfo": {
"curPage": 1,
"pageSize": 10,
"totalRows": 1,
"totalPages": 1
}
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | OK,表示请求成功。 |
错误码
请参见错误码。