# 获取数据场景片段列表-GetDataScenarioSegments #### 功能介绍 获取数据场景片段列表 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-octopus/Permission.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | octopus:dataScenario:list | List | workspace \* | - | - | - | #### URI GET /v1.0/{project_id}/data/scenario/segments 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 项目ID，获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-octopus/octopus-10-0020.html)。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | workspace_id | 否 | String | **参数解释**： 工作空间ID **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 0 | | tag_ids | 否 | String | **参数解释**： 标签ID集合，最多300个，例：1,2,3 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | start | 否 | Long | **参数解释**： 过滤条件：起始时间，UTC标准时间毫秒时间戳 **约束限制**： 不涉及 **取值范围**： 1000000000000-2000000000000 **默认取值**： 不涉及 | | end | 否 | Long | **参数解释**： 过滤条件：结束时间，UTC标准时间毫秒时间戳 **约束限制**： 不涉及 **取值范围**： 1000000000000-2000000000000 **默认取值**： 不涉及 | | vehicle_name | 否 | String | **参数解释**： 过滤条件：车辆名称 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | limit | 否 | Integer | **参数解释**： 列表返回的最大记录数 **约束限制**： 最小为1，最大为200 **取值范围**： 不涉及 **默认取值**： 10 | | offset | 否 | Integer | **参数解释**： 查询偏移量，与limit配合使用。假如设置offset为11，limit为10，即从第12条数据开始查询，一次最多读取10条记录。当offset超过总记录数时，列表返回为空 **约束限制**： 最小值0 **取值范围**： 不涉及 **默认取值**： 0 | | package_limit | 否 | Integer | **参数解释**： 片段所属数据包的返回个数上限，用于按数据包分组时的分页 **约束限制**： 不涉及 **取值范围**： 最小值1，最大值200 **默认取值**： 10 | | package_offset | 否 | Integer | **参数解释**： 片段所属数据包的偏移量，用于按数据包分组时的分页 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 0 | | dpk_id | 否 | String | **参数解释**： 过滤条件：数据包ID **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释**： 用户Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | Content-Type | 是 | String | **参数解释**： 内容类型。填application/json **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | payload | [DataScenarioVehicleSegmentsPayload] object | **参数解释**： 实际返回信息 | | meta_info | [RespMetaInfo] object | **参数解释**： 元数据 | 表5DataScenarioVehicleSegmentsPayload | 参数 | 参数类型 | 描述 | |:---|:---|:---| | item | [ScenarioSegments] object | **参数解释**： 场景片段信息 | | page_info | [PageInfo] object | **参数解释**： 分页信息 | 表6ScenarioSegments | 参数 | 参数类型 | 描述 | |:---|:---|:---| | segments | Array of [ScenarioSegment] objects | **参数解释**： 场景片段信息 | | package_offset | Integer | **参数解释**： 片段所属数据包的偏移量 **取值范围**： 不涉及 | | package_limit | Integer | **参数解释**： 片段所属数据包的返回个数上限 **取值范围**： 不涉及 | | package_total | Integer | **参数解释**： 包含的数据包个数总数 **取值范围**： 不涉及 | 表7ScenarioSegment | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**： 场景片段ID **取值范围**： 不涉及 | | tag_ids | Array of integers | **参数解释**： 标签ID列表 | | tag_names | Array of strings | **参数解释**： 标签名称列表 | | vehicle_name | String | **参数解释**： 车辆名称 **取值范围**： 不涉及 | | dpk_id | String | **参数解释**： 数据包ID **取值范围**： 不涉及 | | start | Long | **参数解释**： 起始时间，UTC标准时间毫秒时间戳 **取值范围**： 不涉及 | | end | Long | **参数解释**： 结束时间，UTC标准时间毫秒时间戳 **取值范围**： 不涉及 | | create_at | Long | **参数解释**： 创建时间，UTC标准时间毫秒时间戳 **取值范围**： 不涉及 | | update_at | Long | **参数解释**： 上传更新时间，UTC标准时间毫秒时间戳 **取值范围**： 不涉及 | | source | String | **参数解释**： 场景片段来源 **取值范围**： - AUTO：内置场景挖掘算法生成 - MANUAL：通过场景片段创建接口创建 - VEHICLE：随原始数据包导入时插入的场景片段 - TAKEOVER：人工接管场景 - USER_JOB：自定义算子运行数据处理任务生成的场景片段 | 表8PageInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | offset | Integer | **参数解释**： 查询偏移量 **取值范围**： 不涉及 | | limit | Integer | **参数解释**： 返回个数上限 **取值范围**： 不涉及 | | total | Integer | **参数解释**： 资源总数 **取值范围**： 不涉及 | 表9RespMetaInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | current_time | String | **参数解释**： 请求时间，UTC时间格式，时间为UTC标准时间 **取值范围**： 不涉及 | #### 请求示例 ``` GET https://{endpoint}/v1.0/{project_id}/data/scenario/segments?limit=1 { "meta_info" : { "current_time" : "2022-01-01T08:08:29Z" }, "payload" : { "page_info" : { "offset" : 0, "limit" : 1, "total" : 84 }, "item" : { "segments" : [ { "id" : "eabfea50-24b2-4a37-b0bf-c368d7579a94", "tag_ids" : [ 100000000 ], "tag_names" : [ "接管" ], "dpk_id" : "DPK0000001", "vehicle_name" : "test", "source" : "manual", "start" : 1700453037458, "end" : 1700453047458, "create_at" : 1701324415837, "update_at" : 1701324415837 } ], "package_limit" : 10, "package_offset" : 0, "package_total" : 23 } } } ``` #### 响应示例 无 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 查询成功 | | 400 | 请求参数错误 | | 403 | 权限校验失败 | | 500 | 系统内部错误 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-octopus/ErrorCode.html)。