新建任务
功能介绍
在工作共享空间内新建数据处理任务,新建任务的“成果影像名称”参数可从“校验原始影像文件”接口中获取。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
POST /v1/kmp-control/tasks
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
IAM Token信息,用于租户鉴权,该字段由租户请求IAM的Token接口获得。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
task_name |
是 |
String |
任务名称,支持中英文、数字和“_”,长度为[1,50]。 最小长度:1 最大长度:50 |
task_type |
是 |
String |
任务类型,当前仅支持ORSIP(卫星影像生产)。 |
workspace_id |
是 |
String |
任务所属工作共享空间ID。 最小长度:32 最大长度:32 |
data_ids |
是 |
Array of strings |
待处理影像文件ID列表。 |
shape_id |
否 |
String |
矢量数据文件ID,“isClip”为“1”时必填。 最小长度:32 最大长度:32 |
production_level |
是 |
String |
任务输出结果影像级别,当前支持以下级别: L2、L3、L4、L5。 |
task_description |
否 |
String |
任务描述,支持中英文、数字和“_”,长度为[0,255]。 最小长度:0 最大长度:255 |
data_alias |
是 |
Map<String,String> |
成果影像别名。 key从“校验原始影像文件”接口获取。
|
coordination |
是 |
String |
成果影像坐标。 |
data_description |
是 |
Map<String,String> |
成果影像描述。 |
csv_ids |
是 |
Array of strings |
生产资料(csv文件)ID。 |
isClip |
是 |
String |
是否为矢量切割。
|
isTile |
是 |
String |
是否为金字塔切割。
|
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
task_id |
String |
任务唯一标识ID。 最小长度:32 最大长度:36 |
workspace_id |
String |
工作共享空间ID。 |
data_id |
String |
数据ID。 |
task_name |
String |
任务名称。 最小长度:2 最大长度:64 |
creator |
String |
创建者ID。 最小长度:2 最大长度:512 |
create_time |
String |
创建时间。 |
task_status |
String |
任务状态。包括INIT(初始化)、RUNNING(运行中)、SUCCESS(执行成功)、ARCHIVED(已归档)、FAILED(执行失败)、STOPPING(停止中)、STOP_SUCCESS(已停止)、STOP_FAILED(停止失败)、START_RUNNING(等待中)。 |
task_type |
String |
任务类型。 当前仅支持ORSIP(卫星影像生产)。 |
task_description |
String |
任务描述。 |
exec_start_time |
String |
开始操作时间。 缺省值:null |
exec_stop_time |
String |
停止操作时间。 缺省值:null |
origin_data_alias |
String |
原始数据别名。 |
production_level |
String |
任务输出结果影像级别,当前支持以下级别: L2、L3、L4、L5。 |
task_progress |
String |
任务执行进度。 |
shape_id |
String |
矢量数据文件ID,“isClip”为“1”时必填。 |
is_deleted |
Integer |
是否删除。
|
image_url |
String |
影像链接。 |
domain_id |
String |
华为云IAM租户账号ID。 |
fail_message |
String |
任务失败原因。 |
frozen_tag |
String |
任务冻结状态。当前仅支持frozen(冻结中)。 |
isClip |
String |
是否为矢量切割。
|
isTile |
String |
是否为金字塔切割。
|
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。格式为:KMP.XXXXXXXX,其中X表示数字。 最小长度:12 最大长度:12 |
error_msg |
String |
错误描述。 最小长度:2 最大长度:512 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。格式为:KMP.XXXXXXXX,其中X表示数字。 最小长度:12 最大长度:12 |
error_msg |
String |
错误描述。 最小长度:2 最大长度:512 |
请求示例
新建处理任务,目前只支持卫星影像处理任务(ORSIP)。
POST https://{Endpoint}/v1/kmp-control/tasks { "task_name": "这是任务描述", "task_type": "ORSIP", "data_ids": [ "ed9313d537dd4cf7a6a7758f9xxxxd84", "8dc0d6187b8e4f429c2d20d34xxxxx5a" ], "production_level": "L2", "task_description": "这是任务描述", "workspace_id": "dfa3527b45a24de6a2d0ddbcb8xxxxxx", "shape_id": null, "data_alias": { "JL1_20160112_203_0018_L2": "JL1_20160112_203_0018_L2" }, "coordination": "WGS84", "data_description": { "JL1_20160112_203_0018_L2": null }, "csv_ids": [3cd09e0xbf7949a59c9ec14012a4xxxx], "is_clip": "0", "is_tile": "0" }
响应示例
状态码: 200
请求成功。
{ "task_id" : "4d40e927514a40898d23a20155xxxxxx", "workspace_id" : "dfa3527b45a24de6a2d0ddbcb8xxxxxx", "data_id" : "[\"ed9313d537dd4cf7a6a7758f942xxxxx\",\"8dc0d6187b8e4f429c2d20d340xxxxxa\"]", "task_name" : "测试", "domain_id" : "234602bf93714dcba145eaa45xxxxxxx", "creator" : "xxxxx", "create_time" : "2023-02-17T09:27:07Z", "task_status" : "INIT", "task_type" : "ORSIP", "task_description" : "测试", "exec_start_time" : null, "exec_stop_time" : null, "origin_data_alias" : null, "production_level" : "L2", "task_progress" : "0.0", "shape_id" : null, "is_deleted" : 0, "image_url" : null, "frozen_tag" : null, "is_clip" : "0", "is_tile" : "0" }
状态码
状态码 |
描述 |
---|---|
200 |
请求成功。 |
400 |
非法请求。 |
500 |
服务内部错误。 |
错误码
请参见错误码。