获取数据片段列表-GetDataEpisodeList
功能介绍
获取数据片段列表
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
octopus:dataReplay:get
Read
workspace *
-
-
-
URI
GET /v1.0/{project_id}/data/episodes
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,获取方法请参见获取项目ID。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| workspace_id | 否 | String | 参数解释: 工作空间ID 约束限制: 不涉及 取值范围: 不涉及 默认取值: 0 |
| start_time | 是 | Long | 参数解释: 起始时间,UTC标准时间毫秒时间戳 约束限制: 不涉及 取值范围: 1000000000000-2000000000000 默认取值: 不涉及 |
| end_time | 是 | Long | 参数解释: 结束时间,UTC标准时间毫秒时间戳 约束限制: 不涉及 取值范围: 1000000000000-2000000000000 默认取值: 不涉及 |
| dpk_id | 否 | String | 参数解释: 数据包ID,支持通配模糊查询 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| vehicle_name | 否 | String | 参数解释: 车辆名称,只支持精确匹配查询 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| limit | 否 | Integer | 参数解释: 列表返回的最大记录数 约束限制: 最小为1,最大为200 取值范围: 不涉及 默认取值: 10 |
| offset | 否 | Integer | 参数解释: 查询偏移量,与limit配合使用。假如设置offset为11,limit为10,即从第12条数据开始查询,一次最多读取10条记录。当offset超过总记录数时,列表返回为空 约束限制: 最小值0 取值范围: 不涉及 默认取值: 0 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| Content-Type | 否 | String | 参数解释: 内容类型。填application/json 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| payload | DataEpisodesPayload object | 参数解释: 实际返回信息 |
| meta_info | RespMetaInfo object | 参数解释: 元数据 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| list | Array of DataEpisodeMeta objects | 参数解释: 片段列表 |
| page_info | PageInfo object | 参数解释: 分页信息 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| episode_id | String | 参数解释: 片段ID 取值范围: 不涉及 |
| dpk_id | String | 参数解释: 数据包ID 取值范围: 不涉及 |
| vehicle_name | String | 参数解释: 车辆名称 取值范围: 不涉及 |
| start_time | Long | 参数解释: 开始时间,UTC标准时间毫秒时间戳 取值范围: 不涉及 |
| end_time | Long | 参数解释: 结束时间,UTC标准时间毫秒时间戳 取值范围: 不涉及 |
| can_replay | Boolean | 参数解释: 是否可以回放 取值范围: 不涉及 |
| main_topics | DataMainTopics object | 参数解释: 主要的topic信息 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| gnss | DataTopicInfo object | 参数解释: gnss信息 |
| camera | DataTopicInfo object | 参数解释: camera信息 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| topic | String | 参数解释: topic 取值范围: 不涉及 |
| type | String | 参数解释: 类型 取值范围: 不涉及 |
| path | String | 参数解释: 路径 取值范围: 不涉及 |
请求示例
获取数据片段列表
GET https://{endpoint}/v1.0/{project_id}/data/episodes?start_time=1000000000000&end_time=1640966400000&dpk_id=DPK0000001 响应示例
状态码:200
查询成功
{
"meta_info" : {
"current_time" : "2022-01-01T08:08:29Z"
},
"payload" : {
"list" : [ {
"episode_id" : "DPK0000001",
"dpk_id" : "DPK0000001",
"vehicle_name" : "myCar",
"start_time" : 1640966400000,
"end_time" : 1640966500000,
"main_topics" : {
"gnss" : {
"topic" : "gnss",
"type" : "GNSS",
"path" : "DPK0000001/path/gnss/gnss.pb"
},
"camera" : {
"topic" : "camera_0",
"type" : "CAMERA",
"path" : "DPK0000001/path/camera_0/"
}
},
"can_replay" : true
} ],
"page_info" : {
"offset" : 0,
"limit" : 10,
"total" : 1
}
}
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 查询成功 |
| 400 | 请求参数错误 |
| 403 | 权限校验失败 |
| 500 | 系统内部错误 |
错误码
请参见错误码。