华为云用户手册

响应参数 状态码： 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 标注格式 枚举值： OCTOPUS(OCTOPUS格式) USER_DEFINE(自定义格式) status String 状态 枚举值： CREATING(创建中) IN_INTEGRATION(整合中) EXPORTING(导出中) SUC CES S(成功) INTEGRATION_FAILED(整合失败) EXPORT_FAILED(导出失败) EXPORT_PRE_SUCCESS(导出中) UPLOAD_SUSPENDED(上传中断) INITIALIZING(初始化) frame_num String 帧文件数量 frame_size String 帧文件大小，包含单位 label_count String 标志物数量 tags Array of strings 标签 最大长度：64 custom_attributes Array of strings 自定义属性，格式形式"key:value" custom_image String 自定义镜像 command String 脚本路徑 description String 描述 project_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标准时间

请求参数 表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)时必填) only_valid 否 Boolean 标注帧：true:有效标注帧, false:无效标注帧, 该参数不传:全部标注帧(数据集来源为标注时选填参数) hard_mining 否 Boolean true:仅难例数据集,false:非难例数据集,该参数不传:全部数据集(数据集来源为标注时选填参数) status 否 String 状态，数据集来源(data_source)为标注(LABEL)时必填 枚举值： all(全部数据集) labeled(已标注数据集) description 否 String 描述 最大长度：256 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)时可通过自定义属性进行过滤) 表4 WarehouseParam 参数 是否必选 参数类型 描述 data_process_task_ids 否 Array of strings 数据处理任务id，当传多个时是或的查询条件 数组长度：0 - 5 raw_data_ids 否 Array of strings 原始数据id，当传多个时是或的查询条件 数组长度：0 - 5 start_time 否 Long 原始数据采集时间，起始时间，UTC标准时间毫秒时间戳 最小值：0 end_time 否 Long 原始数据采集时间，终止时间，UTC标准时间毫秒时间戳 最小值：0 file_name 否 String 文件名称，单个模糊匹配 最大长度：64 file_types 否 Array of strings 文件类型 数组长度：0 - 6 枚举值： IMAGE(图片) POINT_CLOUD(点云) TEXT(文本) VIDEO(视频) SCENARIO(场景) OTHERS(其他) and_tags 否 Array of strings 标签id，当传多个时是且的查询条件 数组长度：0 - 5 or_tags 否 Array of strings 标签id，当传多个时是或的查询条件 数组长度：0 - 5 and_custom_attributes 否 Array of strings 自定义属性id查询条件，当传多个时是且的查询条件 数组长度：0 - 5 or_custom_attributes 否 Array of strings 自定义属性id查询条件，当传多个时是或的查询条件 数组长度：0 - 5

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 内容类型。填application/json X-Auth-Token 是 String 用户Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 镜像仓库名称 最小长度：1 最大长度：64 scope 是 String 用途 枚举值： DATA_CONVERSION(数据转换) ANNOTATION_AI(预标注) ANNOTATION_INSPECTION(预审核) TRAINING_TRAIN(训练/评测) TRAINING_COMPILE(模型编译) TRAINING_DEV(开发环境) TRAINING_NOTEBOOK(Notebook) SIMULATION_ALGORITHM(仿真算法) SIMULATION_EVALUATION(仿真评测) SIMULATION_SIMULATOR(仿真器) SIMULATION_TESTCASE(测试用例) COMMON_DATASET(数据集) description 否 String 镜像仓库描述 最大长度：256 visibility 否 String 使用范围，默认TEAM 缺省值：TEAM(团队) 枚举值： TEAM(团队) PUBLIC(公开)

响应参数 状态码： 201 表4 响应Body参数 参数 参数类型 描述 payload IdPayload object 实际返回信息 meta_info MetaInfo object 元数据 表5 IdPayload 参数 参数类型 描述 item Long 资源id 表6 MetaInfo 参数 参数类型 描述 current_time String 请求时间，UTC时间格式，时间为UTC标准时间

URI DELETE /v1.0/{project_id}/common/image-registry/image-repos/{id}/versions/{version} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id，获取方法请参见获取项目ID id 是 Long 镜像仓库id 最小值：1 version 是 Integer 版本号 最小值：1

响应参数 状态码： 201 表6 响应Body参数 参数 参数类型 描述 payload payloadWithSingleNumber object 实际返回信息 meta_info RespMetaInfo object 元数据 表7 payloadWithSingleNumber 参数 参数类型 描述 item Long 资源id 表8 RespMetaInfo 参数 参数类型 描述 current_time String 请求时间，UTC时间格式，时间为UTC标准时间

请求示例 创建抽帧作业 https://{endpoint}/v1.0/{project_id}/data/system-jobs{ "type" : "F RAM E_EXTRACT", "frame_extract_config" : { "data_id" : "DPK0000001", "dataset_id" : "2af31fbb-222f-4714-bad7-97c19dc68122", "end" : "1640968400000", "start" : "1640966400000", "interval" : "200", "warehouse_id" : "f78214c6-1f7e-48fc-b5d1-0315098bce88", "topics" : [ "camera_0" ] }} 创建场景挖掘作业 https://{endpoint}/v1.0/{project_id}/data/system-jobs{ "type" : "SCENARIO_AUTO_MINING", "scenario_mining_req" : { "data_id" : "DPK0000001" }}

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

响应示例 状态码： 200 更新结果 { "meta_info" : { "current_time" : "2022-01-01T08:08:29Z" }, "payload" : { "list" : [ { "id" : 1, "result" : "SUCCESS" }, { "id" : 2, "result" : "FAILED", "error_msg" : "The job does not exist." } ] }}

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 payload DataJobBatchOperationCommonResopnse object 实际返回信息 meta_info RespMetaInfo object 元数据 表6 DataJobBatchOperationCommonResopnse 参数 参数类型 描述 list Array of DataJobBatchDeleteResponse objects 返回结果列表 表7 DataJobBatchDeleteResponse 参数 参数类型 描述 id Long 作业id result String 结果 枚举值： SUCCESS(成功) FAILED(失败) error_msg String 错误原因 表8 RespMetaInfo 参数 参数类型 描述 current_time String 请求时间，UTC时间格式，时间为UTC标准时间

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） Content-Type 是 String 内容类型。填application/json 表3 请求Body参数 参数 是否必选 参数类型 描述 [数组元素] 是 Array of JobBatchUpdateRequestItem objects 请求内容，最多50组 表4 JobBatchUpdateRequestItem 参数 是否必选 参数类型 描述 id 是 Long 作业id 最小值：1 action 是 String 操作类型 枚举值： STOP(停止作业)

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） Content-Type 是 String 内容类型。填application/json 表3 请求Body参数 参数 是否必选 参数类型 描述 action 是 String 操作类型 枚举值： RESTORE(还原) RECYCLE(放入回收站)

响应示例 状态码： 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", "label_format" : "OCTOPUS", "label_taged" : false, "label_associated" : 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", "label_format" : "OCTOPUS", "label_taged" : false, "label_associated" : 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", "label_format" : "OCTOPUS", "label_taged" : false, "label_associated" : 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", "label_format" : "OCTOPUS", "label_taged" : false, "label_associated" : 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", "label_format" : "OCTOPUS", "label_taged" : false, "label_associated" : false, "label_count" : 0, "create_at" : 1701403312027, "update_at" : 1701403312027, "data_source_info" : { }, "source_dataset_id" : "d6f9fdf1-99b3-457d-934b-14cce3265124" } }}

请求示例 创建数据仓库类型的数据集 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" }} 创建本地类型的数据集 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"} 创建标注类型的数据集 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" }} 创建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"} 创建子集 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"}

响应参数 状态码： 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 数据类型 枚举值： IMAGE(图片) POINT_CLOUD(点云) TEXT(文本) VIDEO(视频) dataset_form String 数据集形式 枚举值： DATASET(数据集) SUBSET(子集) source_dataset_id String 子集的源数据集ID latest_version Integer 最新版本 data_source String 数据来源 枚举值： LABEL(标注) LOCAL(本地) OBS HOUSE(数据仓库) DATASET(数据集) frame_num Long 文件数 frame_size Long 数据集下版本帧文件总大小，单位字节 project_id String 项目id label_format String 标注格式 枚举值： OCTOPUS(OCTOPUS格式) USER_DEFINE(自定义格式) label_count Long 标注物数量 label_names Array of strings 标注物名 create_at Long 创建时间，UTC标准时间毫秒时间戳 update_at Long 修改时间，UTC标准时间毫秒时间戳 label_taged Boolean 标注数据集tag，已标注是true label_associated Boolean 标注服务中，标注任务是否关联该数据集，关联了为true data_source_info DataSourceInfoCreate object 数据相关信息 tags Array of strings 标签 最大长度：64 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 数据集名称 最小长度：1 最大长度：64 data_type 是 String 数据集数据类型 枚举值： IMAGE(图片) POINT_CLOUD(点云) TEXT(文本) VIDEO(视频) dataset_form 是 String 数据集形式 枚举值： DATASET(数据集) SUBSET(子集) source_dataset_id 否 String 子集的源数据集id,当dataset_form取值为SUBSET时必填 data_source 是 String 数据集来源 枚举值： LABEL(标注任务) LOCAL(本地) OBS(obs) HOUSE(数据仓库) DATASET(数据集) description 否 String 描述 最大长度：256 label_format 是 String 标注格式 枚举值： OCTOPUS(OCTOPUS格式) USER_DEFINE(自定义格式) data_source_info 是 DataSourceInfoRequest object 数据集来源信息 label_taged 否 Boolean 是否是从标注服务创建的数据集，如果是则为true，如果不是则为false 表4 DataSourceInfoRequest 参数 是否必选 参数类型 描述 label_project_package_id 否 String 任务项目包ID（数据集来源(data_source)为标注(LABEL)，必填） label_project_package_name 否 String 任务项目包名称（数据集来源(data_source)为标注(LABEL)，必填） 最大长度：64 data_warehouse_id 否 String 数据仓库ID（数据集来源(data_source)为数据仓库(HOUSE)，必填）

响应参数 状态码： 200 表6 响应Body参数 参数 参数类型 描述 payload payloadWithSingleString object 实际返回信息 meta_info RespMetaInfo object 元数据 表7 payloadWithSingleString 参数 参数类型 描述 item String 创建的导入任务id 表8 RespMetaInfo 参数 参数类型 描述 current_time String 请求时间，UTC时间格式，时间为UTC标准时间

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） Content-Type 是 String 内容类型。填application/json 表3 请求Body参数 参数 是否必选 参数类型 描述 desensitization 否 DataProcessorConfig object 脱敏处理任务 表4 DataProcessorConfig 参数 是否必选 参数类型 描述 processor_id 是 Long 算子id，配置算子时此项必填 resource_spec 是 String 资源规格，配置算子时此项必填，示例：1Core_4GiB。具体获取方式可参考“查询可用资源规格“接口 envs 否 Array of JobEnv objects 环境变量，最多十组 表5 JobEnv 参数 是否必选 参数类型 描述 key 是 String 环境变量键，不能重复，配置环境变量时此项必填 最大长度：64 value 是 String 环境变量值，配置环境变量时此项必填 最大长度：64

请求示例 POST https://{endpoint}/v1.0/{project_id}/data/jobs{ "envs" : [ { "key" : "topic", "value" : "camera_1" } ], "priority" : 1, "data_id" : "DPK0000001", "data_source" : "DATA_PACKAGE", "processor_id" : 10002, "warehouse_id" : "f78214c6-1f7e-48fc-b5d2-0315098bce88", "warehouse_filters" : { "raw_data_ids" : [ "DPK0000001" ], "file_types" : [ "TEXT", "IMAGE" ] }, "resource_spec" : "1Core_1GiB"}

响应参数 状态码： 201 表6 响应Body参数 参数 参数类型 描述 payload payloadWithSingleNumber object 实际返回信息 meta_info RespMetaInfo object 元数据 表7 payloadWithSingleNumber 参数 参数类型 描述 item Long 资源id 表8 RespMetaInfo 参数 参数类型 描述 current_time String 请求时间，UTC时间格式，时间为UTC标准时间

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） Content-Type 是 String 内容类型。填application/json 表3 请求Body参数 参数 是否必选 参数类型 描述 data_id 是 String 输入数据id。取值为数据仓库id时表示以数据仓库数据作为作业输入，可以使用warehouse_filters字段对输入数据进行筛选 最大长度：64 processor_id 是 Long 算子id 最小值：1 resource_spec 是 String 资源规格，示例：1Core_4GiB。具体获取方式可参考“查询可用资源规格“接口 priority 否 Integer 作业优先级，数值越大优先级越高 最小值：-50 最大值：50 缺省值：0 warehouse_filters 否 WarehouseDataFilters object 当data_id字段的取值为数据仓库id时，本结构体配置数据仓库输入数据筛选条件 warehouse_id 否 String 输出到数据仓库的id。当算子类型为数据标记、数据集、数据图表和回放仿真时必填 envs 否 Array of JobEnv objects 环境变量配置，最多十组 data_source 是 String 输入数据来源 枚举值： DATA_PACKAGE(数据包) DATA_WAREHOUSE(数据仓库) DATA_SCENARIO(数据场景) 表4 WarehouseDataFilters 参数 是否必选 参数类型 描述 start_time 否 Long 创建时间最小值时间，UTC标准时间毫秒时间戳 最小值：0 end_time 否 Long 创建时间最大值时间，UTC标准时间毫秒时间戳 最小值：0 file_name 否 String 文件名称筛选 最大长度：255 data_process_task_ids 否 Array of strings 数据处理任务id列表，id最多5个 raw_data_ids 否 Array of strings 原始数据id列表，id最多5个 and_tags 否 Array of longs 按标签筛选，多个标签取交集，tag最多5个 or_tags 否 Array of integers 按标签筛选，多个标签取并集，tag最多5个 and_custom_attributes 否 Array of strings 按自定义属性筛选，多个属性取交集，attribute最多5个 or_custom_attributes 否 Array of strings 按自定义属性筛选，多个属性取并集，attribute最多5个 file_types 否 Array of strings 文件类型列表，file_type最多10个 枚举值： IMAGE(图片) POINT_CLOUD(点云) TEXT(文本) VIDEO(视频) SCENARIO(场景文件) OTHERS(其他) 表5 JobEnv 参数 是否必选 参数类型 描述 key 是 String 环境变量键，不能重复，配置环境变量时此项必填 最大长度：64 value 是 String 环境变量值，配置环境变量时此项必填 最大长度：64

响应参数 状态码： 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 查询成功 { "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参数 参数 是否必选 参数类型 描述 start_time 是 Long 起始时间，UTC标准时间毫秒时间戳 最小值：1000000000000 最大值：2000000000000 end_time 是 Long 结束时间，UTC标准时间毫秒时间戳 最小值：1000000000000 最大值：2000000000000 dpk_id 否 String 数据包ID，支持通配模糊查询 最大长度：255 vehicle_name 否 String 车辆名称，只支持精确匹配查询 最大长度：64 limit 否 Integer 返回个数上限 最小值：1 最大值：200 缺省值：10 offset 否 Integer 查询偏移量 最小值：0 缺省值：0

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

响应参数 状态码： 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 标注格式 枚举值： OCTOPUS(OCTOPUS格式) USER_DEFINE(自定义格式) status String 状态 枚举值： CREATING(创建中) IN_INTEGRATION(整合中) EXPORTING(导出中) SUCCESS(成功) INTEGRATION_FAILED(整合失败) EXPORT_FAILED(导出失败) EXPORT_PRE_SUCCESS(导出中) UPLOAD_SUSPENDED(上传中断) INITIALIZING(初始化) frame_num String 帧文件数量 frame_size String 帧文件大小，包含单位 label_count String 标志物数量 custom_image String 自定义镜像 command String 脚本路徑 description String 描述 project_id 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标准时间

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 根据名称模糊查询 最小长度：1 最大长度：64 statuses 否 Array 根据数据集版本状态筛选 枚举值： CREATING(创建中) IN_INTEGRATION(整合中) EXPORTING(导出中) SUCCESS(成功) INTEGRATION_FAILED(整合失败) EXPORT_FAILED(导出失败) EXPORT_PRE_SUCCESS(导出中) UPLOAD_SUSPENDED(上传中断) INITIALIZING(初始化) order 否 String 查询结果的排序方式 枚举值： DESC(更新时间降序) ASC(更新时间升序) offset 否 Integer 查询偏移量 最小值：0 缺省值：0 limit 否 Integer 返回个数上限 最小值：1 最大值：100 缺省值：10

请求示例 创建算子 https://{endpoint}/v1.0/{project_id}/data/processors{ "name" : "processor", "description" : "this is description", "output_type" : "DATA_MARK", "visibility" : "PUBLIC", "image_repo_id" : 1, "image_version" : 1, "config" : { "command" : "this is command" }}

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） Content-Type 是 String 内容类型。填application/json 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 名称 最大长度：64 description 否 String 描述 最大长度：256 output_type 是 String 输出类型 枚举值： DATA_MARK(数据标记) OPEN_DATA(数据回放) DATA_SET(数据集) REPLAY_SIM(回放仿真) PLOT_DATA(数据图表) DATA_DESENSITIZATION(数据脱敏) visibility 是 String 可见范围 枚举值： PRIVATE(私有) PUBLIC(公开) image_repo_id 是 Integer 镜像仓库id，通过“获取镜像仓库列表”接口获取 最小值：1 image_version 是 Integer 镜像仓库版本号，通过“获取镜像仓库版本列表”接口获取 最小值：1 config 是 DataProcessorConfigRequest object 算子配置 表4 DataProcessorConfigRequest 参数 是否必选 参数类型 描述 command 是 String 启动命令 最大长度：500

响应参数 状态码： 201 表5 响应Body参数 参数 参数类型 描述 payload payloadWithSingleNumber object 实际返回信息 meta_info RespMetaInfo object 元数据 表6 payloadWithSingleNumber 参数 参数类型 描述 item Long 资源id 表7 RespMetaInfo 参数 参数类型 描述 current_time String 请求时间，UTC时间格式，时间为UTC标准时间