华为云用户手册

  • 请求示例 编辑算子 https://{endpoint}/v1.0/{project_id}/data/processors/10000{ "description" : "this is description", "visibility" : "PRIVATE", "image_repo_id" : 10001, "image_version" : 2, "config" : { "command" : "this is command" }}
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token,通过调用 IAM 服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) Content-Type 是 String 内容类型。填application/json 表3 请求Body参数 参数 是否必选 参数类型 描述 description 否 String 描述 最大长度:256 visibility 否 String 可见范围 枚举值: PRIVATE(私有) PUBLIC(公开) image_repo_id 否 Integer 镜像仓库id。如需修改镜像,image_repo_id需同时传入 最小值:1 image_version 否 Integer 镜像仓库版本号。如需修改镜像,image_repo_id需同时传入 最小值:1 config 否 DataProcessorConfigRequest object 算子配置,更新command参数时,config必传 表4 DataProcessorConfigRequest 参数 是否必选 参数类型 描述 command 是 String 启动命令 最大长度:500
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 count Integer 列表中实例的数量。 next String 下一个分页的查询地址。 previous String 上一个分页的查询地址。 results Array of ScenarioListSrlz objects 仿真场景列表。 表4 ScenarioListSrlz 参数 参数类型 描述 url String 仿真场景的资源地址。 id Integer 仿真场景ID。 created_at Double 创建时间。 最小值:0 updated_at Double 更新时间。 最小值:0 labels Array of LabelBriefSrlz objects 场景标签。场景标签体系为树状结构,按照OpenLABEL标准进行设计。 gen_scenario String 泛化场景资源地址。通过该字段判断仿真场景是否由泛化场景导入,并关联到导入的泛化场景。 road_scenario String 路采场景资源地址。通过该字段判断仿真场景是否由路采场景导入,并关联到导入的路采场景。 simulator String 仿真器,支持VTD和SimPro。 枚举值: VTD SimPro version String 场景对应的OpenSCENARIO版本。 枚举值: vtd v0.9.1 v1.0.0 v1.1.0 v1.1.1 filename String 场景文件名,场景文件为OpenSCENARIO格式。 最大长度:255 map_filename String 地图文件名称,地图文件为OpenDRIVE格式。 最大长度:255 model_filename String 地图文件所关联的3D模型文件名称,当前支持OSGB格式。 最大长度:255 user_id String 用户ID。 最大长度:64 user_name String 用户名。 最大长度:64 name String 场景名称。 最大长度:256 priority Integer 120 - S 100 - A 80 - B 60 - C 40 - D 枚举值: 120 100 80 60 40 status Integer 0 - Released 1 - Available 10 - Initial 11 - Unavailable 12 - Releasing 100 - Deprecated 枚举值: 0 1 10 11 12 100 map String 场景地图资源地址。 model String 场景3D模型资源地址。 source String 场景来源。 枚举值: UPLOAD ROAD GENERALIZATION BUILT_IN 表5 LabelBriefSrlz 参数 参数类型 描述 name String 场景标签名称。 最大长度:64 url String 场景标签资源地址。 id Integer 场景标签ID。 family Integer 场景标签类别。 枚举值: 0 1 2 3 4 root Long 场景标签所在标签树的根标签ID。 最小值:-9223372036854775808 最大值:9223372036854775807 tag_type String 场景标签所属标签树名称。 最大长度:64 parent_names Array of objects 父标签名称。
  • 响应示例 状态码: 200 请求成功 { "count" : 347, "next" : "http://{endpoint}/v2/{project_id}/sim/sm/scenarios/?limit=1&offset=1", "previous" : null, "results" : [ { "url" : "/v2/{project_id}/sim/sm/scenarios/1/", "id" : 1, "created_at" : 1.70071476428303E9, "updated_at" : 1.700714764892153E9, "labels" : [ ], "gen_scenario" : null, "road_scenario" : null, "simulator" : "MySimulator", "version" : "v1.0.0", "filename" : "cutin.xosc", "map_filename" : "city.xodr", "model_filename" : null, "user_id" : "my-userid", "user_name" : "my-username", "name" : "cutin", "priority" : 40, "status" : 0, "map" : "/v2/{project_id}/sim/sm/maps/1/", "model" : null } ]}
  • URI GET /v2/{project_id}/sim/sm/scenarios 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 exclude_group 否 Integer 查询时不包括的场景组。 file 否 String 场景文件。 gen_scenario 否 String 泛化场景的资源地址。 group 否 Array 场景组ID。 id 否 Integer 场景ID。 label 否 Number 标签ID。 map 否 Integer 地图ID。 name 否 String 场景名称。 ordering 否 String 用于排序的字段,查询结果会基于该字段排序。 offset 否 Integer 分页查询的偏移。 limit 否 Integer 分页查询时查询结果数量。 search 否 String 查询条件。 simulator 否 String 仿真器,支持VTD和SimPro。 枚举值: SimPro VTD source 否 String 场景来源,可选项包括: [GENERALIZATION, ROAD, UPLOAD, BUILT_IN],分别表示泛化场景,路采场景,用户自建场景和内置场景。 枚举值: GENERALIZATION ROAD UPLOAD BUILT_IN status 否 Integer 0 - Released 1 - Available 10 - Initial 11 - Unavailable 12 - Releasing 100 - Deprecated 枚举值: 0 1 10 100 11 12 user_name 否 String 用户名 version 否 String vtd - vtd v0.9.1 - v0.9.1 v1.0.0 - v1.0.0 v1.1.0 - v1.1.0 v1.1.1 - v1.1.1 枚举值: v0.9.1 v1.0.0 v1.1.0 v1.1.1 vtd
  • 请求示例 创建场景文件 POST https://{endpoint}/v2/{project_id}/sim/sm/scenarios/{id}/files/{ "sha256" : "0fb50a138fb132be3c794eb423375cca3263fe35a33063c06a4821819ab7fc85", "filename" : "ALKS_Scenario_4.1_1_FreeDriving_TEMPLATE.xosc"}
  • 响应示例 状态码: 201 请求成功 { "url" : "/v2/my_project_id/sim/sm/scenarios/361/files/0fb50a138fb132be3c794eb423375cca3263fe35a33063c06a4821819ab7fc85/", "sha256" : "0fb50a138fb132be3c794eb423375cca3263fe35a33063c06a4821819ab7fc85", "created_at" : 1.699954029767271E9, "updated_at" : 1.699954029767295E9, "post" : { "url" : "my-post-url", "fields" : { "key" : "sim/ifiles/file/0fb50a138fb132be3c794eb423375cca3263fe35a33063c06a4821819ab7fc85.xosc", "x-amz-algorithm" : "AWS4-HMAC-SHA256", "x-amz-credential" : "my-amz-credential", "x-amz-date" : "20231114T092710Z", "policy" : "my-policy", "x-amz-signature" : "my-x-amz-signature" } }, "put_url" : "my-put-url", "get_url" : null, "expire" : 600, "ready" : false, "filename" : "ALKS_Scenario_4.1_1_FreeDriving_TEMPLATE.xosc"}
  • 请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 url 是 String 文件资源地址。 sha256 是 String 文件sha256值。 最小长度:64 最大长度:64 created_at 是 Double 创建时间。 最小值:0 updated_at 是 Double 更新时间。 最小值:0 post 是 post object POST预签链接信息,用于上传文件。 put_url 是 String PUT预签链接地址,用于上传文件。优先使用POST方法上传。 get_url 是 String GET地址,用于下载文件。 expire 是 Integer 默认失效时间为600秒。 缺省值:600 ready 是 Boolean 文件状态。完成文件上传状态为true,未完成文件上传状态为false。 filename 是 String 文件名。 最大长度:255 表3 post 参数 是否必选 参数类型 描述 url 否 String POST预签链接信息,用于上传文件。 fields 否 PostResponseField object POST预签链接信息,调用POST预签链接上传文件时用于构造请求。 表4 PostResponseField 参数 是否必选 参数类型 描述 key 否 String Post预签链接Key字段,在创建请求时需要添加到请求头。 x-amz-algorithm 否 String Post预签链接x-amz-algorithm字段,在创建请求时需要添加到请求头。 x-amz-credential 否 String Post预签链接x-amz-credential字段,在创建请求时需要添加到请求头。 x-amz-date 否 String Post预签链接x-amz-date字段,在创建请求时需要添加到请求头。 policy 否 String Post预签链接policy字段,在创建请求时需要添加到请求头。 x-amz-signature 否 String Post预签链接x-amz-signature字段,在创建请求时需要添加到请求头。
  • 响应参数 状态码: 201 表5 响应Body参数 参数 参数类型 描述 url String 文件资源地址。 sha256 String 文件sha256值。 最小长度:64 最大长度:64 created_at Double 创建时间。 最小值:0 updated_at Double 更新时间。 最小值:0 post post object POST预签链接信息,用于上传文件。 put_url String PUT预签链接地址,用于上传文件。优先使用POST方法上传。 get_url String GET地址,用于下载文件。 expire Integer 默认失效时间为600秒。 缺省值:600 ready Boolean 文件状态。完成文件上传状态为true,未完成文件上传状态为false。 filename String 文件名。 最大长度:255 表6 post 参数 参数类型 描述 url String POST预签链接信息,用于上传文件。 fields PostResponseField object POST预签链接信息,调用POST预签链接上传文件时用于构造请求。 表7 PostResponseField 参数 参数类型 描述 key String Post预签链接Key字段,在创建请求时需要添加到请求头。 x-amz-algorithm String Post预签链接x-amz-algorithm字段,在创建请求时需要添加到请求头。 x-amz-credential String Post预签链接x-amz-credential字段,在创建请求时需要添加到请求头。 x-amz-date String Post预签链接x-amz-date字段,在创建请求时需要添加到请求头。 policy String Post预签链接policy字段,在创建请求时需要添加到请求头。 x-amz-signature String Post预签链接x-amz-signature字段,在创建请求时需要添加到请求头。
  • 请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 url 否 String 文件资源地址。 sha256 否 String 文件sha256值。 created_at 否 Double 最小值:0 updated_at 否 Double 最小值:0 post 否 String POST预签链接信息,用于上传文件。 put_url 否 String PUT预签链接地址,用于上传文件。优先使用POST方法上传。 get_url 否 String GET地址,用于下载文件。 expire 否 Integer 默认失效时间为600秒。 缺省值:600 path 否 String 文件在OBS桶中的路径。 bucket 否 String 文件所在OBS桶。 filename 否 String 文件名。 最大长度:255 ready 否 Boolean 文件状态。完成文件上传状态为true,未完成文件上传状态为false。
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 url String 文件资源地址。 sha256 String 文件sha256值。 created_at Double 创建时间。 最小值:0 updated_at Double 更新时间。 最小值:0 post post object POST预签链接信息,用于上传文件。 put_url String PUT预签链接地址,用于上传文件。优先使用POST方法上传。 get_url String GET地址,用于下载文件。 expire Integer 默认失效时间为600秒。 缺省值:600 path String 文件在OBS桶中的路径。 bucket String 文件所在OBS桶。 filename String 文件名。 最大长度:255 ready Boolean 文件状态。完成文件上传状态为true,未完成文件上传状态为false。 表4 post 参数 参数类型 描述 url String POST预签链接信息,用于上传文件。 fields PostResponseField object POST预签链接信息,调用POST预签链接上传文件时用于构造请求。 表5 PostResponseField 参数 参数类型 描述 key String Post预签链接Key字段,在创建请求时需要添加到请求头。 x-amz-algorithm String Post预签链接x-amz-algorithm字段,在创建请求时需要添加到请求头。 x-amz-credential String Post预签链接x-amz-credential字段,在创建请求时需要添加到请求头。 x-amz-date String Post预签链接x-amz-date字段,在创建请求时需要添加到请求头。 policy String Post预签链接policy字段,在创建请求时需要添加到请求头。 x-amz-signature String Post预签链接x-amz-signature字段,在创建请求时需要添加到请求头。
  • 响应示例 状态码: 200 请求成功 { "url" : "/v2/my_project_id/sim/sm/files/8717ae1874a4b063267211bb575373b7eb73aaa99d6ed531352fff3776dc3a60/", "sha256" : "8717ae1874a4b063267211bb575373b7eb73aaa99d6ed531352fff3776dc3a60", "created_at" : 1.699954027363056E9, "updated_at" : 1.699954028718363E9, "post" : null, "put_url" : null, "get_url" : "my-get-url", "path" : "my-path", "bucket" : "my-bucket", "filename" : "ALKS_Road_straight.xodr", "ready" : true}
  • URI GET /v1.0/{project_id}/data/scenario/segments 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id,获取方法请参见获取项目ID 表2 Query参数 参数 是否必选 参数类型 描述 tag_ids 否 String 标签id集合,最多300个,例:1,2,3 start 否 Long 过滤条件:起始时间,UTC标准时间毫秒时间戳 最小值:1000000000000 最大值:2000000000000 end 否 Long 过滤条件:结束时间,UTC标准时间毫秒时间戳 最小值:1000000000000 最大值:2000000000000 vehicle_name 否 String 过滤条件:车辆名称 最大长度:255 limit 否 Integer 返回个数上限 最小值:1 最大值:200 缺省值:10 offset 否 Integer 查询偏移量 最小值:0 缺省值:0 package_limit 否 Integer 片段所属数据包的返回个数上限,用于按数据包分组时的分页 最小值:1 最大值:200 缺省值:10 package_offset 否 Integer 片段所属数据包的偏移量,用于按数据包分组时的分页 最小值:0 缺省值:0 dpk_id 否 String 过滤条件:数据包id 最大长度:255
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 payload DataScenarioVehicleSegmentsPayload object 实际返回信息 meta_info RespMetaInfo object 元数据 表5 DataScenarioVehicleSegmentsPayload 参数 参数类型 描述 item ScenarioSegments object 场景片段信息 page_info PageInfo object 分页信息 表6 ScenarioSegments 参数 参数类型 描述 segments Array of ScenarioSegment objects 场景片段信息 package_offset Integer 片段所属数据包的偏移量 package_limit Integer 片段所属数据包的返回个数上限 package_total Integer 包含的数据包个数总数 表7 ScenarioSegment 参数 参数类型 描述 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(自定义算子运行数据处理任务生成的场景片段) 表8 PageInfo 参数 参数类型 描述 offset Integer 查询偏移量 limit Integer 返回个数上限 total Integer 资源总数 表9 RespMetaInfo 参数 参数类型 描述 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 请求成功 { "url" : "/v2/my_project_id/sim/sm/files/0fb50a138fb132be3c794eb423375cca3263fe35a33063c06a4821819ab7fc85/", "sha256" : "0fb50a138fb132be3c794eb423375cca3263fe35a33063c06a4821819ab7fc85", "created_at" : 1.699954029767271E9, "updated_at" : 1.699954030498088E9, "post" : null, "put_url" : null, "get_url" : "my-get-url", "path" : "my-path", "bucket" : ",my-bucket", "filename" : "ALKS_Scenario_4.1_1_FreeDriving_TEMPLATE.xosc", "ready" : true}
  • 请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 url 否 String 文件资源地址。 sha256 否 String 文件sha256值。 created_at 否 Double 最小值:0 updated_at 否 Double 最小值:0 post 否 String POST预签链接信息,用于上传文件。 put_url 否 String PUT预签链接地址,用于上传文件。优先使用POST方法上传。 get_url 否 String GET地址,用于下载文件。 expire 否 Integer 默认失效时间为600秒。 缺省值:600 path 否 String 文件在OBS桶中的路径。 bucket 否 String 文件所在OBS桶。 filename 否 String 文件名。 最大长度:255 ready 否 Boolean 文件状态。完成文件上传状态为true,未完成文件上传状态为false。
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 url String 文件资源地址。 sha256 String 文件sha256值。 created_at Double 创建时间。 最小值:0 updated_at Double 更新时间。 最小值:0 post post object POST预签链接信息,用于上传文件。 put_url String PUT预签链接地址,用于上传文件。优先使用POST方法上传。 get_url String GET地址,用于下载文件。 expire Integer 默认失效时间为600秒。 缺省值:600 path String 文件在OBS桶中的路径。 bucket String 文件所在OBS桶。 filename String 文件名。 最大长度:255 ready Boolean 文件状态。完成文件上传状态为true,未完成文件上传状态为false。 表4 post 参数 参数类型 描述 url String POST预签链接信息,用于上传文件。 fields PostResponseField object POST预签链接信息,调用POST预签链接上传文件时用于构造请求。 表5 PostResponseField 参数 参数类型 描述 key String Post预签链接Key字段,在创建请求时需要添加到请求头。 x-amz-algorithm String Post预签链接x-amz-algorithm字段,在创建请求时需要添加到请求头。 x-amz-credential String Post预签链接x-amz-credential字段,在创建请求时需要添加到请求头。 x-amz-date String Post预签链接x-amz-date字段,在创建请求时需要添加到请求头。 policy String Post预签链接policy字段,在创建请求时需要添加到请求头。 x-amz-signature String Post预签链接x-amz-signature字段,在创建请求时需要添加到请求头。
  • 响应示例 状态码: 200 查询成功 { "meta_info" : { "current_time" : "2022-01-01T08:08:29Z" }, "payload" : { "list" : [ { "id" : 10000, "user_id" : "087679f0aa80d32a2f4ec0172f5e902b", "project_id" : "087679f0aa80d32a2f4ec0172f5e902b", "output_type" : "DATA_MARK", "config" : { "command" : "this is command" }, "name" : "processor", "description" : "this is description", "visibility" : "PUBLIC", "create_at" : 1640966400000, "update_at" : 1640966400000, "image_repo_id" : 10000, "image_version" : 1 } ], "page_info" : { "offset" : 0, "limit" : 10, "total" : 1 } }}
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 payload DataProcessorPayload object 实际返回信息 meta_info RespMetaInfo object 元数据 表5 DataProcessorPayload 参数 参数类型 描述 list Array of processorVo objects 算子列表 page_info PageInfo object 分页信息 表6 processorVo 参数 参数类型 描述 id Long id user_id String 用户id project_id String 项目id output_type String 输出类型 枚举值: DATA_MARK(数据标记) OPEN_DATA(数据回放) DATA_SET(数据集) REPLAY_SIM(回放仿真) PLOT_DATA(数据图表) DATA_DESENSITIZATION(数据脱敏) config DataProcessorConfigRequest object 算子配置 name String 名称 description String 描述 visibility String 可见范围 枚举值: PRIVATE(私有) PUBLIC(公开) update_at Long 更新时间,UTC标准时间毫秒时间戳 create_at Long 创建时间,UTC标准时间毫秒时间戳 image_repo_id Integer 镜像仓库id image_version Integer 镜像仓库版本号 表7 DataProcessorConfigRequest 参数 参数类型 描述 command String 启动命令 最大长度:500 表8 PageInfo 参数 参数类型 描述 offset Integer 查询偏移量 limit Integer 返回个数上限 total Integer 资源总数 表9 RespMetaInfo 参数 参数类型 描述 current_time String 请求时间,UTC时间格式,时间为UTC标准时间
  • URI GET /v1.0/{project_id}/data/processors 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id,获取方法请参见获取项目ID 表2 Query参数 参数 是否必选 参数类型 描述 id 否 Long 算子id 最小值:1 name 否 String 算子名称 最大长度:256 output_type 否 Array 输出类型 枚举值: DATA_MARK(数据标记) OPEN_DATA(数据回放) DATA_SET(数据集) REPLAY_SIM(回放仿真) PLOT_DATA(数据图表) DATA_DESENSITIZATION(数据脱敏) limit 否 Integer 返回个数上限 最小值:1 最大值:200 缺省值:10 offset 否 Integer 查询偏移量 最小值:0 缺省值:0 sort 否 String 排序方式 缺省值:UPDATE_DESC(更新时间降序) 枚举值: CREATE_ASC(创建时间升序) CREATE_DESC(创建时间降序) UPDATE_ASC(更新时间升序) UPDATE_DESC(更新时间降序)
  • 响应示例 状态码: 200 查询成功 示例 1 { "meta_info" : { "current_time" : "2022-01-01T08:08:29Z" }, "payload" : { "list" : [ { "id" : 1, "job_id" : 1, "job_type" : "SCENARIO_AUTO_MINING", "data_id" : "DPK0000001", "rank_stamp" : 1640966400000, "project_id" : "087679f0aa80d32a2f4ec0172f5e902b", "resource_spec" : "1Core_4GiB", "priority" : 0, "queue_type" : "INTERNAL" } ], "page_info" : { "offset" : 0, "limit" : 10, "total" : 1 } }} 示例 2 { "meta_info" : { "current_time" : 1640966400000 }, "payload" : { "list" : [ { "id" : 1, "job_id" : 1, "job_type" : "SCENARIO_AUTO_MINING", "data_id" : "DPK0000001", "rank_stamp" : 1640966400000, "project_id" : "087679f0aa80d32a2f4ec0172f5e902b", "resource_spec" : "1Core_4GiB", "priority" : 0, "queue_type" : "INTERNAL" } ], "page_info" : { "offset" : 0, "limit" : 10, "total" : 1 } }}
  • URI GET /v1.0/{project_id}/data/queuing-jobs 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id,获取方法请参见获取项目ID 表2 Query参数 参数 是否必选 参数类型 描述 job_id 否 Long 作业id 最小值:1 output_type 否 String 输出类型 枚举值: DATA_MARK(数据标记) OPEN_DATA(数据回放) DATA_SET(数据集) REPLAY_SIM(回放仿真) PLOT_DATA(数据图表) DATA_DESENSITIZATION(数据脱敏) job_type 否 String 内部作业类型 枚举值: PACKAGE_IMPORT(数据包导入) PACKAGE_DELETE(数据包删除) SCENARIO_AUTO_MINING(场景挖掘) SCENARIO_TO_SIM(转仿真场景) F RAM E_EXTRACT(数据抽帧) SCENARIO_EXTRACT(场景提取) data_id 否 String 数据id 最大长度:64 queue_type 是 String 队列类型 枚举值: PRO CES SOR(算子作业) INTERNAL(内部作业) RESIM(回放仿真作业) DESENSITIZATION(脱敏作业) limit 否 Integer 返回个数上限 最小值:1 最大值:200 缺省值:10 offset 否 Integer 查询偏移量 最小值:0 缺省值:0 processor_name 否 String 算子名称 最大长度:256
  • 请求示例 获取算子作业队列 https://{endpoint}/v1.0/{project_id}/data/queuing-jobs?limit=10&offset=0&queue_type=PROCESSOR 获取内部作业队列 https://{endpoint}/v1.0/{project_id}/data/queuing-jobs?limit=10&offset=0&queue_type=INTERNAL
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 payload DataJobQueuePayload object 实际返回信息 meta_info RespMetaInfo object 元数据 表5 DataJobQueuePayload 参数 参数类型 描述 list Array of jobQueueVo objects 队列列表 page_info PageInfo object 分页信息 表6 jobQueueVo 参数 参数类型 描述 id Long id job_id Long 作业id processor_id Long 算子id(内部作业队列不返回) source String 来源(内部作业队列不返回) processor_name String 算子名称(内部作业队列不返回) job_type String 内部作业类型 枚举值: PACKAGE_IMPORT(数据包导入) PACKAGE_DELETE(数据包删除) SCENARIO_AUTO_MINING(场景挖掘) SCENARIO_TO_SIM(转仿真场景) FRAME_EXTRACT(数据抽帧) SCENARIO_EXTRACT(场景提取) data_id String 数据id output_type String 输出类型(内部作业队列不返回) rank_stamp Long 排序时间戳 project_id String 项目id resource_spec String 资源规格 priority Integer 优先级 queue_type String 队列类型 枚举值: PROCESSOR(算子作业) INTERNAL(内部作业) RESIM(回放仿真作业) DESENSITIZATION(脱敏作业) 表7 PageInfo 参数 参数类型 描述 offset Integer 查询偏移量 limit Integer 返回个数上限 total Integer 资源总数 表8 RespMetaInfo 参数 参数类型 描述 current_time String 请求时间,UTC时间格式,时间为UTC标准时间
  • URI GET /v1.0/{project_id}/data/logs/jobs/{job_id}/{file_name} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id,获取方法请参见获取项目ID job_id 是 Long 作业id 最小值:1 file_name 是 String 日志文件名 表2 Query参数 参数 是否必选 参数类型 描述 start_byte 是 Long 查询起始位置(字节) 最小值:0 end_byte 是 Long 查询结尾位置(字节) 最小值:0
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 payload DataJobLogDetailPayload object 实际返回信息 meta_info RespMetaInfo object 元数据 表5 DataJobLogDetailPayload 参数 参数类型 描述 item DataJobLogDetail object 日志详情 表6 DataJobLogDetail 参数 参数类型 描述 content String 内容 end_byte Long 文件末位字节 表7 RespMetaInfo 参数 参数类型 描述 current_time String 请求时间,UTC时间格式,时间为UTC标准时间
  • 作业管理 表1 作业管理权限 权限 对应API接口 授权项(Action) IAM项目 (Project) 企业项目 (Enterprise Project) 查询作业列表 GET /v1.0/{project_id}/data/jobs octopus:dataJob:list √ √ 创建作业 POST /v1.0/{project_id}/data/jobs octopus:dataJob:create √ √ 批量更新作业 PUT /v1.0/{project_id}/data/jobs octopus:dataJob:update √ √ 批量删除作业 DELETE /v1.0/{project_id}/data/jobs octopus:dataJob:delete √ √ 查询作业详情 GET /v1.0/{project_id}/data/jobs/{id} octopus:dataJob:get √ √ 更新作业 PUT /v1.0/{project_id}/data/jobs/{id} octopus:dataJob:update √ √ 删除作业 DELETE /v1.0/{project_id}/data/jobs/{id} octopus:dataJob:delete √ √ 查询作业日志列表 GET /v1.0/{project_id}/data/jobs/{id}/logs octopus:dataJob:get √ √ 查询作业日志详情 GET /v1.0/{project_id}/data/logs/jobs/{job_id}/{file_name} octopus:dataJob:get √ √ 父主题: 权限和授权项
  • 数据仓库 表1 数据仓库权限 权限 对应API接口 授权项(Action) IAM项目 (Project) 企业项目 (Enterprise Project) 获取数据仓库列表 GET /v1.0/{project_id}/common/warehouses octopus:dataWarehouse:list √ √ 获取数据仓库的数据列表 POST /v1.0/{project_id}/common/warehouses/{data_warehouse_id}/data octopus:dataWarehouse:list √ √ 父主题: 权限和授权项
  • 数据场景 表1 数据场景权限 权限 对应API接口 授权项(Action) IAM项目 (Project) 企业项目 (Enterprise Project) 获取数据场景片段列表 GET /v1.0/{project_id}/data/scenario/segments octopus:dataScenario:list √ √ 创建数据场景片段 POST /v1.0/{project_id}/data/scenario/segments octopus:dataScenario:create √ √ 删除数据场景片段 DELETE /v1.0/{project_id}/data/scenario/segments/{id} octopus:dataScenario:delete √ √ 父主题: 权限和授权项
共99354条