停止实景三维建模任务
功能介绍
可停止任务状态为等待中(PENDING)、启动中(STARTING)或者运行中(RUNNING)的任务。
等待中(PENDING)的任务执行停止后将更新为初始化(INIT)状态。
启动中(STARTING)和正在运行(RUNNING)的任务执行停止后将更新为停止中(STOPPING)状态,并且在停止完成后更新为已停止(STOP_SUCCESS)状态。
![](https://support.huaweicloud.com/api-koomap/public_sys-resources/note_3.0-zh-cn.png)
调用该接口需要传递空请求体“{}”。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
POST /v1/real3d/{workspace_id}/tasks/{task_id}/stop
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
task_id |
是 |
String |
实景三维任务ID。 |
workspace_id |
是 |
String |
工作共享空间ID。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
IAM Token信息,用于租户鉴权,该字段由租户请求IAM的Token接口获得。 |
响应参数
状态码: 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/stop { }
响应示例
状态码: 200
请求成功。
true
状态码
状态码 |
描述 |
---|---|
200 |
请求成功。 |
400 |
非法请求。 |
500 |
服务内部错误。 |
错误码
请参见错误码。