根据时间范围获取模型的历史记录数 - CollectHistoryData
功能介绍
本接口用于根据指定的时间范围,获取数据模型的历史操作统计记录数,包括创建实例、更新实例、删除实例及软删除实例的数量。
在调用本接口前,请确保目标数据模型满足以下条件:
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
POST /rdm_{identifier}_app/publicservices/api/{modelName}/statisticsHistoryData
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| identifier | 是 | String | 参数解释: 应用的唯一标识。 获取方法请参见获取运行服务清单 - ListEnvs。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
| modelName | 是 | String | 参数解释: 数据模型的英文名称。 约束限制: 不涉及。 取值范围: 以大写字母开头,只能包含字母、数字、“_”,且长度为1-60个字符。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: IAM用户的token。 获取方法请参见获取IAM用户Token。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| applicationId | 否 | String | 参数解释: 应用ID,用于指定实例所属的应用。 当URL路径中已能明确应用上下文时,此参数可不传。 获取方法请参见获取租户下的应用清单 - ListApps。 约束限制: 不涉及。 取值范围: 由英文字母和数字组成,且长度固定为1-32个字符。 默认取值: 不涉及。 |
| params | 是 | StatisticsPVO object | 参数解释: 请求参数对象,包含统计时间区间的开始时间和结束时间。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| startTime | 是 | String | 参数解释: 统计区间的开始时间,用于指定统计时间区间的起始点。 约束限制: 不能为空,且必须早于或等于endTime。 取值范围: UTC标准时间格式,格式为yyyy-MM-ddTHH:mm:ss.SSSZ。 默认取值: 不涉及。 |
| endTime | 是 | String | 参数解释: 统计区间的结束时间,用于指定统计时间区间的结束点。 约束限制: 不能为空,且必须晚于或等于startTime。 取值范围: UTC标准时间格式,格式为yyyy-MM-ddTHH:mm:ss.SSSZ。 默认取值: 不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| result | String | 参数解释: 请求处理结果状态。 取值范围: |
| data | Array of StatisticsRVO objects | 参数解释: 请求数据。 取值范围: 不涉及。 |
| errors | Array of strings | 参数解释: 异常信息列表。当result为FAIL时,返回具体的错误描述,包含失败原因及建议处理方式。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| createCount | Integer | 参数解释: 新增实例统计记录数,表示在指定时间区间内创建的实例数量。 取值范围: 不涉及。 |
| updateCount | Integer | 参数解释: 更新实例统计记录数,表示在指定时间区间内更新的实例数量。 取值范围: 不涉及。 |
| deleteCount | Integer | 参数解释: 删除实例统计记录数,表示在指定时间区间内物理删除的实例数量。 取值范围: 不涉及。 |
| logicalDeleteCount | Integer | 参数解释: 软删除实例统计记录数,表示在指定时间区间内软删除的实例数量。 取值范围: 不涉及。 |
请求示例
示例:统计指定时间范围内的历史操作记录数
统计时间范围为2024-03-13T11:25:28.000+0000到2024-03-15T11:25:28.000+0000内的历史操作记录数。
POST https://dme.cn-north-4.huaweicloud.com/rdm_04219627d6794f37ae26e8aba250415d_app/publicservices/api/HistoryDataModel/statisticsHistoryData
{
"applicationId": "04219627d6794f37ae26e8aba250415d",
"params": {
"startTime": 2024-03-13T11:25:28.000+0000,
"endTime": 2024-03-15T11:25:28.000+0000
}
} 响应示例
状态码:200
OK,表示请求成功。
{
"result" : "SUCCESS",
"data" : [ {
"createCount" : 1,
"updateCount" : 0,
"logicalDeleteCount" : 0,
"deleteCount" : 0
} ],
"errors" : [ ]
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | OK,表示请求成功。 |
错误码
请参见错误码。