启动实景三维建模任务
功能介绍
该接口用于启动任务。该接口运行成功后,任务状态更新为等待中(PENDING),此时任务添加到启动队列中等待运行资源就绪。资源就绪后任务状态更新为启动中(STARTING),启动成功后任务状态更新为运行中(RUNNING),若启动失败则任务状态更新为启动失败(START_FAILED)。当建模任务类型为有控建模时,为了提升刺点效率需要先对影像进行空三建模。执行空三建模需要设置请求体的“run_AT_only”为“true”,空三建模成功后,任务状态更新为空三建模成功(BUNDLE_SUCCESS)。
任务允许启动的状态为:初始化(INIT)、已停止(STOP_SUCCESS)、运行失败(FAILED)、空三建模成功(BUNDLE_SUCCESS)。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
POST /v1/real3d/{workspace_id}/tasks/{task_id}/start
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
workspace_id |
是 |
String |
工作共享空间ID。 |
task_id |
是 |
String |
任务ID。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
IAM Token信息,用于租户鉴权,该字段由租户请求IAM的Token接口获得。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
run_AT_only |
否 |
Boolean |
是否为进行空三建模的阶段,缺省时为“false”,仅支持有控建模类型任务设置“true”。取值为“true”时表示进行空三建模,建模完成后对应的任务状态为空三建模成功(BUNDLE_SUCCESS)。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
task_id |
String |
任务ID。 |
task_name |
String |
任务名称。 |
task_type |
String |
任务类型。
|
modeling_type |
String |
建模类型。
|
task_description |
String |
任务描述。 |
workspace_id |
String |
任务所属工作共享空间ID。 |
modeling_params |
ModelingParams object |
任务建模参数列表。 |
coordinate_sys |
String |
建模坐标系。 |
has_marker |
Boolean |
是否添加了刺点。 |
folder_code |
String |
任务绑定的倾斜影像的影像code。 |
create_time |
String |
任务创建时间。格式为UTC时间:yyyy-MM-dd'T'HH:mm:ss'Z'。 |
update_time |
String |
任务更新时间。格式为UTC时间:yyyy-MM-dd'T'HH:mm:ss'Z'。 |
tenant_domain_id |
String |
华为云IAM租户账号ID。 |
creator |
String |
任务创建人。 |
latest_operator |
String |
任务最近操作人。 |
task_status |
String |
任务当前状态。
|
complete_stage |
Integer |
建模已完成作业步骤数。 |
total_stage |
Integer |
建模总作业步骤数。 |
task_progress |
String |
任务进度。该字段为字符串表示的保留两位小数的浮点型数值,取值范围:0.00~1.00。 |
exec_start_time |
String |
任务执行开始时间。格式为UTC时间:yyyy-MM-dd'T'HH:mm:ss'Z'。 |
exec_stop_time |
String |
任务执行结束时间。格式为UTC时间:yyyy-MM-dd'T'HH:mm:ss'Z'。 |
fail_message |
String |
失败消息。当任务执行失败时,该字段显示任务的失败原因,用于辅助定位问题。 |
AT_progress |
String |
空三建模进度,取值范围:0.00~1.00。展示有控建模任务空三建模阶段的执行进度。因为空三建模仅在有控建模任务中执行,无控建模任务中该字段取值始终为null。 |
参数 |
参数类型 |
描述 |
---|---|---|
accuracy |
String |
空三精度。取值包括:Highest、High、Medium、Low、Lowest。 缺省值:High |
key_point_limit |
Integer |
空三关键点数量。取值范围:1000~1000000。 缺省值:40000 |
tie_point_limit |
Integer |
空三连接点数量。取值范围:100~100000。 缺省值:4000 |
mesh_accuracy |
Integer |
Mesh重建质量。枚举值:
缺省值:0 |
状态码: 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 |
请求示例
该请求用于启动任务。
POST https://{Endpoint}/v1/real3d/c734a30b6c5f42cfaf49e01eb6903xxx/tasks/914305233ef7428e8073a95d8042fxxx/start { "run_AT_only" : false }
响应示例
状态码: 200
请求成功。
{ "task_id" : "914305233ef7428e8073a95d8042fxxx", "task_name" : "测试任务1685087027834", "task_type" : "REAL3D-UNCTRL", "modeling_type" : "Nerf", "workspace_id" : "c734a30b6c5f42cfaf49e01eb6903xxx", "modeling_params" : { "accuracy" : "High", "key_point_limit" : 40000, "tie_point_limit" : 4000, "center_x_offset" : 0, "center_y_offset" : 0, "center_z_offset" : 0, "mesh_accuracy" : 0, "is_calibration" : true, "blend_intensity" : 0, "compress_accuracy" : 0, "intp_accuracy" : 0 }, "coordinate_sys" : "WGS84-UTM", "has_marker" : false, "folder_code" : "m73MeiI7ztsJpRTaYE3X-YqeZDWfgpxxx", "create_time" : "2023-05-26T07:43:47Z", "update_time" : "2023-05-26T07:55:51Z", "tenant_domain_id" : "xxxx", "creator" : "xxxx", "latest_operator" : "xxxx", "task_status" : "PENDING", "complete_stage" : null, "total_stage" : null, "exec_start_time" : null, "task_progress" : null, "exec_stop_time" : null, "fail_message" : null, "AT_progress" : null }
状态码
状态码 |
描述 |
---|---|
200 |
请求成功。 |
400 |
非法请求。 |
500 |
服务内部错误。 |
错误码
请参见错误码。