华为云用户手册

  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 workspace_id String 统计的工作共享空间ID。 total_count Integer 任务总数。 running_count Integer 运行中数量。 success_count Integer 成功数量。 failed_count Integer 失败数量。 archived_count Integer 已归档数量。 状态码: 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码。格式为:KMP.XXXXXXXX,其中X表示数字。 最小长度:12 最大长度:12 error_msg String 错误描述。 最小长度:2 最大长度:512 状态码: 500 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。格式为:KMP.XXXXXXXX,其中X表示数字。 最小长度:12 最大长度:12 error_msg String 错误描述。 最小长度:2 最大长度:512
  • 功能介绍 该接口用于展示工作共享空间内任务的概览信息。包含: 任务总数(total_count):在该空间内已创建的实景三维任务数量。 运行中数量(running_count):在该空间内正在运行的实景三维任务数量,包含的任务状态有PENDING、STARTING、RUNNING、STOPPING。 成功数量(success_count):在该空间内执行成功的任务数量,包含的任务状态有SUCCESS、STOP_SUCCESS。 失败数量(failed_count):在该空间内执行失败的任务数量,包含的任务状态有START_FAILED、FAILED。 已归档数量(archived_count):在该空间内已归档的任务数量,包含的任务状态有ARCHIVED。
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 total Integer 空间下任务总数。 缺省值:0 finished Integer 空间下已处理完成任务,已归档任务总数量。 缺省值:0 unfinished Integer 空间下执行中任务数量。 缺省值:0 状态码: 400 表4 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID,用于运维人员定位请求日志。 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。格式为:KMP.XXXXXXXX,其中X表示数字。 最小长度:12 最大长度:12 error_msg String 错误描述。 最小长度:2 最大长度:512 状态码: 500 表6 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID,用于运维人员定位请求日志。 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。格式为:KMP.XXXXXXXX,其中X表示数字。 最小长度:12 最大长度:12 error_msg String 错误描述。 最小长度:2 最大长度:512
  • 修订记录 发布日期 修订记录 2024-05-17 第八次公测发布。 API概览:增加实景三维精修后处理任务功能相关的API接口描述。 增加实景三维精修后处理任务管理章节。 查询实景三维用量:刷新该接口的功能介绍。 增加查询实景三维精修后处理成果数据列表和删除实景三维精修后处理成果数据接口。 错误码:增加实景三维生产服务精修后处理任务功能的相关错误码。 2023-12-28 第七次公测发布。 API概览:增加实景三维生产服务的API接口说明。 认证鉴权:Token认证增加实景三维生产服务相关说明。 增加实景三维任务管理、实景三维精修后处理任务管理、实景三维用量统计和实景三维刺点管理章节。 错误码:增加实景三维生产服务的错误码。 2023-11-17 第六次公测发布。 API概览:修改API接口说明。 构造请求:修改了示例的URI以及URI的示意图。 返回结果:修改响应消息体示例以及相关描述。 所有接口增加“调试”章节。 错误码:增加卫星影像生产服务的错误码。 2023-07-03 第五次公测发布。 更新工作共享空间: 请求参数和请求示例增加“workspace_id”字段。 修改URI路径。 删除工作共享空间:修改功能介绍、URI路径、请求示例。 新建任务和查询任务: 修改“production_level”和“shape_id”字段描述。 响应参数、响应示例新增“frozen_tag”字段的相关内容。 查看任务概览:修改响应示例。 启动任务、停止任务、归档/取消归档任务以及删除任务: 修改URI路径。 增加请求示例。 校验原始影像文件:修改“production_level”字段描述。 查询卫星影像基本信息:修改“image_level”和“image_levels”字段描述。 2023-04-27 第四次公测发布。 API概览:新增AR地图运行服务基础版接口。 认证鉴权:增加认证鉴权方式。 AR地图运行服务基础版:新增AR地图运行服务基础版章节。 错误码:新增错误码章节。 2023-03-10 第三次公测发布。 卫星影像生产服务API接口有如下更新: 新建任务: 请求参数增加“data_description”和“csv_ids”字段。 “production_level”字段增加L3影像处理等级相关描述。 修改响应示例和请求示例。 查询任务: “task_status”参数类型由String类型修改为Array类型。 “production_level”字段增加L3影像处理等级相关描述。 校验原始影像文件:“production_level”字段增加L3影像处理等级相关描述。 查询用量: 功能介绍中增加生产资料、L3影像处理级别的用量统计。 “usage_measure_name”和“usage_subtype”字段增加L3影像处理等级的相关描述。 查询卫星影像基本信息:“image_level”和“image_levels”字段增加L3影像处理等级的相关描述。 2023-01-11 第二次公测发布。 卫星影像生产服务API接口有如下更新: 新建任务和查询任务修改了“task_status”字段的描述。 校验原始影像文件:修改了响应参数和响应示例。 查询卫星影像基本信息:修改了“image_status”字段的描述。 2022-12-27 第一次公测发布。
  • 请求方法 HTTP请求方法(也称为操作或动词),它告诉服务你正在请求什么类型的操作。 表2 HTTP方法 方法 说明 GET 请求服务器返回指定资源。 POST 请求服务器新增资源或执行non-CRUD操作。 DELETE 请求服务器删除指定资源,如删除对象等。 PUT 请求服务器更新指定资源。 在创建工作共享空间的URI部分,您可以看到其请求方法为“POST”,则其请求为: POST https://koomap.cn-north-4.myhuaweicloud.com/v1/workspaces
  • 请求消息头 附加请求头字段,如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”,请求鉴权信息等。 详细的公共请求消息头字段请参见表3。 表3 公共请求消息头 名称 描述 是否必选 示例 Content-Type 消息体的类型(格式),当前只支持application/json。 是 application/json X-Auth-Token 用户Token。 用户Token也就是调用获取用户Token接口的响应值,该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头(Headers)中包含的“X-Subject-Token”的值即为Token值。 是 使用Token认证时该字段必选。 注:以下仅为Token示例片段 MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ
  • 请求消息体(可选) 该部分可选。请求消息体通常以结构化格式(如JSON或XML)发出,与请求消息头中Content-Type对应,传递除请求消息头之外的内容。若请求消息体中的参数支持中文,则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),GET、DELETE操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。 对于创建工作共享空间接口,您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示。 POST https://koomap.cn-north-4.myhuaweicloud.com/v1/workspaces Content-Type: application/json X-Auth-Token:xxxxxxxx { "workspace_name" : "工作共享空间名称", "workspace_description" : "这是描述" } 到这里为止这个请求需要的内容就具备齐全了,您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于获取用户Token接口,返回的响应消息头中“x-subject-token”就是需要获取的用户Token。有了Token之后,您就可以使用Token认证调用其他API。
  • 请求URI 请求URI由如下部分组成: {URI-scheme}://{Endpoint}/{resource-path}?{query-string} 尽管请求URI包含在请求消息头中,但大多数语言或框架都要求您从请求消息中单独传递它,所以在此单独强调。 表1 URI中的参数说明 参数 描述 URI-scheme 表示用于传输请求的协议,当前KooMap所有API均采用HTTPS协议。 Endpoint 指定承载REST服务端点的服务器域名或IP,不同服务不同区域的Endpoint不同,当前KooMap只在“华北-北京四”部署,Endpoint为“koomap.cn-north-4.myhuaweicloud.com”。 resource-path 资源路径,即API访问路径。从具体API的URI模块获取,例如“创建工作共享空间”API的resource-path为“/v1/workspaces”。 query-string 可选参数,用于查询指定参数数据。设置查询参数时,查询参数前面需要带一个“?”,形式为“参数名=参数取值”,例如“?limit=10”,表示查询不超过10条数据。 例如您需要获取KooMap在“华北-北京四”区域的Token,则需使用“华北-北京四”区域的Endpoint(koomap.cn-north-4.myhuaweicloud.com),并在创建工作共享空间的URI部分找到resource-path(/v1/workspaces),拼接起来如下所示。 https://koomap.cn-north-4.myhuaweicloud.com/v1/workspaces 图1 URI示意图 为查看方便,在每个具体API的URI部分,只给出resource-path部分,并将请求方法写在一起。这是因为URI-scheme都是HTTPS,而Endpoint在同一个区域也相同,所以简洁起见将这两部分省略。
  • 响应参数 状态码: 400 表3 响应Body参数 参数 参数类型 描述 error_code String 错误码。格式为:KMP.XXXXXXXX,其中X表示数字。 最小长度:12 最大长度:12 error_msg String 错误描述。 最小长度:2 最大长度:512 状态码: 500 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码。格式为:KMP.XXXXXXXX,其中X表示数字。 最小长度:12 最大长度:12 error_msg String 错误描述。 最小长度:2 最大长度:512
  • 响应示例 状态码: 200 请求成功。 { "task_id" : "914305233ef7428e8073a95d8042fxxx", "task_name" : "测试任务1685087027834", "task_type" : "REAL3D-UNCTRL", "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-26T08:00:00Z", "tenant_domain_id" : "xxxx", "creator" : "xxxx", "latest_operator" : "xxxx", "task_status" : "ARCHIVED", "complete_stage" : 10, "total_stage" : 10, "exec_start_time" : "2023-05-26T07:57:00Z", "task_progress" : "1.00", "exec_stop_time" : "2023-05-26T08:00:00Z", "fail_message" : null, "AT_progress" : null }
  • 请求示例 该请求对运行成功的任务进行归档。 POST https://{Endpoint}/v1/real3d/c734a30b6c5f42cfaf49e01eb6903xxx/tasks/914305233ef7428e8073a95d8042fxxx/archive { "archive" : true } 该请求对已归档的任务进行取消归档。 https://{endpoint}/v1/real3d/c734a30b6c5f42cfaf49e01eb6903xxx/tasks/914305233ef7428e8073a95d8042fxxx/archive { "archive" : false }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 task_id String 任务ID。 task_name String 任务名称。 task_type String 任务类型。 REAL3D-UNCTRL(无控建模) REAL3D-CTRL(有控建模) modeling_type String 建模类型。 Mesh:纹理模型实景三维建模。 Nerf:显式辐射场实景三维建模。 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 任务当前状态。 INIT(初始化) PENDING(等待中) STARTING(启动中) START_FAILED(启动失败) RUNNING(运行中) SUCCESS(运行成功) FAILED(运行失败) STOPPING(停止中) STOP_SUCCESS(已停止) ARCHIVED(已归档) BUNDLE_SUCCESS(空三建模成功) 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。 表5 ModelingParams 参数 参数类型 描述 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:高 1:中 2:低 缺省值:0 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。格式为:KMP.XXXXXXXX,其中X表示数字。 最小长度:12 最大长度:12 error_msg String 错误描述。 最小长度:2 最大长度:512 状态码: 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。格式为:KMP.XXXXXXXX,其中X表示数字。 最小长度:12 最大长度:12 error_msg String 错误描述。 最小长度:2 最大长度:512
  • 响应参数 状态码: 400 表3 响应Body参数 参数 参数类型 描述 error_code String 错误码。格式为:KMP.XXXXXXXX,其中X表示数字。 最小长度:12 最大长度:12 error_msg String 错误描述。 最小长度:2 最大长度:512 状态码: 500 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码。格式为:KMP.XXXXXXXX,其中X表示数字。 最小长度:12 最大长度:12 error_msg String 错误描述。 最小长度:2 最大长度:512
  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String IAM Token信息,用于租户鉴权,该字段由租户请求IAM的Token接口获得。 表2 请求Body参数 参数 是否必选 参数类型 描述 workspace_name 是 String 工作共享空间名称。支持中文、英文、数字以及“_”字符,长度限制2~50个字符。 workspace_description 否 String 工作共享空间描述。支持中文、英文、数字以及“_”字符,长度限制200个字符以内。
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 workspace_id String 工作共享空间ID。 workspace_name String 工作共享空间名称。 workspace_description String 工作共享空间描述。 tenant_domain_id String 华为云IAM租户账号ID。 creator String 创建人。 latest_operator String 最近修改人。 create_time String 创建时间。返回UTC时间格式字符串,格式为yyyy-MM-dd'T'HH:mm:ss'Z'。 update_time String 更新时间。返回UTC时间格式字符串,格式为yyyy-MM-dd'T'HH:mm:ss'Z'。 star Integer 工作共享空间是否置顶显示(最多可置顶4个)。 can_delete Boolean 工作共享空间是否允许删除标志位。当工作共享空间置顶显示或者该空间下存在任务时,取值为“true”,表示不可以删除。 状态码: 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码。格式为:KMP.XXXXXXXX,其中X表示数字。 最小长度:12 最大长度:12 error_msg String 错误描述。 最小长度:2 最大长度:512 状态码: 500 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。格式为:KMP.XXXXXXXX,其中X表示数字。 最小长度:12 最大长度:12 error_msg String 错误描述。 最小长度:2 最大长度:512
  • 响应示例 状态码: 200 请求成功。 { "workspace_id" : "3eceb0cb8b834f5bb0a66d4108c2067f", "workspace_name" : "测试空间", "workspace_description" : "空间描述", "creator" : "xxxx", "latest_operator" : "xxxx", "create_time" : "2023-05-23T07:26:28Z", "update_time" : "2023-05-23T07:26:28Z", "star" : 0, "can_delete" : false }
  • URI POST /v1/real3d/{workspace_id}/tasks/{task_id}/subtasks/{subtask_id}/start 表1 路径参数 参数 是否必选 参数类型 描述 workspace_id 是 String 工作共享空间ID。 task_id 是 String 原始实景三维建模任务ID。 subtask_id 是 String 实景三维精修后处理任务ID。
  • 响应示例 状态码: 200 请求成功。 { "subtask_id" : "914305233ef7428e8073a95d8042fxxx", "task_id" : "914305233ef7428e8073a95d8042fxxx", "subtask_name" : "精修后处理任务别名", "task_name" : "测试任务1685087027834", "workspace_id" : "c734a30b6c5f42cfaf49e01eb6903xxx", "modeling_params" : { "accuracy" : "High", "key_point_limit" : "40000", "tie_point_limit" : "4000", "mesh_accuracy" : "0" }, "subtask_status" : "INIT", "model_path" : "obs://real3d/real3d/xxx", "refine_product_id" : "914305233ef7428e8073a95d8042fxxx", "create_time" : "2023-05-26T07:43:47Z", "update_time" : "2023-05-26T07:52:58Z", "tenant_domain_id" : "xxxx", "creator" : "xxxx", "latest_operator" : "xxxx", "subtask_progress" : null, "exec_start_time" : null, "exec_stop_time" : null, "fail_message" : null }
  • 功能介绍 该接口用于启动精修后处理任务。该接口运行成功后,任务状态更新为等待中(PENDING),此时任务添加到启动队列中等待运行资源就绪,资源就绪后状态更新为启动中(STARTING),启动成功后状态更新为运行中(RUNNING),若启动失败则状态更新为启动失败(START_FAILED)。 精修后处理任务允许启动的状态为:上传成功(UPLOAD_SUCCESS)、已停止(STOP_SUCCESS)、运行失败(FAILED)。
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 subtask_id String 实景三维精修后处理任务ID。 task_id String 原始实景三维建模任务ID。 subtask_name String 精修后处理任务别名。 task_name String 原始实景三维建模任务名称。 workspace_id String 原始实景三维建模任务所属工作共享空间ID。 modeling_params ModelingParams object 原始实景三维建模任务建模参数列表。 subtask_status String 实景三维精修后处理任务当前状态。 INIT(初始化) UPLOADING(上传中) UPLOAD_SUCCESS(上传成功) UPLOAD_FAILED(上传失败) PENDING(等待中) STARTING(启动中) START_FAILED(启动失败) RUNNING(运行中) SUCCESS(运行成功) FAILED(运行失败) STOPPING(停止中) STOP_SUCCESS(已停止) model_path String 模型数据上传路径。 refine_product_id String 精修后处理任务成果数据ID。 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 精修后处理任务最近操作人。 subtask_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 失败消息。当精修后处理任务执行失败时,该字段显示任务的失败原因,用于辅助定位问题。 表4 ModelingParams 参数 参数类型 描述 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:高 1:中 2:低 缺省值:0 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。格式为:KMP.XXXXXXXX,其中X表示数字。 最小长度:12 最大长度:12 error_msg String 错误描述。 最小长度:2 最大长度:512 状态码: 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。格式为:KMP.XXXXXXXX,其中X表示数字。 最小长度:12 最大长度:12 error_msg String 错误描述。 最小长度:2 最大长度:512
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 subtask_id String 实景三维精修后处理任务ID。 task_id String 原始实景三维建模任务ID。 subtask_name String 精修后处理任务别名。 task_name String 原始实景三维建模任务名称。 workspace_id String 原始实景三维建模任务所属工作共享空间ID。 modeling_params ModelingParams object 原始实景三维建模任务建模参数列表。 subtask_status String 实景三维精修后处理任务当前状态。 INIT(初始化) UPLOADING(上传中) UPLOAD_SUCCESS(上传成功) UPLOAD_FAILED(上传失败) PENDING(等待中) STARTING(启动中) START_FAILED(启动失败) RUNNING(运行中) SUCCESS(运行成功) FAILED(运行失败) STOPPING(停止中) STOP_SUCCESS(已停止) model_path String 模型数据上传路径。 refine_product_id String 精修后处理任务成果数据ID。 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 精修后处理任务最近操作人。 subtask_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 失败消息。当精修后处理任务执行失败时,该字段显示任务的失败原因,用于辅助定位问题。 表5 ModelingParams 参数 参数类型 描述 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:高 1:中 2:低 缺省值:0 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。格式为:KMP.XXXXXXXX,其中X表示数字。 最小长度:12 最大长度:12 error_msg String 错误描述。 最小长度:2 最大长度:512 状态码: 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。格式为:KMP.XXXXXXXX,其中X表示数字。 最小长度:12 最大长度:12 error_msg String 错误描述。 最小长度:2 最大长度:512
  • 响应示例 状态码: 200 请求成功。 { "subtask_id" : "914305233ef7428e8073a95d8042fxxx", "task_id" : "aaaaa30b6c5f42cfaf49e01eb690xyyy", "subtask_name" : "精修后处理任务别名", "task_name" : "测试任务1685087027834", "workspace_id" : "c734a30b6c5f42cfaf49e01eb6903xxx", "modeling_params" : { "accuracy" : "High", "key_point_limit" : "40000", "tie_point_limit" : "4000", "mesh_accuracy" : "0" }, "subtask_status" : "INIT", "model_path" : "obs://real3d/real3d/xxx", "refine_product_id" : "914305233ef7428e8073a95d8042fxxx", "create_time" : "2023-05-26T07:43:47Z", "update_time" : "2023-05-26T07:52:58Z", "tenant_domain_id" : "xxxx", "creator" : "xxxx", "latest_operator" : "xxxx", "subtask_progress" : null, "exec_start_time" : null, "exec_stop_time" : null, "fail_message" : null }
  • 功能介绍 查询实景三维精修后处理成果的数据列表。支持的过滤参数: refine_product_id:精修后处理成果数据ID。 task_name:原始实景三维建模任务名称。 subtask_name:精修后处理任务别名。 subtask_create_time_from:精修后处理任务创建起始时间,为UTC时间格式字符串,格式为yyyy-MM-dd'T'HH:mm:ss'Z'。 subtask_create_time_to:精修后处理任务创建截止时间,为UTC时间格式字符串,格式为yyyy-MM-dd'T'HH:mm:ss'Z'。 subtask_completed_time_from:精修后处理任务完成起始时间,为UTC时间格式字符串,格式为yyyy-MM-dd'T'HH:mm:ss'Z'。 subtask_completed_time_to:精修后处理任务完成截止时间,为UTC时间格式字符串,格式为yyyy-MM-dd'T'HH:mm:ss'Z'。 offset:分页参数,偏移量,缺省值为0。 limit:分页参数,每页数量,缺省值为10。 order_by:排序参数,支持task_name_asc(原始任务名称增序)、task_name_desc(原始任务名称降序)、subtask_name_asc(后处理任务别名增序)、subtask_name_desc(后处理任务别名降序)。
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 refine_products Array of Real3DRefineProductVO objects 精修后处理成果数据对象列表。 page Page object 分页信息。 表4 Real3DRefineProductVO 参数 参数类型 描述 id String 精修后处理成果数据ID。 name String 精修后处理成果数据名称。 status String 精修后处理成果数据状态。 preparing:准备中。处于该状态表示成果数据正在准备,需要在该状态后才能下载、删除。 available: 可用。处于该状态时成果数据可以下载、删除。 deleting:删除中。成果数据正在删除。 subtask_info Real3DRefineProductRelateSubTaskVO object 关联精修后处理任务信息。 task_info Real3DRefineProductRelateTaskVO object 关联原始任务信息。 product_details Array of Real3DRefineProductDetailVO objects 精修后处理成果数据详情。 storage_size_byte Double 精修后处理成果数据占用存储空间大小(字节)。 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。 表5 Real3DRefineProductRelateSubTaskVO 参数 参数类型 描述 subtask_name String 精修后处理任务别名。 subtask_id String 精修后处理任务ID。 create_time String 精修后处理任务创建时间。格式为UTC时间:yyyy-MM-dd'T'HH:mm:ss'Z'。 completed_time String 精修后处理任务完成时间。格式为UTC时间:yyyy-MM-dd'T'HH:mm:ss'Z'。 表6 Real3DRefineProductRelateTaskVO 参数 参数类型 描述 task_id String 原始实景三维建模任务ID。 task_name String 原始实景三维建模任务名称。 workspace_id String 关联工作共享空间ID。 task_params String 原始实景三维建模任务参数。 task_exec_start_time String 原始实景三维建模任务执行开始时间。格式为UTC标准时间:yyyy-MM-dd'T'HH:mm:ss'Z'。 task_exec_end_time String 原始实景三维建模任务执行结束时间。格式为UTC标准时间:yyyy-MM-dd'T'HH:mm:ss'Z'。 表7 Real3DRefineProductDetailVO 参数 参数类型 描述 type String 文件类型。nerf_osgb: 输出三维预览OSGB文件。 storage_size_byte Double 文件占用存储空间大小(字节)。 files Array of strings 文件列表。 表8 Page 参数 参数类型 描述 offset Integer 偏移量,表示从第几条数据开始查询。 limit Integer 每页包含的查询记录数量。 total Integer 符合查询条件的记录总数。 状态码: 400 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。格式为:KMP.XXXXXXXX,其中X表示数字。 最小长度:12 最大长度:12 error_msg String 错误描述。 最小长度:2 最大长度:512 状态码: 500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码。格式为:KMP.XXXXXXXX,其中X表示数字。 最小长度:12 最大长度:12 error_msg String 错误描述。 最小长度:2 最大长度:512
  • URI GET /v1/real3d/refineproducts 表1 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 偏移量。 最小值:0 最大值:2147483647 缺省值:0 limit 否 Integer 分页大小。 最小值:1 最大值:100 缺省值:10 refine_product_id 否 String 精修后处理成果数据ID。 task_name 否 String 原始实景三维建模任务名称。 subtask_name 否 String 精修后处理任务别名。 subtask_create_time_from 否 String 精修后处理任务创建起始时间,为UTC时间格式字符串,格式为yyyy-MM-dd'T'HH:mm:ss'Z'。 subtask_create_time_to 否 String 精修后处理任务创建截止时间,为UTC时间格式字符串,格式为yyyy-MM-dd'T'HH:mm:ss'Z'。 subtask_completed_time_from 否 String 精修后处理任务完成起始时间,为UTC时间格式字符串,格式为yyyy-MM-dd'T'HH:mm:ss'Z'。 subtask_completed_time_to 否 String 精修后处理任务完成截止时间,为UTC时间格式字符串,格式为yyyy-MM-dd'T'HH:mm:ss'Z'。 order_by 否 String 排序参数,支持task_name_asc(原始实景三维建模任务名称增序)、task_name_desc(原始实景三维建模任务名称降序)、subtask_name_asc(精修后处理任务别名增序)、subtask_name_desc(精修后处理任务别名降序)。
  • 功能介绍 该接口用于停止状态为等待中(PENDING)、启动中(STARTING)或者运行中(RUNNING)的精修后处理任务。任务停止后,状态更新规则如下: 等待中(PENDING)的精修后处理任务执行停止后将更新为上传成功(UPLOAD_SUCCESS)状态。 启动中(STARTING)和正在运行(RUNNING)的精修后处理任务执行停止后将更新为停止中(STOPPING)状态,并且在停止完成后更新为已停止(STOP_SUCCESS)状态。
  • 响应参数 状态码: 400 表3 响应Body参数 参数 参数类型 描述 error_code String 错误码。格式为:KMP.XXXXXXXX,其中X表示数字。 最小长度:12 最大长度:12 error_msg String 错误描述。 最小长度:2 最大长度:512 状态码: 500 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码。格式为:KMP.XXXXXXXX,其中X表示数字。 最小长度:12 最大长度:12 error_msg String 错误描述。 最小长度:2 最大长度:512
  • 响应参数 状态码: 400 表3 响应Body参数 参数 参数类型 描述 error_code String 错误码。格式为:KMP.XXXXXXXX,其中X表示数字。 最小长度:12 最大长度:12 error_msg String 错误描述。 最小长度:2 最大长度:512 状态码: 500 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码。格式为:KMP.XXXXXXXX,其中X表示数字。 最小长度:12 最大长度:12 error_msg String 错误描述。 最小长度:2 最大长度:512
  • 响应参数 状态码: 400 表3 响应Body参数 参数 参数类型 描述 error_code String 错误码。格式为:KMP.XXXXXXXX,其中X表示数字。 最小长度:12 最大长度:12 error_msg String 错误描述。 最小长度:2 最大长度:512 状态码: 500 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码。格式为:KMP.XXXXXXXX,其中X表示数字。 最小长度:12 最大长度:12 error_msg String 错误描述。 最小长度:2 最大长度:512
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 subtasks Array of Real3DSubTaskDto objects 精修后处理任务列表。 page Page object 分页信息。 表5 Real3DSubTaskDto 参数 参数类型 描述 subtask_id String 实景三维精修后处理任务ID。 task_id String 原始实景三维建模任务ID。 subtask_name String 精修后处理任务别名。 task_name String 原始实景三维建模任务名称。 workspace_id String 原始实景三维建模任务所属工作共享空间ID。 modeling_params ModelingParams object 原始实景三维建模任务建模参数列表。 subtask_status String 实景三维精修后处理任务当前状态。 INIT(初始化) UPLOADING(上传中) UPLOAD_SUCCESS(上传成功) UPLOAD_FAILED(上传失败) PENDING(等待中) STARTING(启动中) START_FAILED(启动失败) RUNNING(运行中) SUCCESS(运行成功) FAILED(运行失败) STOPPING(停止中) STOP_SUCCESS(已停止) model_path String 模型数据上传路径。 refine_product_id String 精修后处理任务成果数据ID。 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 精修后处理任务最近操作人。 subtask_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 失败消息。当精修后处理任务执行失败时,该字段显示任务的失败原因,用于辅助定位问题。 表6 ModelingParams 参数 参数类型 描述 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:高 1:中 2:低 缺省值:0 表7 Page 参数 参数类型 描述 offset Integer 偏移量,表示从第几条数据开始查询。 limit Integer 每页包含的查询记录数量。 total Integer 符合查询条件的记录总数。 状态码: 400 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。格式为:KMP.XXXXXXXX,其中X表示数字。 最小长度:12 最大长度:12 error_msg String 错误描述。 最小长度:2 最大长度:512 状态码: 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。格式为:KMP.XXXXXXXX,其中X表示数字。 最小长度:12 最大长度:12 error_msg String 错误描述。 最小长度:2 最大长度:512
共100000条