华为云用户手册

  • 响应示例 状态码: 200 请求成功。 { "workspace_id" : "44eb5d869258451595f15dd26ee0xxxx", "workspace_name" : "测试空间2", "workspace_description" : "测试空间描述", "tenant_domain_id" : "xxxx", "creator" : "xxxx", "latest_operator" : "xxxx", "create_time" : "2023-05-26T07:30:10Z", "update_time" : "2023-05-26T07:34:27Z", "star" : 1, "can_delete" : false }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String IAM Token信息,用于租户鉴权,该字段由租户请求IAM的Token接口获得。 表3 请求Body参数 参数 是否必选 参数类型 描述 workspace_name 否 String 工作共享空间名称。支持中文、英文、数字以及“_”字符,长度限制2~50个字符。 workspace_description 否 String 工作共享空间描述。支持中文、英文、数字以及“_”字符,长度限制200个字符以内。 star 否 Integer 工作共享空间是否置顶显示(最多可置顶4个)。
  • 响应参数 状态码: 200 表4 响应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 表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
  • 响应参数 状态码: 400 表3 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID,用于运维人员定位请求日志。 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码。格式为:KMP.XXXXXXXX,其中X表示数字。 最小长度:12 最大长度:12 error_msg String 错误描述。 最小长度:2 最大长度:512 状态码: 500 表5 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID,用于运维人员定位请求日志。 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。格式为:KMP.XXXXXXXX,其中X表示数字。 最小长度:12 最大长度:12 error_msg String 错误描述。 最小长度:2 最大长度:512
  • 响应参数 状态码: 400 表3 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID,用于运维人员定位请求日志。 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码。格式为:KMP.XXXXXXXX,其中X表示数字。 最小长度:12 最大长度:12 error_msg String 错误描述。 最小长度:2 最大长度:512 状态码: 500 表5 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID,用于运维人员定位请求日志。 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。格式为:KMP.XXXXXXXX,其中X表示数字。 最小长度:12 最大长度:12 error_msg String 错误描述。 最小长度:2 最大长度:512
  • 功能介绍 可停止任务状态为等待中(PENDING)、启动中(STARTING)或者运行中(RUNNING)的任务。 等待中(PENDING)的任务执行停止后将更新为初始化(INIT)状态。 启动中(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
  • 响应示例 状态码: 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 表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
  • 功能介绍 该接口用于启动任务。该接口运行成功后,任务状态更新为等待中(PENDING),此时任务添加到启动队列中等待运行资源就绪。资源就绪后任务状态更新为启动中(STARTING),启动成功后任务状态更新为运行中(RUNNING),若启动失败则任务状态更新为启动失败(START_FAILED)。当建模任务类型为有控建模时,为了提升刺点效率需要先对影像进行空三建模。执行空三建模需要设置请求体的“run_AT_only”为“true”,空三建模成功后,任务状态更新为空三建模成功(BUNDLE_SUCCESS)。 任务允许启动的状态为:初始化(INIT)、已停止(STOP_SUCCESS)、运行失败(FAILED)、空三建模成功(BUNDLE_SUCCESS)。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String IAM Token信息,用于租户鉴权,该字段由租户请求IAM的Token接口获得。 表3 请求Body参数 参数 是否必选 参数类型 描述 run_AT_only 否 Boolean 是否为进行空三建模的阶段,缺省时为“false”,仅支持有控建模类型任务设置“true”。取值为“true”时表示进行空三建模,建模完成后对应的任务状态为空三建模成功(BUNDLE_SUCCESS)。
  • AR地图运行服务错误码 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 状态码 错误码 错误信息 描述 处理措施 400 NAVI.0002 Navi failed, please check parameters. 导航失败。 检查参数是否正确或联系技术支持。 400 NAVI.0003 Invalid parameters. 导航算法服务参数不正确。 检查参数是否正确。 400 NAVI.0004 Access denied, out of your service zone. 导航参数不正确,位置不在你的服务区。 到有服务的地方请求或联系技术支持。 400 VPS.0002 VPS failed. 空间定位算法服务定位错误。 检查参数是否正确或请联系技术支持。 400 VPS.0003 Invalid parameters. 空间定位算法服务请求参数不正确。 检查参数是否正确。 400 VPS.0004 Access denied, out of your service zone. 空间定位算法服务参数不正确,位置不在你的服务区。 到有服务的地方请求或联系技术支持。 403 GATEWAY.0002 Auth failed, please check your auth token. 鉴权header未携带。 在请求头中携带鉴权信息,参考“如何调用API”。 403 GATEWAY.0003 Service unavailable. 服务未开通/冻结。 开通/购买服务,检查服务是否被冻结或联系技术支持。 403 GATEWAY.0005 IAM auth deny, you don't have the permission of this action. IAM鉴权失败,没有action的访问权限。 为IAM用户添加此服务对应的操作权限。 429 GATEWAY.0006 Too many requests. 触发网关限流。 降低访问频率或开通更高QPS规格的服务。 500 GATEWAY.0001 Open gateway system inner error. 网关内部错误。 请联系技术支持。 500 NAVI.0001 Navi internal server error. 导航算法服务错误。 请联系技术支持。 500 VPS.0001 Internal server error. 空间定位算法服务错误。 请联系技术支持。 502 GATEWAY.0007 Service timeout. 服务超时。 请联系技术支持。
  • 响应示例 状态码: 200 请求成功。 { "data_info" : [ { "image_name" : "影像名称", "is_product" : "0", "image_level" : "L1A", "image_status" : "完成", "image_date" : "2013-10-09T16:00:00Z", "upload_date" : "2022-11-09T03:02:52Z", "image_resolution" : "16.0", "image_description" : "", "image_id" : "9260ad8d63f84ed1a9269f56162e42a5", "image_type" : "1", "user_name" : "IAM用户名称", "image_alias" : "WFV3", "product_clip" : 1, "product_tile" : 1, "is_cog" : 1 } ] } 状态码: 400 非法请求。 { "error_code" : "400", "error_msg" : "参数不符合规范。" }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 data_info Array of DataInfo objects 数据信息列表。 page Page object 分页信息。 表4 DataInfo 参数 参数类型 描述 image_name String 卫星影像名称。 支持模糊查询,格式为中英文、数字、下划线、中划线、“.”,长度100个字符以内。 is_product String 卫星影像是否为成果影像。 目前只支持原始影像(0)、成果影像(1)。 枚举值: 0 1 image_level String 卫星影像等级。 目前只支持L1、L1A、L1B、L2、L3、L4、L5。 最小长度:2 最大长度:3 image_status String 卫星影像迁移状态。当前仅支持完成(0)、迁入中(1)、迁入失败(2)、迁出中(3)、迁出失败(4)、删除中(6)、卫星影像正在被任务使用导致删除失败(7)、网络错误导致删除失败(8)。 image_date String 卫星影像成像时间。 格式为UTC标准时间:yyyy-MM-dd'T'HH:mm:ss'Z'。 最小长度:20 最大长度:20 upload_date String 卫星影像上传时间。 格式为UTC标准时间:yyyy-MM-dd'T'HH:mm:ss'Z'。 最小长度:20 最大长度:20 image_resolution String 卫星影像分辨率,精确到小数点后一位。 image_description String 卫星影像描述。 格式为中英文、数字、下划线、中划线,长度255个字符以内。 最小长度:0 最大长度:255 image_id String 卫星影像ID。 格式为英文、数字,长度为32。 最小长度:32 最大长度:32 image_type String 卫星影像类型。当前仅支持全色(0)、多光谱(1)。 枚举值: 0 1 user_name String IAM用户名称。 image_alias String 卫星影像别名。 格式为中英文、数字、下划线、中划线、“.”,长度255个字符以内。 最小长度:0 最大长度:255 product_clip Integer 是否为矢量切割影像。当前仅支持是(1)、否(0)。 枚举值: 0 1 product_tile Integer 是否为金字塔切割影像。当前仅支持是(1)、否(0)。 枚举值: 0 1 is_cog Integer 是否为COG影像。当前仅支持是(1)、否(0)。 枚举值: 0 1 表5 Page 参数 参数类型 描述 offset Integer 偏移量,表示从第几条数据开始查询。 limit Integer 每页包含的查询记录数量。 total Integer 符合查询条件的记录总数。 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。格式为:KMP.XXXXXXXX,其中X表示数字。 最小长度:12 最大长度:12 error_msg String 错误描述。 最小长度:2 最大长度:512 状态码: 500 表7 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID,用于运维人员定位请求日志。 表8 响应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 FormData参数 参数 是否必选 参数类型 描述 image_name 否 String 卫星影像名称,支持模糊查询。 格式为中英文、数字、下划线、中划线、“.”,长度100个字符以内。 最小长度:0 最大长度:100 image_date_from 否 String 卫星影像上传起始时间。 格式为UTC标准时间:yyyy-MM-dd'T'HH:mm:ss'Z'。 最小长度:20 最大长度:20 image_date_to 否 String 卫星影像上传截止时间。 格式为UTC标准时间:yyyy-MM-dd'T'HH:mm:ss'Z'。 最小长度:20 最大长度:20 image_status 否 String 卫星影像迁移状态列表。 当前仅支持完成(0)、迁入中(1)、迁入失败(2)、迁出中(3)、迁出失败(4)、删除中(6)、卫星影像正在被任务使用导致删除失败(7)、网络错误导致删除失败(8)。状态之间以“,”隔开。 raw_alias 否 String 卫星影像别名。 支持模糊查询,格式为中英文、数字、下划线、中划线、“.”,长度100个字符以内。 最小长度:0 最大长度:100 image_alias 否 String 卫星影像别名列表。 格式为中英文、数字、下划线、中划线、“.”。别名之间以“,”隔开。 image_levels 否 String 卫星影像等级列表。 当前仅支持L1、L1A、L1B、L2、L3、L4、L5。等级之间以“,”隔开。 is_product 否 String 卫星影像是否为成果数据。 当前仅支持原始数据(0)、成果数据(1)。 order 否 String 卫星影像排序规则。 当前仅支持影像名称正序(1)、影像名称倒序(-1)、影像别名正序(2)、影像别名倒序(-2)、影像上传日期正序(3)、影像上传日期倒序(-3)。 description 否 String 卫星影像描述。 格式为中英文、数字、下划线、中划线,长度为255个字符以内。 image_type 否 String 卫星影像类型。当前仅支持全色(0)、多光谱(1)。 limit 是 Integer 每页显示条数。 最小值:1 最大值:100 offset 是 Integer 偏移量,表示从第几条记录开始查询。 最小值:0 最大值:2147483647
  • 响应示例 状态码: 200 请求成功。 { "products" : [ { "id" : "b6fbb5c6b7ba4b89aaeadfaba3df7xxx", "name" : "AUTO_api_1981c24729f611ee947ef863656935b3_546454_20230728103445", "status" : "preparing", "folder_code" : "fa693df75e0e47c88c8eefb2c639axxx", "folder_info" : "{\"folder_name\":\"AUTO_api_1981c24729f611ee947ef86365693xxx\",\"folder_alias\":\"19ae9fbb29f611ee98dff863656935b3\",\"create_time\":\"2023-07-24T07:46:18Z\",\"folder_desc\":\"api\"}", "task_info" : "{\"task_exec_end_time\":\"2023-07-28T02:34:21Z\",\"task_exec_start_time\":\"2023-07-28T01:53:00Z\",\"task_id\":\"db9743d353c741478fd4cfc725081a6f\",\"task_name\":\"546454\",\"task_params\":\"{\\\"accuracy\\\":\\\"High\\\",\\\"mesh_accuracy\\\":\\\"1\\\",\\\"key_point_limit\\\":\\\"40000\\\",\\\"tie_point_limit\\\":\\\"4000\\\"}\",\"task_status\":\"SUCCESS\",\"task_type\":\"REAL3D-UNCTRL\"}", "product_details" : [ { "type" : "mesh_osgb", "storage_size_byte" : 0, "files" : [ "MESH_OSGB_AUTO_api_1981c24729f611ee947ef863656935b3_546454_20230728103445-Tile_+000~+000.zip", "MESH_OSGB_AUTO_api_1981c24729f611ee947ef863656935b3_546454_20230728103445-Tile_+001~+001.zip", "MESH_OSGB_AUTO_api_1981c24729f611ee947ef863656935b3_546454_20230728103445-Tile_+002~+002.zip", "MESH_OSGB_AUTO_api_1981c24729f611ee947ef863656935b3_546454_20230728103445-Tile_+003~+003.zip", "MESH_OSGB_AUTO_api_1981c24729f611ee947ef863656935b3_546454_20230728103445-Tile_+004~+004.zip" ] }, { "type" : "mesh_obj", "storage_size_byte" : 0, "files" : [ ] } ], "storage_size_byte" : null, "create_time" : "2023-07-28T02:34:45Z", "update_time" : "2023-07-28T02:34:45Z", "tenant_domain_id" : "234602bf93714dcba145eaa45686exxx" } ], "page" : { "offset" : 0, "limit" : 1, "total" : 47 } }
  • URI GET /v1/real3d/products 表1 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 偏移量。查询时忽略的记录数量。 最小值:0 最大值:2147483647 缺省值:0 limit 否 Integer 分页大小。 最小值:1 最大值:100 缺省值:10 product_name 否 String 成果数据名称。支持模糊搜索。 product_id 否 String 成果数据ID。
  • 响应参数 状态码: 200 表2 响应Body参数 参数 参数类型 描述 products Array of Real3DProductVO objects 实景三维成果数据列表。 page Page object 分页信息。 表3 Real3DProductVO 参数 参数类型 描述 id String 成果数据ID。 name String 成果数据名称。 status String 成果数据状态。 preparing:准备中。处于该状态表示成果模型数据正在准备,需要在该状态后才能下载、删除。 available:可用。处于该状态时成果模型可以下载、删除。 deleting:删除中。成果模型正在删除。 folder_code String 倾斜影像编码。 task_info Real3DProductRelateTaskVO object 相关任务信息。 product_details Array of Real3DProductDetailVO 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。 表4 Real3DProductRelateTaskVO 参数 参数类型 描述 task_id String 任务ID。 task_name String 任务名称。 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'。 表5 Real3DProductDetailVO 参数 参数类型 描述 type String 文件类型。 mesh_osgb:纹理模型格实景三维模型输出.osgb三维预览文件。 mesh_obj:纹理模型格实景三维模型输出.obj三维模型文件。 nerf_osgb:显式辐射场实景三维模型输出.osgb三维预览文件。 nerf_obj:显式辐射场实景三维模型输出.obj三维模型文件。 metadata: metadata.xml文件,用于模型坐标校准。 storage_size_byte Double 文件占用存储空间大小(字节)。 files Array of strings 文件名称列表。 表6 Page 参数 参数类型 描述 offset Integer 偏移量,表示从第几条数据开始查询。 limit Integer 每页包含的查询记录数量。 total Integer 符合查询条件的记录总数。 状态码: 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。格式为:KMP.XXXXXXXX,其中X表示数字。 最小长度:12 最大长度:12 error_msg String 错误描述。 最小长度:2 最大长度:512 状态码: 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。格式为:KMP.XXXXXXXX,其中X表示数字。 最小长度:12 最大长度:12 error_msg String 错误描述。 最小长度:2 最大长度:512
  • 响应参数 状态码: 200 表5 响应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。 表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 状态码: 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。格式为:KMP.XXXXXXXX,其中X表示数字。 最小长度:12 最大长度:12 error_msg String 错误描述。 最小长度:2 最大长度:512 状态码: 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。格式为:KMP.XXXXXXXX,其中X表示数字。 最小长度:12 最大长度:12 error_msg String 错误描述。 最小长度:2 最大长度:512
  • 请求示例 该请求更新建模的任务类型、输入的影像ID。 PUT https://{Endpoint}/v1/real3d/c734a30b6c5f42cfaf49e01eb6903xxx/tasks/914305233ef7428e8073a95d8042fxxx { "task_type" : "REAL3D-CTRL", "folder_code" : "m73MeiI7ztsJpRTaYE3X-YqeZDWfgpxxx" }
  • 响应示例 状态码: 200 请求成功。 { "task_id" : "914305233ef7428e8073a95d8042fxxx", "task_name" : "测试任务1685087027834", "task_type" : "REAL3D-CTRL", "modeling_type" : "Nerf", "workspace_id" : "c734a30b6c5f42cfaf49e01eb6903xxx", "modeling_params" : { "accuracy" : "High", "key_point_limit" : "40000", "tie_point_limit" : "4000", "mesh_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:52:58Z", "tenant_domain_id" : "xxxx", "creator" : "xxxx", "latest_operator" : "xxxx", "task_status" : "INIT", "complete_stage" : null, "total_stage" : null, "exec_start_time" : null, "task_progress" : null, "exec_stop_time" : null, "fail_message" : null, "AT_progress" : null }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String IAM Token信息,用于租户鉴权,该字段由租户请求IAM的Token接口获得。 表3 请求Body参数 参数 是否必选 参数类型 描述 task_name 否 String 任务名称。支持中文、英文、数字以及“_”字符,长度限制1~50个字符。 task_type 否 String 任务类型。 REAL3D-CTRL:实景三维有控建模 REAL3D-UNCTRL:实景三维无控建模 modeling_type 否 String 建模类型。 Mesh:纹理模型实景三维建模。 Nerf:显式辐射场实景三维建模。 task_description 否 String 任务描述。支持中文、英文、数字以及“_”字符,长度限制255个字符以内。 folder_code 否 String 需要进行三维重建的倾斜影像的影像code。 modeling_params 否 ModelingParams object 实景三维建模参数。 coordinate_sys 否 String 建模坐标系。缺省值:WGS84-UTM。 表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
  • API概览 云地图服务接口的分类与说明如表1所示。 表1 API概览 类型 说明 工作共享空间管理 工作共享空间管理接口,包括工作共享空间的新建、查询、修改以及删除接口。 卫星影像任务管理 卫星影像处理任务管理接口,包括任务的新建、查询、查看、启动、停止、归档/取消归档、删除、校验原始影像文件接口。 卫星影像用量统计 查询卫星影像生产服务的时空专属存储用量、任务处理成功后的成果影像存储用量、成功处理的次数。 卫星影像数据管理 根据过滤条件查询卫星影像信息列表。 实景三维任务管理 实景三维生产服务任务管理接口,包括建模任务的创建、更新、查询、启动、停止、归档/取消归档、删除以及展示任务概览信息接口。 实景三维精修后处理任务管理 实景三维精修后处理任务管理接口,包括创建、查询、启动、停止以及删除任务接口。 实景三维用量统计 查询实景三维生产服务的时空专属存储用量、成功建模的倾斜影像的像素点数量、成功建模的次数。 实景三维刺点管理 实景三维生产服务刺点管理接口,包括刺点的新增与删除、刺点信息获取、刺点文件的生成以及查询像控点的已刺点数量接口。 实景三维数据管理 查询/删除实景三维建模成果数据、精修后处理成果数据,查询当前租户的倾斜影像基本信息列表。 视觉定位 通过拍摄一系列具有已知位置的图像并分析它们的关键视觉特征(例如建筑物或桥梁的轮廓)来创建地图,以创建这些视觉特征的大规模且可快速搜索的索引。将设备图像中的特征与索引中的特征进行比较,可获得目标设备的位姿。 AR导航 基于摄像头实时捕捉的实景画面,将地图导航信息通过数字内容的形态叠加在实景画面中,生成虚拟的3D导航指引。
  • 响应参数 状态码: 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参数 参数 参数类型 描述 folders Array of FolderVo objects 文件夹列表。 page Page object 分页信息。 表5 FolderVo 参数 参数类型 描述 folder_code String 倾斜影像的唯一标识。 folder_name String 倾斜影像名称。 folder_alias String 倾斜影像别名。 folder_desc String 倾斜影像描述。 obs_endpoint String 倾斜影像所在OBS的Endpoint。 obs_path String 倾斜影像所在OBS的目录地址。 create_time String 倾斜影像上传时间。 status Integer 倾斜影像状态。 0:处理中 1:已完成 2:导入失败 表6 Page 参数 参数类型 描述 offset Integer 偏移量,表示从第几条数据开始查询。 limit Integer 每页包含的查询记录数量。 total Integer 符合查询条件的记录总数。 状态码: 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。格式为:KMP.XXXXXXXX,其中X表示数字。 最小长度:12 最大长度:12 error_msg String 错误描述。 最小长度:2 最大长度:512 状态码: 500 表8 响应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参数 参数 是否必选 参数类型 描述 offset 是 Integer 偏移量,表示从第几条记录开始查询。 limit 是 Integer 每页显示条数。 condition 否 FolderQueryCondition object 查询条件。 表3 FolderQueryCondition 参数 是否必选 参数类型 描述 folder_name 否 String 倾斜影像名称。支持中文、英文、数字以及“_”、“-”、“.”字符,长度限制为[1, 100]。 folder_alias 否 String 倾斜影像别名。支持中文、英文、数字以及“_”、“-”、“.”字符,长度限制为[1, 100]。 folder_desc 否 String 倾斜影像描述。支持中文、英文、数字以及“_”、“-”、“.”字符,长度限制为[0, 255]。 from 否 String 倾斜影像上传起始时间。格式为UTC标准时间:yyyy-MM-dd'T'HH:mm:ss'Z'。 to 否 String 倾斜影像上传结束时间。格式为UTC标准时间:yyyy-MM-dd'T'HH:mm:ss'Z'。 status 否 String 倾斜影像状态。当前仅支持处理中(0)、已完成(1)、导入失败(2)。 order 否 String 倾斜影像排序规则。 当前仅支持影像名称正序(1)、影像名称倒序(-1)、影像别名正序(2)、影像别名倒序(-2)、影像上传日期正序(3)、影像上传日期倒序(-3)。
  • 响应示例 状态码: 200 请求成功。 { "folders" : [ { "folder_code" : "16565875049557xxxx", "folder_name" : "xxxx", "folder_alias" : "xxxx", "folder_desc" : "xxxx", "obs_endpoint" : "obs.xxxx.myhuaweicloud.com", "obs_path" : "real3d/xxxxx/real-test", "create_time" : "2023-05-11 17:10:13.000", "status" : 1 }, { "folder_code" : "16558314669791xxxx", "folder_name" : "xxxx", "folder_alias" : "xxxx", "folder_desc" : "xxxx", "obs_endpoint" : "obs.xxxx.myhuaweicloud.com", "obs_path" : "real3d/xxxxxx/test-image-source", "create_time" : "2023-05-09 15:06:00.000", "status" : 1 } ], "page" : { "offset" : 0, "limit" : 10, "total" : 2 } }
  • 响应参数 状态码: 200 表3 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID,用于运维人员定位请求日志。 表4 响应Body参数 参数 参数类型 描述 data Array of UsageVo objects 用量信息列表。 表5 UsageVo 参数 参数类型 描述 usage_measure_name String 用量度量名称,通常与KooMap的计费项保持一致。当前支持以下用量度量名称: 时空专属存储 实景三维生产服务基础版 实景三维生产服务专业版 usage_type String 用量类型。 该值为“DATA”时表示时空专属存储对应的用量消耗。 该值为“REAL3D”时表示处理三维建模任务对应的用量消耗。 domain_id String 华为云IAM租户账号ID。 最小长度:32 最大长度:32 usage_subtype String 用量子类型,用于区分同一用量类型下的多个子用量,目前usage_type为“REAL3D”时才需要设置该值。 REAL3D_BASIC:实景三维生产服务基础版用量 REAL3D_PRO:实景三维生产服务专业版用量 usage Float 租户当前的使用量数值。 capacity Float 租户购买的套餐总量值,按需使用取值为0。 usage_unit_type String 用量的计量单位类型。 “VOLUME”:容量。 “NUMBER”:数量。 “COUNT”:次数。 unit String 用量的计量单位。 当用量单位类型为“VOLUME”时,单位为存储量相关的单位,如:GB。 当用量单位类型为“NUMBER”时,单位为十亿像素(GP)。 当用量单位类型为“COUNT”时,单位为“次”。 created_time String 用量记录的创建时间。格式为UTC标准时间:yyyy-MM-dd'T'HH:mm:ss'Z'。 update_time String 用量记录的更新时间。格式为UTC标准时间:yyyy-MM-dd'T'HH:mm:ss'Z'。 状态码: 400 表6 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID,用于运维人员定位请求日志。 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。格式为:KMP.XXXXXXXX,其中X表示数字。 最小长度:12 最大长度:12 error_msg String 错误描述。 最小长度:2 最大长度:512 状态码: 500 表8 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID,用于运维人员定位请求日志。 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。格式为:KMP.XXXXXXXX,其中X表示数字。 最小长度:12 最大长度:12 error_msg String 错误描述。 最小长度:2 最大长度:512
  • 功能介绍 您可以查看实景三维生产服务时空专属存储或影像建模的用量统计。 时空专属存储:包括用户上传的数据、数据生产过程中产生的中间数据以及实景三维模型成果数据的存储总量。 用户上传的数据:倾斜摄影影像(航空飞机影像和无人机影像)、生产资料、精修后处理任务的输入数据(精修前后的obj数据)。 数据生产过程产生的中间数据:空三、显式辐射场阶段产生的数据。 实景三维成果数据:纹理Mesh实景三维模型和显式辐射场实景三维模型的osgb、obj格式的文件。 影像建模用量:统计成功建模的倾斜影像的像素数量(单位为“GP”,即十亿像素)、成功建模的次数。
  • 响应示例 状态码: 200 请求成功。 { "data" : [ { "usage_measure_name" : "时空专属存储", "usage_type" : "DATA", "domain_id" : "abc123c55c3c4526b2ed7a0213bc9xxx", "usage_subtype" : "REAL3D_BASIC", "usage_unit_type" : "VOLUME", "capacity" : 0, "usage" : 0, "unit" : "GB", "created_time" : "2022-10-27T13:12:56Z", "update_time" : "2022-10-27T13:12:56Z" } ] }
共100000条