华为云用户手册

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

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(导出中) SUC CES S(成功) 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

响应参数 状态码：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-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" } }

请求参数 表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 抽帧作业参数，作业类型是FRAME_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位数字

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

请求示例 创建回放转仿真场景作业 POST https://{endpoint}/v1.0/{project_id}/data/episodes/scenarios { "start" : 1640966400000, "end" : 1640966500000, "tag_ids" : [ 1000 ], "dpk_id" : "DPK0000001", "sim_name" : "仿真场景", "scenario_description" : "description", "sim_format" : "SIM_PRO_TOOLS" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） Content-Type 是 String 内容类型。填application/json 表3 请求Body参数 参数 是否必选 参数类型 描述 start 是 Long 起始时间，UTC标准时间毫秒时间戳 end 是 Long 结束时间，UTC标准时间毫秒时间戳 dpk_id 是 String 数据包id，以DPK开头，加7-13位数字 sim_name 是 String 仿真场景名称 sim_format 否 String 仿真器。VTD_TOOLS：VTD，SIM_PRO_TOOLS：SimPro scenario_description 否 String 场景描述 priority 否 Integer 作业优先级 tag_ids 否 Array of longs 标签列表，最多50个 data_warehouse_id 否 String 作业输出若需保存到数据仓库，此处填写数据仓库id workspace_id 是 String 工作空间id

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

请求示例 创建数据场景片段，对应数据包DPK0000001，打标签101 POST https://{endpoint}/v1.0/{project_id}/data/scenario/segments { "tag_ids" : [ 101 ], "dpk_id" : "DPK0000001", "start" : 1630057506742, "end" : 1630057516742 }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） Content-Type 是 String 内容类型。填application/json 表3 请求Body参数 参数 是否必选 参数类型 描述 start 是 Long 起始时间，UTC标准时间毫秒时间戳 end 是 Long 结束时间，UTC标准时间毫秒时间戳 dpk_id 是 String 数据包id，以DPK开头，加7-13位数字 tag_ids 是 Array of integers 标签id列表，目前仅限一个标签，可通过“获取标签列表”获取 workspace_id 是 String 工作空间id

响应参数 状态码：201 表5 响应Body参数 参数 参数类型 描述 payload payloadWithSingleNumber object 实际返回信息 meta_info RespMetaInfo object 元数据 表6 payloadWithSingleNumber 参数 参数类型 描述 item Long 资源id 表7 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参数 参数 是否必选 参数类型 描述 name 是 String 名称 description 否 String 描述 output_type 是 String 输出类型 visibility 是 String 可见范围 image_repo_id 是 Integer 镜像仓库id，通过“获取镜像仓库列表”接口获取 image_version 是 Integer 镜像仓库版本号，通过“获取镜像仓库版本列表”接口获取 config 是 DataProcessorConfigRequest object 算子配置 workspace_id 是 String 工作空间id 表4 DataProcessorConfigRequest 参数 是否必选 参数类型 描述 command 是 String 启动命令

请求示例 创建算子 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" } }

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

请求示例 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-xxxx-xxxx-xxxx-0315098bce88", "warehouse_filters" : { "raw_data_ids" : [ "DPK0000001" ], "file_types" : [ "TEXT", "IMAGE" ] }, "resource_spec" : "1Core_1GiB" }

请求参数 表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字段对输入数据进行筛选 processor_id 是 Long 算子id resource_spec 是 String 资源规格，示例：1Core_4GiB。具体获取方式可参考“查询可用资源规格“接口 priority 否 Integer 作业优先级，数值越大优先级越高 warehouse_filters 否 WarehouseDataFilters object 当data_id字段的取值为数据仓库id时，本结构体配置数据仓库输入数据筛选条件 warehouse_id 否 String 输出到数据仓库的id。当算子类型为数据标记、数据集、数据图表和回放仿真时必填 envs 否 Array of JobEnv objects 环境变量配置，最多十组 data_source 是 String 输入数据来源 workspace_id 是 String 工作空间id cluster_type 否 String 集群类型 cluster_id 否 String 集群ID，当cluster_type为MODELARTS时,该字段必填 表4 WarehouseDataFilters 参数 是否必选 参数类型 描述 start_time 否 Long 创建时间最小值时间，UTC标准时间毫秒时间戳 end_time 否 Long 创建时间最大值时间，UTC标准时间毫秒时间戳 file_name 否 String 文件名称筛选 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个 表5 JobEnv 参数 是否必选 参数类型 描述 key 是 String 环境变量键，不能重复，配置环境变量时此项必填 value 是 String 环境变量值，配置环境变量时此项必填

响应示例 状态码：201 创建成功 { "meta_info" : { "current_time" : "2022-01-01T08:08:29Z" }, "payload" : { "item" : { "username" : "cn-north-1@XXXXXXXXXXXXXXXXXXXX", "path" : "swr.cn-north-1.myhuaweicloud.com/octopus-087679f0aa80d32a2f4ec0172f5e902b/image-10001:v1.0", "password" : "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "action" : "push", "expire_at" : 1701485924 } } }

功能介绍 创建镜像仓库版本操作账号。 使用说明：假设发送请求后得到用户名cn-north-1@XXXXXXXXXX、密码YYYYYYYYYYY、镜像版本路径 swr.cn-north-1.myhuaweicloud.com/octopus-087679f0aa80d32a2f4ec0172f5e902b/image-10001:v1.0 、动作为pull，在本地一台安装了docker软件的计算机上输入"docker login -u cn-north-1@XXXXXXXXXX -p YYYYYYYYYYY swr.cn-north-1.myhuaweicloud.com"进行登录，然后输入"docker pull swr.cn-north-1.myhuaweicloud.com/octopus-087679f0aa80d32a2f4ec0172f5e902b/image-10001:v1.0" 拉取对应镜像。如果动作是push，则需要先在本地构建出标签为"swr.cn-north-1.myhuaweicloud.com/octopus-087679f0aa80d32a2f4ec0172f5e902b/image-10001:v1.0" 的镜像，然后通过"docker push swr.cn-north-1.myhuaweicloud.com/octopus-087679f0aa80d32a2f4ec0172f5e902b/image-10001:v1.0" 命令推送到octopus平台。

响应参数 状态码：201 表4 响应Body参数 参数 参数类型 描述 payload RepoVersionAccountPayload object 实际返回信息 meta_info MetaInfo object 元数据 表5 RepoVersionAccountPayload 参数 参数类型 描述 item RepoVersionAccount object 登录及操作指令相关信息 表6 RepoVersionAccount 参数 参数类型 描述 username String docker login登录名称 password String docker login登录密码 action String docker操作命令 expire_at Long 过期时间戳，单位为秒 path String 镜像版本完整路径 表7 MetaInfo 参数 参数类型 描述 current_time String 请求时间，UTC时间格式，时间为UTC标准时间

URI POST /v1.0/{project_id}/common/image-registry/image-repos/{id}/versions/{version}/accounts 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id，获取方法请参见获取项目ID id 是 Long 镜像仓库id version 是 Integer 版本号 表2 Query参数 参数 是否必选 参数类型 描述 action 是 String 镜像操作动作

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

响应参数 状态码：201 表4 响应Body参数 参数 参数类型 描述 payload IdPayload object 实际返回信息 meta_info MetaInfo object 元数据 表5 IdPayload 参数 参数类型 描述 item Long 资源id 表6 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 镜像仓库名称 scope 是 String 用途 description 否 String 镜像仓库描述 workspaceId 否 String 工作空间id

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