创建作业-CreateDataJob
功能介绍
创建作业
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
octopus:dataJob:create
Write
workspace *
-
-
-
URI
POST /v1.0/{project_id}/data/jobs
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,获取方法请参见获取项目ID。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| Content-Type | 是 | String | 参数解释: 内容类型。填application/json 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| data_id | 是 | String | 参数解释: 输入数据id。取值为数据仓库id时表示以数据仓库数据作为作业输入,可以使用warehouse_filters字段对输入数据进行筛选 约束限制: 不涉及 取值范围: 只能由英文字母、数字及“_”、“-”组成,且长度为[1-64]位字符 默认取值: 不涉及 |
| processor_id | 是 | Long | 参数解释: 算子ID 约束限制: 最小值为1 取值范围: 不涉及 默认取值: 不涉及 |
| resource_spec | 是 | String | 参数解释: 资源规格,示例:1Core_4GiB。具体获取方式可参考“查询可用资源规格“接口 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| priority | 否 | Integer | 参数解释: 作业优先级,数值越大优先级越高 约束限制: 最小值为-50,最大值为50 取值范围: 不涉及 默认取值: 0 |
| extend_evs_volume | 否 | ExtendEvsVolume object | 参数解释: 挂载的evs pvc信息 约束限制: 不涉及 |
| 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时,该字段必填 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| capacity | 否 | Long | 参数解释: EVS卷存储大小(GB) 约束限制: 不涉及 取值范围: 10-32768 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| 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 integers | 参数解释: 按标签筛选,多个标签取交集 约束限制: 标签最多5个 |
| or_tags | 否 | Array of integers | 参数解释: 按标签筛选,多个标签取并集 约束限制: 标签最多5个 |
| and_custom_attributes | 否 | Array of strings | 参数解释: 按自定义属性筛选,多个属性取交集 约束限制: 自定义属性最多5个 |
| or_custom_attributes | 否 | Array of strings | 参数解释: 按自定义属性筛选,多个属性取并集 约束限制: 自定义属性最多5个 |
| file_types | 否 | Array of strings | 参数解释: 文件类型列表 约束限制: 文件类型最多10个 |
响应参数
状态码:201
| 参数 | 参数类型 | 描述 |
|---|---|---|
| payload | payloadWithSingleNumber object | 参数解释: 实际返回信息 |
| meta_info | RespMetaInfo object | 参数解释: 元数据 |
请求示例
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"
} 响应示例
状态码:201
创建成功,返回作业id
{
"meta_info" : {
"current_time" : "2022-01-01T08:08:29Z"
},
"payload" : {
"item" : 1
}
} 状态码
| 状态码 | 描述 |
|---|---|
| 201 | 创建成功,返回作业id |
| 400 | 请求参数错误 |
| 403 | 权限校验失败 |
| 500 | 系统内部错误 |
错误码
请参见错误码。