获取数据片段统计-GetDataEpisodeStatistics

功能介绍

获取数据片段统计

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，需具备如下身份策略权限。

授权项

访问级别

资源类型（*为必须）

条件键

别名

依赖的授权项

octopus:dataReplay:get

Read

workspace *

-

-

-

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
octopus:dataReplay:get	Read	workspace *	-	-	-

URI

GET /v1.0/{project_id}/data/episodes/statistics

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	参数解释：项目ID，获取方法请参见获取项目ID。约束限制：不涉及取值范围：不涉及默认取值：不涉及

表2 Query参数
参数	是否必选	参数类型	描述
workspace_id	否	String	参数解释：工作空间ID 约束限制：不涉及取值范围：不涉及默认取值： 0
start_time	否	Long	参数解释：起始时间，UTC标准时间毫秒时间戳(recent_month不是true的时候必填) 约束限制：不涉及取值范围： 1000000000000-2000000000000 默认取值：不涉及
end_time	否	Long	参数解释：结束时间，UTC标准时间毫秒时间戳(recent_month不是true的时候必填) 约束限制：不涉及取值范围： 1000000000000-2000000000000 默认取值：不涉及
recent_month	否	Boolean	参数解释：是否获取最近一个月数据约束限制：当取值为false时，start_time和end_time必填取值范围： true：返回最近一个月数据 false：自定义时间区间默认取值： false

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	参数解释：用户Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）约束限制：不涉及取值范围：不涉及默认取值：不涉及
Content-Type	否	String	参数解释：内容类型。填application/json 约束限制：不涉及取值范围：不涉及默认取值：不涉及

响应参数

状态码：200

表4 响应Body参数
参数	参数类型	描述
payload	DataStaticsEpisodePayload object	参数解释：实际返回信息
meta_info	RespMetaInfo object	参数解释：元数据

表5 DataStaticsEpisodePayload
参数	参数类型	描述
list	Array of DataEpisodeInfo objects	参数解释：分时间段统计列表

表6 DataEpisodeInfo
参数	参数类型	描述
vehicle	String	参数解释：车辆名称取值范围：不涉及
start_time	Long	参数解释：开始时间，UTC标准时间毫秒时间戳取值范围：不涉及
end_time	Long	参数解释：结束时间，UTC标准时间毫秒时间戳取值范围：不涉及

表7 RespMetaInfo
参数	参数类型	描述
current_time	String	参数解释：请求时间，UTC时间格式，时间为UTC标准时间取值范围：不涉及

请求示例

获取数据片段统计

GET https://{endpoint}/v1.0/{project_id}/data/episodes/statistics?start_time=1640966400000&end_time=1640966500000&recent_month=false

响应示例

状态码：200

查询成功

{
  "meta_info" : {
    "current_time" : "2022-01-01T08:08:29Z"
  },
  "payload" : {
    "list" : [ {
      "vehicle" : "car1",
      "start_time" : 1640966400000,
      "end_time" : 1640966500000
    }, {
      "vehicle" : "car2",
      "start_time" : 1640966400000,
      "end_time" : 1640966500000
    } ]
  }
}