华为云用户手册

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 payload RepoListPayload object 实际返回信息 meta_info MetaInfo object 元数据 表5 RepoListPayload 参数 参数类型 描述 list Array of ImageRepo objects 镜像仓库列表 page_info PageInfo object 分页信息 表6 ImageRepo 参数 参数类型 描述 id Long id name String 名称 description String 描述。若镜像没有描述则不返回该字段 create_at Long 创建时间，UTC标准时间毫秒时间戳 update_at Long 最近更新时间，UTC标准时间毫秒时间戳 project_id String 项目id user_id String 创建者id scope String 用途 visibility String 使用范围 version_num Integer 版本数 workspace_id String 工作空间id 表7 PageInfo 参数 参数类型 描述 total Integer 资源总数 offset Integer 查询偏移量 limit Integer 返回个数上限 表8 MetaInfo 参数 参数类型 描述 current_time String 请求时间，UTC时间格式，时间为UTC标准时间

响应参数 状态码：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标准时间

URI GET /v1.0/{project_id}/data/episodes/statistics 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id，获取方法请参见获取项目ID 表2 Query参数 参数 是否必选 参数类型 描述 workspace_id 否 String 工作空间id start_time 否 Long 起始时间，UTC标准时间毫秒时间戳(recent_month不是true的时候必填) end_time 否 Long 结束时间，UTC标准时间毫秒时间戳(recent_month不是true的时候必填) recent_month 否 Boolean 是否最近一个月

响应示例 状态码：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 } ] } }

响应示例 状态码：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 } } }

URI GET /v1.0/{project_id}/data/episodes 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id，获取方法请参见获取项目ID 表2 Query参数 参数 是否必选 参数类型 描述 workspace_id 否 String 工作空间id start_time 是 Long 起始时间，UTC标准时间毫秒时间戳 end_time 是 Long 结束时间，UTC标准时间毫秒时间戳 dpk_id 否 String 数据包ID，支持通配模糊查询 vehicle_name 否 String 车辆名称，只支持精确匹配查询 limit 否 Integer 返回个数上限 offset 否 Integer 查询偏移量

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 payload DataEpisodesPayload object 实际返回信息 meta_info RespMetaInfo object 元数据 表5 DataEpisodesPayload 参数 参数类型 描述 list Array of DataEpisodeMeta objects 片段列表 page_info PageInfo object 分页信息 表6 DataEpisodeMeta 参数 参数类型 描述 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信息 表7 DataMainTopics 参数 参数类型 描述 gnss DataTopicInfo object gnss信息 camera DataTopicInfo object camera信息 表8 DataTopicInfo 参数 参数类型 描述 topic String topic type String 类型 path String 路径 表9 PageInfo 参数 参数类型 描述 offset Integer 查询偏移量 limit Integer 返回个数上限 total Integer 资源总数 表10 RespMetaInfo 参数 参数类型 描述 current_time String 请求时间，UTC时间格式，时间为UTC标准时间

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 payload DataEpisodeDetailPayload object 实际返回信息 meta_info RespMetaInfo object 元数据 表4 DataEpisodeDetailPayload 参数 参数类型 描述 item DataEpisodeDetail object 详细信息 表5 DataEpisodeDetail 参数 参数类型 描述 episode_id String 片段ID dpk_id String 数据包ID vehicle_name String 车辆名称 map_id String 地图ID(数据包绑定地图后会返回此字段) start_time Long 开始时间，UTC标准时间毫秒时间戳 end_time Long 结束时间，UTC标准时间毫秒时间戳 topics Array of DataTopicInfo objects topic列表 videos Array of DataVideoInfo objects video列表 表6 DataTopicInfo 参数 参数类型 描述 topic String topic type String 类型 path String 路径 表7 DataVideoInfo 参数 参数类型 描述 name String 名称 format String 格式 表8 RespMetaInfo 参数 参数类型 描述 current_time String 请求时间，UTC时间格式，时间为UTC标准时间

响应示例 状态码：200 查询成功 { "meta_info" : { "current_time" : "2022-01-01T08:08:29Z" }, "payload" : { "item" : { "episode_id" : "DPK0000001", "dpk_id" : "DPK0000001", "vehicle_name" : "myCar", "map_id" : "MAP0000001", "start_time" : 1640966400000, "end_time" : 1640966500000, "topics" : [ { "topic" : "camera_0", "type" : "CAMERA", "path" : "DPK0000001/path/camera_0/" }, { "topic" : "camera_2", "type" : "CAMERA", "path" : "DPK0000001/path/camera_1/" } ], "videos" : [ { "name" : "frag", "format" : "mp4" }, { "name" : "road", "format" : "mp4" } ] } } }

请求示例 创建通用存储类型的数据集版本 POST https://{endpoint}/v1.0/{project_id}/common/datasets/61a22ebc-49b3-40b5-b16f-ab9aebd2b231/versions { "agreement_confirm" : true, "description" : "数据集版本", "command" : "command", "custom_image" : "10293:1", "warehouse_params" : { "raw_data_ids" : [ "DPK0003878" ], "and_tags" : [ 956 ], "and_custom_attributes" : [ "61153deb-88ad-4f66-8bad-e3877bed309e" ], "file_types" : [ "TEXT" ], "start_time" : 1701360000000, "end_time" : 1701532799999 } } 创建标注类型的数据集版本 POST https://{endpoint}/v1.0/{project_id}/common/datasets/61a22ebc-49b3-40b5-b16f-ab9aebd2b231/versions { "agreement_confirm" : true, "description" : "数据集版本", "command" : "command", "custom_image" : "10293:1", "status" : "labeled", "batch_task_id" : "e3d7ede3817541d29467388ac14b0eee", "label_meta_names" : [ "Person_sitting" ], "only_valid" : true, "hard_mining" : true } 创建本地类型的数据集版本 POST https://{endpoint}/v1.0/{project_id}/common/datasets/61a22ebc-49b3-40b5-b16f-ab9aebd2b231/versions { "agreement_confirm" : true, "description" : "数据集版本", "command" : "command", "custom_image" : "10293:1" } 创建OBS类型的数据集版本 POST https://{endpoint}/v1.0/{project_id}/common/datasets/61a22ebc-49b3-40b5-b16f-ab9aebd2b231/versions { "agreement_confirm" : true, "description" : "数据集版本", "command" : "command", "custom_image" : "10293:1", "access_key" : "CIMTUKMSFSUPGKZL9OKH", "secret_key" : "iahcmjPI3YpmVRVTlbEAppE6eMSd84Pvmkhp0L1d", "bucket_name" : "octopus-raw-64d37c8f25af4277a1ff4ee9772687bf", "bucket_path" : "test/test" } 创建子集版本 POST https://{endpoint}/v1.0/{project_id}/common/datasets/61a22ebc-49b3-40b5-b16f-ab9aebd2b231/versions { "agreement_confirm" : true, "description" : "数据集版本", "command" : "command", "custom_image" : "10293:1" }

响应参数 状态码：200 表5 响应Body参数 参数 参数类型 描述 payload CreateDatasetVersionInfoPayload object 实际返回信息 meta_info MetaInfo object 元数据 表6 CreateDatasetVersionInfoPayload 参数 参数类型 描述 item LabelDatasetVersion object 版本信息 表7 LabelDatasetVersion 参数 参数类型 描述 id String id label_dataset_id String 数据集id name String 名称 batch_task_id String 批次任务id label_meta_names Array of strings 标注物名 only_valid Boolean 可用，true为可用，false为不可用 hard_mining Boolean 难例，true为难例，false为非难例 label_format String 标注格式 status String 状态 frame_num String 帧文件数量 frame_size String 帧文件大小，包含单位 label_count String 标志物数量 tags Array of strings 标签 custom_attributes Array of strings 自定义属性，格式形式"key:value" custom_image String 自定义镜像 command String 脚本路徑 description String 描述 project_id String 项目id workspace_id String 工作空间id create_at String 创建时间，UTC标准时间毫秒时间戳 update_at String 修改时间，UTC标准时间毫秒时间戳 upload_id String 上传id agreement_confirm Boolean 隐私声明同意 source_version_id String 子集的源数据集版本ID 表8 MetaInfo 参数 参数类型 描述 current_time String 请求时间，UTC时间格式，时间为UTC标准时间

响应示例 状态码：200 创建成功 创建通用存储类型的数据集版本 { "meta_info" : { "current_time" : "2024-01-02T02:04:22Z" }, "payload" : { "item" : { "id" : "102575d5-cf89-4aca-b856-0d39ae2a69c5", "label_dataset_id" : "61a22ebc-49b3-40b5-b16f-ab9aebd2b231", "name" : "V1", "label_format" : "OCTOPUS", "status" : "INITIALIZING", "frame_num" : 0, "frame_size" : 0, "label_count" : 0, "custom_image" : "10293:1", "command" : "command", "description" : "数据集版本", "project_id" : "64d37c8f25af4277a1ff4ee9772687bf", "workspace_id" : 0, "create_at" : 1701403732492, "update_at" : 1701403732492, "agreement_confirm" : true } } } 创建标注类型的数据集版本 { "meta_info" : { "current_time" : "2024-01-02T02:04:22Z" }, "payload" : { "item" : { "id" : "102575d5-cf89-4aca-b856-0d39ae2a69c5", "label_dataset_id" : "61a22ebc-49b3-40b5-b16f-ab9aebd2b231", "name" : "V1", "label_format" : "OCTOPUS", "status" : "INITIALIZING", "frame_num" : 0, "frame_size" : 0, "label_count" : 0, "custom_image" : "10293:1", "command" : "command", "description" : "数据集版本", "project_id" : "64d37c8f25af4277a1ff4ee9772687bf", "workspace_id" : 0, "create_at" : 1701403732492, "update_at" : 1701403732492, "search_status" : "labeled", "hard_mining" : true, "only_valid" : true, "label_meta_names" : [ "Person_sitting" ], "batch_task_id" : "e3d7ede3817541d29467388ac14b0eee", "agreement_confirm" : true } } } 创建本地类型的数据集版本 { "meta_info" : { "current_time" : "2024-01-02T02:04:22Z" }, "payload" : { "item" : { "id" : "102575d5-cf89-4aca-b856-0d39ae2a69c5", "label_dataset_id" : "61a22ebc-49b3-40b5-b16f-ab9aebd2b231", "name" : "V1", "label_format" : "OCTOPUS", "status" : "INITIALIZING", "frame_num" : 0, "frame_size" : 0, "label_count" : 0, "custom_image" : "10293:1", "command" : "command", "description" : "数据集版本", "project_id" : "64d37c8f25af4277a1ff4ee9772687bf", "workspace_id" : 0, "create_at" : 1701403732492, "update_at" : 1701403732492, "agreement_confirm" : true } } } 创建OBS类型的数据集版本 { "meta_info" : { "current_time" : "2024-01-02T02:04:22Z" }, "payload" : { "item" : { "id" : "102575d5-cf89-4aca-b856-0d39ae2a69c5", "label_dataset_id" : "61a22ebc-49b3-40b5-b16f-ab9aebd2b231", "name" : "V1", "label_format" : "OCTOPUS", "status" : "INITIALIZING", "frame_num" : 0, "frame_size" : 0, "label_count" : 0, "custom_image" : "10293:1", "command" : "command", "description" : "数据集版本", "project_id" : "64d37c8f25af4277a1ff4ee9772687bf", "workspace_id" : 0, "create_at" : 1701403732492, "update_at" : 1701403732492, "agreement_confirm" : true } } } 创建子集版本 { "meta_info" : { "current_time" : "2024-01-02T02:04:22Z" }, "payload" : { "item" : { "id" : "102575d5-cf89-4aca-b856-0d39ae2a69c5", "label_dataset_id" : "61a22ebc-49b3-40b5-b16f-ab9aebd2b231", "name" : "V1", "label_format" : "OCTOPUS", "status" : "INITIALIZING", "frame_num" : 0, "frame_size" : 0, "label_count" : 0, "custom_image" : "10293:1", "command" : "command", "description" : "数据集版本", "project_id" : "64d37c8f25af4277a1ff4ee9772687bf", "workspace_id" : 0, "create_at" : 1701403732492, "update_at" : 1701403732492, "agreement_confirm" : true, "source_version_id" : "8d6df90a-8cd2-4ee6-ae12-36ae090600b5" } } }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 内容类型。填application/json X-Auth-Token 是 String 用户Token，通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） 表3 请求Body参数 参数 是否必选 参数类型 描述 batch_task_id 否 String 筛选标注任务(数据集来源(data_source)为标注(LABEL)时必填) label_meta_names 否 Array of strings 标注名(数据集来源(data_source)为标注(LABEL)时必填) access_key 否 String 用户base64编码后的ak(数据集来源为OBS时必填) secret_key 否 String 用户base64编码后的sk(数据集来源为OBS时必填) only_valid 否 Boolean 标注帧：true:有效标注帧, false:无效标注帧, 该参数不传:全部标注帧(数据集来源为标注时选填参数) hard_mining 否 Boolean true:仅难例数据集,false:非难例数据集,该参数不传:全部数据集(数据集来源为标注时选填参数) status 否 String 状态，数据集来源(data_source)为标注(LABEL)时必填 description 否 String 描述 bucket_path 否 String obs文件夹地址(数据集来源为OBS时必填) bucket_name 否 String 桶名(数据集来源为OBS时必填) warehouse_params 否 WarehouseParam object 通用存储筛选数据参数(数据集来源为通用存储时必填) custom_image 否 String 自定义镜像名称，形如"自定义镜像id:自定义镜像版本号" command 否 String 脚本路徑 agreement_confirm 是 Boolean 隐私声明同意 tags 否 Array of strings 标签(数据集类型(dataset_type)为子集(SUBSET)时可通过tag进行过滤) custom_attributes 否 Array of strings 自定义属性(数据集类型(dataset_type)为子集(SUBSET)时可通过自定义属性进行过滤) customer_target_path 否 String 存放路径 表4 WarehouseParam 参数 是否必选 参数类型 描述 data_process_task_ids 否 Array of strings 数据处理任务id，当传多个时是或的查询条件 raw_data_ids 否 Array of strings 原始数据id，当传多个时是或的查询条件 start_time 否 Long 原始数据采集时间，起始时间，UTC标准时间毫秒时间戳 end_time 否 Long 原始数据采集时间，终止时间，UTC标准时间毫秒时间戳 file_name 否 String 文件名称，单个模糊匹配 file_types 否 Array of strings 文件类型 and_tags 否 Array of strings 标签id，当传多个时是且的查询条件 or_tags 否 Array of strings 标签id，当传多个时是或的查询条件 and_custom_attributes 否 Array of strings 自定义属性id查询条件，当传多个时是且的查询条件 or_custom_attributes 否 Array of strings 自定义属性id查询条件，当传多个时是或的查询条件

请求示例 创建通用存储类型的数据集 POST https://{endpoint}/v1.0/{project_id}/common/datasets { "name" : "数据集-通用存储", "description" : "测试数据集-通用存储", "label_format" : "OCTOPUS", "data_type" : "IMAGE", "dataset_form" : "DATASET", "data_source" : "HOUSE", "label_taged" : false, "data_source_info" : { "data_warehouse_id" : "data_warehouse_id" }, "workspace_id" : 0 } 创建本地类型的数据集 POST https://{endpoint}/v1.0/{project_id}/common/datasets { "name" : "数据集-本地", "description" : "测试数据集-本地", "label_format" : "OCTOPUS", "data_type" : "IMAGE", "dataset_form" : "DATASET", "label_taged" : false, "data_source" : "LOCAL", "workspace_id" : 0 } 创建标注类型的数据集 POST https://{endpoint}/v1.0/{project_id}/common/datasets { "name" : "数据集-标注", "description" : "测试数据集-标注", "label_format" : "OCTOPUS", "data_type" : "IMAGE", "dataset_form" : "DATASET", "data_source" : "LABEL", "label_taged" : false, "data_source_info" : { "label_project_package_id" : "80da34ab-7f5e-476e-b2ec-1a974ba8a4a5", "label_project_package_name" : "test-车道线-test" }, "workspace_id" : 0 } 创建OBS类型的数据集 POST https://{endpoint}/v1.0/{project_id}/common/datasets { "name" : "数据集-OBS", "description" : "测试数据集-OBS", "label_format" : "OCTOPUS", "data_type" : "IMAGE", "dataset_form" : "DATASET", "label_taged" : false, "data_source" : "OBS", "workspace_id" : 0 } 创建子集 POST https://{endpoint}/v1.0/{project_id}/common/datasets { "name" : "数据集-子集", "description" : "测试数据集-子集", "dataset_form" : "SUBSET", "data_source" : "DATASET", "source_dataset_id" : "d6f9fdf1-99b3-457d-934b-14cce3265124", "workspace_id" : 0 }

响应示例 状态码：200 创建成功 创建通用存储类型的数据集 { "meta_info" : { "current_time" : "2024-01-02T02:04:22Z" }, "payload" : { "item" : { "id" : "61a22ebc-49b3-40b5-b16f-ab9aebd2b231", "name" : "数据集-通用存储", "description" : "测试数据集-通用存储", "data_type" : "IMAGE", "dataset_form" : "DATASET", "latest_version" : 0, "data_source" : "HOUSE", "frame_num" : 0, "frame_size" : 0, "project_id" : "64d37c8f25af4277a1ff4ee9772687bf", "workspace_id" : 0, "label_format" : "OCTOPUS", "label_taged" : false, "label_count" : 0, "create_at" : 1701403312027, "update_at" : 1701403312027, "data_source_info" : { "data_warehouse_id" : "ee9784a5-dde5-4a47-a006-fac074c5bee8" } } } } 创建本地类型的数据集 { "meta_info" : { "current_time" : "2024-01-02T02:04:22Z" }, "payload" : { "item" : { "id" : "61a22ebc-49b3-40b5-b16f-ab9aebd2b231", "name" : "数据集-本地", "description" : "测试数据集-本地", "data_type" : "IMAGE", "dataset_form" : "DATASET", "latest_version" : 0, "data_source" : "LOCAL", "frame_num" : 0, "frame_size" : 0, "project_id" : "64d37c8f25af4277a1ff4ee9772687bf", "workspace_id" : 0, "label_format" : "OCTOPUS", "label_taged" : false, "label_count" : 0, "create_at" : 1701403312027, "update_at" : 1701403312027, "data_source_info" : { } } } } 创建标注类型的数据集 { "meta_info" : { "current_time" : "2024-01-02T02:04:22Z" }, "payload" : { "item" : { "id" : "61a22ebc-49b3-40b5-b16f-ab9aebd2b231", "name" : "数据集-标注", "description" : "测试数据集-标注", "data_type" : "IMAGE", "dataset_form" : "DATASET", "latest_version" : 0, "data_source" : "LABEL", "frame_num" : 0, "frame_size" : 0, "project_id" : "64d37c8f25af4277a1ff4ee9772687bf", "workspace_id" : 0, "label_format" : "OCTOPUS", "label_taged" : false, "label_count" : 0, "create_at" : 1701403312027, "update_at" : 1701403312027, "data_source_info" : { "label_project_package_id" : "80da34ab-7f5e-476e-b2ec-1a974ba8a4a5", "label_project_package_name" : "projectName" } } } } 创建OBS类型的数据集 { "meta_info" : { "current_time" : "2024-01-02T02:04:22Z" }, "payload" : { "item" : { "id" : "61a22ebc-49b3-40b5-b16f-ab9aebd2b231", "name" : "数据集-OBS", "description" : "测试数据集-OBS", "data_type" : "IMAGE", "dataset_form" : "DATASET", "latest_version" : 0, "data_source" : "OBS", "frame_num" : 0, "frame_size" : 0, "project_id" : "64d37c8f25af4277a1ff4ee9772687bf", "workspace_id" : 0, "label_format" : "OCTOPUS", "label_taged" : false, "label_count" : 0, "create_at" : 1701403312027, "update_at" : 1701403312027, "data_source_info" : { } } } } 创建子集 { "meta_info" : { "current_time" : "2024-01-02T02:04:22Z" }, "payload" : { "item" : { "id" : "61a22ebc-49b3-40b5-b16f-ab9aebd2b231", "name" : "数据集-子集", "description" : "测试数据集-子集", "data_type" : "IMAGE", "dataset_form" : "SUBSET", "latest_version" : 0, "data_source" : "DATASET", "frame_num" : 0, "frame_size" : 0, "project_id" : "64d37c8f25af4277a1ff4ee9772687bf", "workspace_id" : 0, "label_format" : "OCTOPUS", "label_taged" : false, "label_count" : 0, "create_at" : 1701403312027, "update_at" : 1701403312027, "data_source_info" : { }, "source_dataset_id" : "d6f9fdf1-99b3-457d-934b-14cce3265124" } } }

响应参数 状态码：200 表5 响应Body参数 参数 参数类型 描述 payload CreateDatasetPayload object 实际返回信息 meta_info MetaInfo object 元数据 表6 CreateDatasetPayload 参数 参数类型 描述 item LabelDatasetCreate object 数据集信息 表7 LabelDatasetCreate 参数 参数类型 描述 id String id name String 名称 description String 描述 data_type String 数据类型 dataset_form String 数据集形式 source_dataset_id String 子集的源数据集ID latest_version Integer 最新版本 data_source String 数据来源 frame_num Long 文件数 frame_size Long 数据集下版本帧文件总大小，单位字节 project_id String 项目id workspace_id String 工作空间id label_format String 标注格式 label_count Long 标注物数量 label_names Array of strings 标注物名 create_at Long 创建时间，UTC标准时间毫秒时间戳 update_at Long 修改时间，UTC标准时间毫秒时间戳 label_taged Boolean 标注数据集tag，已标注是true data_source_info DataSourceInfoCreate object 数据相关信息 tags Array of strings 标签 custom_attributes Array of strings 自定义属性，格式形如"key:value" 表8 DataSourceInfoCreate 参数 参数类型 描述 label_project_package_id String 任务项目包ID label_project_package_name String 任务项目包名称 data_warehouse_id String 通用存储ID 表9 MetaInfo 参数 参数类型 描述 current_time String 请求时间，UTC时间格式，时间为UTC标准时间

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 内容类型。填application/json X-Auth-Token 是 String 用户Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 数据集名称 data_type 是 String 数据集数据类型 dataset_form 是 String 数据集形式 source_dataset_id 否 String 子集的源数据集id,当dataset_form取值为SUBSET时必填，源数据集需存在已发布的版本才能创建子集 data_source 是 String 数据集来源 description 否 String 描述 label_format 是 String 标注格式 data_source_info 是 DataSourceInfoRequest object 数据集来源信息 label_taged 否 Boolean 是否是从标注服务创建的数据集，如果是则为true，如果不是则为false workspace_id 是 String 工作空间id 表4 DataSourceInfoRequest 参数 是否必选 参数类型 描述 label_project_package_id 否 String 任务项目包ID（数据集来源(data_source)为标注(LABEL)，必填） label_project_package_name 否 String 任务项目包名称（数据集来源(data_source)为标注(LABEL)，必填） data_warehouse_id 否 String 通用存储ID（数据集来源(data_source)为通用存储(HOUSE)，必填）

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 内容类型。填application/json X-Auth-Token 是 String 用户Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） 表3 请求Body参数 参数 是否必选 参数类型 描述 description 否 String 描述，当为空时请求body需传空对象{}

响应示例 状态码：200 查询成功 获取数据集版本详情 { "meta_info" : { "current_time" : "2024-01-08T07:04:13Z" }, "payload" : { "item" : { "id" : "3371d47a-df83-43a6-ae86-0c634bd76238", "label_dataset_id" : "564e0c00-3883-4f0c-861d-f4b280506ddb", "name" : "V1", "batch_task_id" : "1377063caf6a42e1a95a030188500e1f", "label_meta_names" : [ "road" ], "label_format" : "OCTOPUS", "status" : "SUC CES S", "frame_num" : 1, "frame_size" : 1, "label_count" : 1, "label_names" : [ "Car" ], "custom_image" : "", "command" : "", "description" : "", "project_id" : "64d37c8f25af4277a1ff4ee9772687bf", "workspace_id" : 0, "create_at" : 1704694142135, "update_at" : 1704694287236, "label_infos" : [ { "label_shape_type" : "bndbox", "shape_count" : 1, "label_meta_infos" : [ { "label_name" : "Car", "count" : 1 } ] } ], "tag_infos" : [ ], "custom_attribute_infos" : [ ], "frame_ids" : [ "1" ], "has_finished" : true } } }

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 payload LabelDatasetVersionInfoPayload object 实际返回信息 meta_info MetaInfo object 元数据 表4 LabelDatasetVersionInfoPayload 参数 参数类型 描述 item LabelDatasetVersionDetailVO object 版本信息 表5 LabelDatasetVersionDetailVO 参数 参数类型 描述 id String id label_dataset_id String 数据集id name String 名称 batch_task_id String 批次任务id，当版本是标注创建的则返回该字段 label_meta_names Array of strings 标注物名 label_format String 标注格式 status String 状态 frame_num String 帧文件数量 frame_size String 帧文件大小，包含单位 label_count String 标志物数量 custom_image String 自定义镜像，版本中没有则不返回 command String 脚本路徑，版本中没有则不返回 description String 描述若版本中没有描述则不返回 project_id String 项目id workspace_id String 工作空间id create_at String 创建时间，UTC标准时间毫秒时间戳 update_at String 修改时间，UTC标准时间毫秒时间戳 upload_id String 上传id tags Array of strings 标签 custom_attributes Array of strings 自定义属性，格式形式"key:value" label_names Array of strings 标注物名 agreement_confirm Boolean 隐私声明同意 source_version_id String 子集的源数据集版本ID label_infos Array of LabelInfoVO objects 标注物信息 tag_infos Array of TagInfoVO objects tag信息 custom_attribute_infos Array of CustomAttributeInfoVO objects 自定义属性信息 frame_ids Array of strings 桢id集合 has_finished Boolean 已经结束，该数据集下没有非终止状态下的版本表示结束，成功或失败表示终止状态 表6 LabelInfoVO 参数 参数类型 描述 label_shape_type String 标注物形状 shape_count String 标注物形状个数 label_meta_infos Array of LabelMetaInfoVO objects 标注物名称信息 表7 LabelMetaInfoVO 参数 参数类型 描述 label_name String 标注物名称 count Long 标注物名称个数 表8 TagInfoVO 参数 参数类型 描述 tag_name String tag名称 count Long tag个数 表9 CustomAttributeInfoVO 参数 参数类型 描述 custom_attribute_name String 自定义属性名称 count Long 自定义属性名称个数 表10 MetaInfo 参数 参数类型 描述 current_time String 请求时间，UTC时间格式，时间为UTC标准时间

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 payload LabelDatasetVersionListPayload object 实际返回信息 meta_info MetaInfo object 元数据 表5 LabelDatasetVersionListPayload 参数 参数类型 描述 page_info PageInfo object 分页信息 list Array of LabelDatasetVersionListVO objects 版本列表 表6 PageInfo 参数 参数类型 描述 total Long 资源总数 offset Long 查询偏移量 limit Long 返回个数上限 表7 LabelDatasetVersionListVO 参数 参数类型 描述 id String id label_dataset_id String 数据集id tags Array of strings 标签 custom_attributes Array of strings 自定义属性，格式形式"key:value" label_names Array of strings 标注物名 name String 名称 batch_task_id String 批次任务id label_meta_names Array of strings 标注物名 label_format String 标注格式 status String 状态 frame_num String 帧文件数量 frame_size String 帧文件大小，包含单位 label_count String 标志物数量 custom_image String 自定义镜像 command String 脚本路徑 description String 描述 project_id String 项目id workspace String 工作空间id create_at String 创建时间，UTC标准时间毫秒时间戳 update_at String 修改时间，UTC标准时间毫秒时间戳 upload_id String 上传id agreement_confirm Boolean 隐私声明同意 source_version_id String 子集的源数据集版本ID has_finished Boolean 已经结束，该数据集下没有非终止状态下的版本表示结束，成功或失败表示终止状态 file_size String 文件大小，带单位 表8 MetaInfo 参数 参数类型 描述 current_time String 请求时间，UTC时间格式，时间为UTC标准时间

响应示例 状态码：200 查询成功 获取数据集版本列表 { "meta_info" : { "current_time" : "2024-01-02T02:04:22Z" }, "payload" : { "list" : [ { "id" : "102575d5-cf89-4aca-b856-0d39ae2a69c5", "label_dataset_id" : "61a22ebc-49b3-40b5-b16f-ab9aebd2b231", "name" : "V1", "label_format" : "OCTOPUS", "status" : "SUCCESS", "frame_num" : 100, "frame_size" : 47518529, "label_count" : 0, "project_id" : "64d37c8f25af4277a1ff4ee9772687bf", "workspace_id" : 0, "create_at" : 1701393989718, "update_at" : 1701394037579, "has_finished" : true, "file_size" : "45.32MB", "custom_image" : "10293:1", "command" : "command", "description" : "描述" } ], "page_info" : { "total" : 1, "offset" : 0, "limit" : 10 } } }

URI GET /v1.0/{project_id}/common/datasets/{dataset_id}/versions 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id，获取方法请参见获取项目ID dataset_id 是 String 数据集id 表2 Query参数 参数 是否必选 参数类型 描述 name 否 String 根据名称模糊查询 statuses 否 Array of strings 根据数据集版本状态筛选 order 否 String 查询结果的排序方式 offset 否 Integer 查询偏移量 limit 否 Integer 返回个数上限

响应示例 状态码：200 查询成功 获取数据集详情 { "meta_info" : { "current_time" : "2024-01-02T02:04:22Z" }, "payload" : { "item" : { "id" : "61a22ebc-49b3-40b5-b16f-ab9aebd2b231", "name" : "数据集1", "description" : "测试数据集", "data_type" : "IMAGE", "latest_version" : 0, "data_source" : "HOUSE", "frame_num" : 0, "frame_size" : 0, "project_id" : "64d37c8f25af4277a1ff4ee9772687bf", "workspace_id" : 0, "label_format" : "OCTOPUS", "label_count" : 0, "label_taged" : false, "create_at" : 1701403312027, "update_at" : 1701403312027, "data_source_info" : { "data_warehouse_id" : "ee9784a5-dde5-4a47-a006-fac074c5bee8" }, "version_count" : 0, "has_finished" : true, "version_success_count" : 0, "dataset_form" : "DATASET" } } }

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 payload GetLabelDatasetVoPayload object 实际返回信息 meta_info MetaInfo object 元数据 表4 GetLabelDatasetVoPayload 参数 参数类型 描述 item LabelDatasetDetailVO object 数据集信息 表5 LabelDatasetDetailVO 参数 参数类型 描述 id String id name String 名称 description String 描述 data_type String 数据类型 dataset_form String 数据集形式 source_dataset_id String 子集的源数据集ID latest_version Integer 最新版本 data_source String 数据来源 owner String 数据集类型 frame_num Long 文件数 frame_size Long 数据集下版本帧文件总大小，单位字节 project_id String 项目id workspace_id String 工作空间id label_format String 标注格式 label_count Long 标注物数量 label_names Array of strings 所有标注物名称 create_at Long 创建时间，UTC标准时间毫秒时间戳 update_at Long 修改时间，UTC标准时间毫秒时间戳 label_taged Boolean 标注数据集tag，已标注是true data_source_info DataSourceInfoList object 数据相关信息 tags Array of strings 标签 custom_attributes Array of strings 自定义属性，格式形如"key:value" version_count Integer 版本数量 has_finished Boolean 是否结束，该数据集下没有非终止状态下的版本表示结束，成功或失败表示终止状态 version_success_count Integer 数据集下状态为成功的版本数量位 source_dataset_name String 源数据集name 表6 DataSourceInfoList 参数 参数类型 描述 label_project_package_id String 任务项目包ID label_project_package_name String 任务项目包名称 batch_task_ids Array of strings 批次任务ID data_warehouse_id String 通用存储ID raw_data_ids Array of strings 原始数据包ID data_process_task_ids Array of strings 处理任务ID 表7 MetaInfo 参数 参数类型 描述 current_time String 请求时间，UTC时间格式，时间为UTC标准时间

响应示例 状态码：200 查询成功 获取数据集列表 { "payload" : { "list" : [ { "id" : "61a22ebc-49b3-40b5-b16f-ab9aebd2b231", "name" : "dataset_name", "description" : "", "data_type" : "IMAGE", "latest_version" : 3, "data_source" : "HOUSE", "frame_num" : 123, "frame_size" : 93398989, "project_id" : "64d37c8f25af4277a1ff4ee9772687bf", "label_format" : "OCTOPUS", "label_count" : 0, "label_taged" : "false,", "create_at" : 1701077827974, "update_at" : 1701335688724, "data_source_info" : { "data_warehouse_id" : "ee9784a5-dde5-4a47-a006-fac074c5bee8", "data_process_task_ids" : [ "frame-extract-2077" ] }, "tags" : [ "接管", "大客车", "停车位", "小区内部路", "乡村道路", "卡车", "一般道路", "轿车" ], "custom_attributes" : [ "city:tencent", "city:sunny", "city:not-a-plate" ], "version_count" : 3, "has_finished" : true, "version_success_count" : 0, "publish_status" : "UN_PUBLISH", "file_size" : "89.07MB" } ], "page_info" : { "total" : 237, "offset" : 0, "limit" : 10 } }, "meta_info" : { "current_time" : "2024-01-02T02:04:22Z" } }

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 payload LabelDatasetVOPayload object 实际返回信息 meta_info MetaInfo object 元数据 表5 LabelDatasetVOPayload 参数 参数类型 描述 list Array of LabelDatasetVO objects 数据集列表 page_info PageInfo object 分页信息 表6 LabelDatasetVO 参数 参数类型 描述 id String id name String 名称 description String 描述 data_type String 数据类型 dataset_form String 数据集形式 source_dataset_id String 子集的源数据集ID latest_version Integer 最新版本 data_source String 数据来源 owner String 数据集类型 frame_num Long 文件数 frame_size Long 数据集下版本帧文件总大小，单位字节 project_id String 项目id workspace_id String 工作空间id label_format String 标注格式 label_count Long 标注物数量 label_names Array of strings 所有标注物名称 create_at Long 创建时间，UTC标准时间毫秒时间戳 update_at Long 修改时间，UTC标准时间毫秒时间戳 label_taged Boolean 标注数据集tag，已标注是true data_source_info DataSourceInfoList object 数据相关信息 tags Array of strings 标签 custom_attributes Array of strings 自定义属性，格式形如"key:value" version_count Integer 版本数量 has_finished Boolean 是否结束，该数据集下没有非终止状态下的版本表示结束，成功或失败表示终止状态 version_success_count Integer 数据集下状态为成功的版本数量 publish_status String 发布状态 file_size String 数据集所有版本文件总大小，包含具体单位 表7 DataSourceInfoList 参数 参数类型 描述 label_project_package_id String 任务项目包ID label_project_package_name String 任务项目包名称 batch_task_ids Array of strings 批次任务ID data_warehouse_id String 通用存储ID raw_data_ids Array of strings 原始数据包ID data_process_task_ids Array of strings 处理任务ID 表8 PageInfo 参数 参数类型 描述 total Long 资源总数 offset Long 查询偏移量 limit Long 返回个数上限 表9 MetaInfo 参数 参数类型 描述 current_time String 请求时间，UTC时间格式，时间为UTC标准时间

URI GET /v1.0/{project_id}/common/datasets 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id，获取方法请参见获取项目ID 表2 Query参数 参数 是否必选 参数类型 描述 name 否 String 名称 data_type 否 String 枚举值： IMAGE(图片) POINT_CLOUD(点云) TEXT(文本) VIDEO(视频) dataset_form 否 String 数据集类别 source_dataset_id 否 String 源数据集id label_format 否 String 按标注格式筛选 data_source 否 String 枚举值： LABEL(标注任务) LOCAL(本地) OBS HOUSE( 数据仓库 ) DATASET(数据集) owner 否 String 数据集类型 order 否 String 查询结果的排序方式 offset 否 Integer 查询偏移量 limit 否 Integer 返回个数上限 statuses 否 Array of strings 枚举值： CREATING(创建中) IN_INTEGRATION(整合中) EXPORTING(导出中) SUCCESS(成功) INTEGRATION_FAILED(整合失败) EXPORT_FAILED(导出失败) EXPORT_PRE_SUCCESS(导出中) UPLOAD_SUSPENDED(上传中断) INITIALIZING(初始化) label_taged 否 Boolean 标注数据集tag，已标注是true，未标注是false select_source_dataset 否 Boolean 是否查询源数据集list，是true，否false workspace_id 否 String 工作空间id

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） Content-Type 是 String 内容类型。填application/json 表3 请求Body参数 参数 是否必选 参数类型 描述 type 是 String 作业类型 frame_extract_config 否 DataFrameExtractJobConfig object 抽帧作业参数，作业类型是F RAM E_EXTRACT时该字段必填 scenario_mining_req 否 DataScenarioMiningJobRequest object 场景挖掘作业参数，作业类型是SCENARIO_AUTO_MINING时该字段必填 workspace_id 是 String 工作空间id 表4 DataFrameExtractJobConfig 参数 是否必选 参数类型 描述 data_id 是 String 数据包id，以DPK开头，加7-13位数字 interval 是 Integer 抽帧间隔，单位毫秒 start 是 Long 抽帧开始时间，UTC标准时间毫秒时间戳 end 是 Long 抽帧结束时间，UTC标准时间毫秒时间戳 warehouse_id 是 String 抽帧结果放入的数据仓库id dataset_id 否 String 抽帧结果放入的数据集id topics 是 Array of strings 抽帧topic列表，仅限对应数据包内lidar和camera类型的topic，最多10个 表5 DataScenarioMiningJobRequest 参数 是否必选 参数类型 描述 data_id 是 String 以DPK开头，加7-13位数字

请求示例 创建抽帧作业 https://{endpoint}/v1.0/{project_id}/data/system-jobs { "type" : "FRAME_EXTRACT", "frame_extract_config" : { "data_id" : "DPK0000001", "dataset_id" : "2af31fbb-xxxx-xxxx-xxxx-97c19dc68122", "end" : "1640968400000", "start" : "1640966400000", "interval" : "200", "warehouse_id" : "f78214c6-xxxx-xxxx-xxxx-0315098bce88", "topics" : [ "camera_0" ] } } 创建场景挖掘作业 https://{endpoint}/v1.0/{project_id}/data/system-jobs { "type" : "SCENARIO_AUTO_MINING", "scenario_mining_req" : { "data_id" : "DPK0000001" } }