创建内部作业-CreateSystemJob
功能介绍
创建内部作业
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
octopus:dataJob:create
Write
workspace *
-
-
-
URI
POST /v1.0/{project_id}/data/system-jobs
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,获取方法请参见获取项目ID。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| Content-Type | 是 | String | 参数解释: 内容类型。填application/json 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| type | 是 | String | 参数解释: 作业类型 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
| frame_extract_config | 否 | DataFrameExtractJobConfig object | 参数解释: 抽帧作业参数 约束限制: 作业类型是FRAME_EXTRACT时该字段必填 |
| scenario_mining_req | 否 | DataScenarioMiningJobRequest object | 参数解释: 场景挖掘作业参数 约束限制: 作业类型是SCENARIO_AUTO_MINING时该字段必填 |
| workspace_id | 是 | String | 参数解释: 工作空间ID 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| 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 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| topics | 是 | Array of strings | 参数解释: 抽帧topic列表 约束限制: 仅限对应数据包内lidar和camera类型的topic,最多10个 |
响应参数
状态码:201
| 参数 | 参数类型 | 描述 |
|---|---|---|
| payload | payloadWithSingleNumber object | 参数解释: 实际返回信息 |
| meta_info | RespMetaInfo object | 参数解释: 元数据 |
请求示例
-
POST 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" ] } } -
POST https://{endpoint}/v1.0/{project_id}/data/system-jobs { "type" : "SCENARIO_AUTO_MINING", "scenario_mining_req" : { "data_id" : "DPK0000001" } }
响应示例
状态码:201
创建成功,返回作业id
{
"meta_info" : {
"current_time" : "2022-01-01T08:08:29Z"
},
"payload" : {
"item" : 10
}
} 状态码
| 状态码 | 描述 |
|---|---|
| 201 | 创建成功,返回作业id |
| 400 | 请求参数错误 |
| 403 | 权限校验失败 |
| 500 | 系统内部错误 |
错误码
请参见错误码。