华为云用户手册

  • URI GET /v1/kmp-control/usages 表1 Query参数 参数 是否必选 参数类型 描述 usage_type 是 String 查询的用量类型。 DATA:时空专属存储服务占用空间大小。 TASK:成功处理的成果影像数据大小以及成功处理任务次数。 limit 否 Integer 分页大小。 最小值:1 最大值:100 缺省值:10 offset 否 Integer 偏移量,表示从第几条记录开始查询。 最小值:0 最大值:2147483647 缺省值:0
  • 响应示例 状态码: 200 请求成功。 { "tasks" : [ { "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-26T08:00:00Z", "tenant_domain_id" : "xxxx", "creator" : "xxxx", "latest_operator" : "xxxx", "task_status" : "SUC CES S", "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 } ], "page" : { "offset" : 0, "limit" : 2, "total" : 1 } }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 tasks Array of Real3DTaskDto objects 任务列表。 page Page object 分页信息。 表5 Real3DTaskDto 参数 参数类型 描述 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 表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
  • URI GET /v1/real3d/{workspace_id}/tasks 表1 路径参数 参数 是否必选 参数类型 描述 workspace_id 是 String 工作共享空间ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 偏移量。查询时忽略的记录数量。 最小值:0 最大值:2147483647 缺省值:0 limit 否 Integer 分页大小。 最小值:1 最大值:100 缺省值:10 task_name 否 String 任务名称。支持中文、英文、数字以及“_”字符,长度限制1~50个字符。支持模糊查询。 task_type 否 Array 任务类型。支持过滤多种任务类型。 modeling_type 否 String 建模类型。支持Mesh和Nerf。 create_time_from 否 String 任务创建起始时间。格式为UTC时间:yyyy-MM-dd'T'HH:mm:ss'Z'。 create_time_to 否 String 任务创建截止时间。格式为UTC时间:yyyy-MM-dd'T'HH:mm:ss'Z'。 update_time_from 否 String 任务更新起始时间。格式为UTC时间:yyyy-MM-dd'T'HH:mm:ss'Z'。 update_time_to 否 String 任务更新截止时间。格式为UTC时间:yyyy-MM-dd'T'HH:mm:ss'Z'。 task_ids 否 Array 根据任务ID查询。支持过滤多个任务ID。 task_status 否 Array 根据任务状态查询。支持过滤多个任务状态。
  • 功能介绍 对单个工作共享空间内的任务进行分页查询,支持过滤条件: 任务名称(task_name):支持模糊查询。 任务类型(task_type):支持REAL3D-UNCTRL和REAL3D-CTRL。 建模类型(modeling_type):支持Mesh和Nerf。 任务ID(task_ids):支持同时过滤多个任务ID。 任务状态(task_status):支持同时过滤多个任务状态。 创建时间范围(create_time_from和create_time_to):为UTC时间格式字符串,格式为yyyy-MM-dd'T'HH:mm:ss'Z'。 更新时间范围(update_time_from和update_time_to):为UTC时间格式字符串,格式为yyyy-MM-dd'T'HH:mm:ss'Z'。 分页参数:偏移量offset(缺省值为0)、每页数量limit(缺省值为10)。
  • 响应示例 状态码: 200 请求成功。 { "page" : { "offset" : 0, "limit" : 10, "total" : 1 }, "data" : [ { "task_id" : "4673779ec6d34a0cad106a2aaa5xxxxx", "workspace_id" : "ce5694adfd4f4f11a13a67e2e7exxxxx", "data_id" : "[\"3f7eb40cf46d45fd96a927361c57787\"]", "task_name" : "任45YU655675ds", "domain_id" : "c163c3c55c3c4526b2ed7a0213bxxxxx", "creator" : "创建人", "create_time" : "2022-12-19T12:41:41Z", "task_status" : "INIT", "task_type" : "ORSIP", "task_description" : "任务描述", "exec_start_time" : null, "exec_stop_time" : null, "origin_data_alias" : null, "production_level" : "tile", "task_progress" : "0.0", "shape_id" : "541f58792fb84cd0bc3d8d6d8cd93337", "is_deleted" : 0, "image_url" : "https://koomap-optical-image-data.obs.cn-north-5.myhuaweicloud.com:443/c163c3c55c3c4526b2ed7a0213bc9871/%E6%95%B0%E6%8D%AE%E5%8A%A0%E5%B7%A5/%E5%85%89%E5%AD%A6%E5%BD%B1%E5%83%8F/%E6%88%90%E6%9E%9C%E5%BD%B1%E5%83%8F/%E4%BB%BB45YU655675ds_L5_tile_1671453701674/%E4%BB%BB45YU655675ds_L5_tile_per.png?AccessKeyId=********&Expires=1672217213&Signature=yzB8ao4%2Bzo5BXen6HPXOJ6FOdyI%3D", "frozen_tag" : null, "is_clip" : "0", "is_tile" : "0" } ], "taskNumVo" : [ { "totalNum" : 10, "failedNum" : 1, "archivedNum" : 1, "successNum" : 1, "runningNum" : 1 } ] }
  • URI GET /v1/kmp-control/tasks 表1 Query参数 参数 是否必选 参数类型 描述 task_name 否 String 任务名称,支持模糊查询。 最小长度:1 最大长度:50 workspace_id 是 String 任务所属工作共享空间ID。 最小长度:32 最大长度:32 task_status 否 Array 任务状态。包括INIT(初始化)、RUNNING(运行中)、SUCCESS(执行成功)、ARCHIVED(已归档)、FAILED(执行失败)、STOPPING(停止中)、STOP_SUCCESS(已停止)、STOP_FAILD(停止失败)、START_RUNNING(等待中)。 create_time_start 否 String 创建开始时间。格式为UTC标准时间:yyyy-MM-dd'T'HH:mm:ss'Z'。 create_time_end 否 String 创建结束时间。格式为UTC标准时间:yyyy-MM-dd'T'HH:mm:ss'Z'。 offset 是 Integer 偏移量,从第几条记录开始查询。 最小值:0 最大值:2147483647 缺省值:0 limit 是 Integer 分页大小。 最小值:1 最大值:100 缺省值:10
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 page Page object 分页信息。 data Array of TaskVo objects 任务列表。 taskNumVo TaskNumVo object 各状态任务数量。 表4 Page 参数 参数类型 描述 offset Integer 偏移量,表示从第几条数据开始查询。 limit Integer 每页包含的查询记录数量。 total Integer 符合查询条件的记录总数。 表5 TaskVo 参数 参数类型 描述 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 是否删除。 0:未删除 1:已删除 image_url String 影像链接。 domain_id String 华为云IAM租户账号ID。 fail_message String 任务失败原因。 frozen_tag String 任务冻结状态。当前仅支持frozen(冻结中)。 isClip String 是否为矢量切割。 0:否 1:是 isTile String 是否为金字塔切割。 0:否 1:是 表6 TaskNumVo 参数 参数类型 描述 totalNum Integer 任务总数量。 failedNum Integer 失败任务数量。 archivedNum Integer 存档任务数量。 successNum Integer 成功任务数量。 runningNum 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 请求成功。 { "spurInfos" : [ { "imageCode" : "1674019035390013440", "id" : "1676151290921086976", "taskId" : "db554dbd410f4c53a2118c6e34a31eb0", "pointWidth" : "7864.08984", "pointHeight" : "5433.04541", "longitude" : "113.87890565212626", "latitude" : "22.876653471049696", "height" : "37.884999999999998", "accuracy" : "0.05" }, { "imageCode" : "1674019035390013440", "id" : "1674395911112953856", "taskId" : "db554dbd410f4c53a2118c6e34a31eb0", "pointWidth" : "9274.5957", "pointHeight" : "2941.47803", "longitude" : "113.8800482786927", "latitude" : "22.8771672263087", "height" : "37.976999999999997", "accuracy" : "0.05" }, { "imageCode" : "1674019035390013440", "id" : "1674394962671767552", "taskId" : "db554dbd410f4c53a2118c6e34a31eb0", "pointWidth" : "7864.08984", "pointHeight" : "5433.04541", "longitude" : "113.87890565212626", "latitude" : "22.876653471049696", "height" : "37.884999999999998", "accuracy" : "0.05" } ], "page" : { "offset" : -1, "limit" : 10, "total" : 3 } }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 spurInfos Array of SpurInfoDetail objects 刺点信息列表。 page Page object 分页信息。 表4 SpurInfoDetail 参数 参数类型 描述 imageCode String 图像ID。 id String 刺点ID。 taskId String 刺点所属任务ID。 pointWidth String 刺点在图片中的横向像素值。 pointHeight String 刺点在图片中的纵向像素值。 longitude String 像控点经度。 latitude String 像控点纬度。 height String 像控点高度。 accuracy String 像控点精度。 表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 响应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参数 参数 是否必选 参数类型 描述 imageCode 是 String 图片ID。 taskId 是 String 刺点所属的任务ID。 offset 否 Integer 偏移量。 最小值:0 最大值:2147483647 缺省值:0 limit 否 Integer 分页大小。 最小值:1 最大值:100 缺省值:10
  • 响应示例 状态码: 200 请求成功。 { "subtasks" : [ { "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 } ], "page" : { "offset" : 0, "limit" : 2, "total" : 1 } }
  • 响应参数 状态码: 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
  • 请求示例 该请求分页查询任务ID为914305233ef7428e8073a95d8042fxxx的精修后处理任务列表,从第0个任务开始,查询2个任务。 https://{endpoint}/v1/real3d/c734a30b6c5f42cfaf49e01eb6903xxx/tasks/914305233ef7428e8073a95d8042fxxx/subtasks?limit=2&offset=0
  • 功能介绍 对单个实景三维建模任务内的精修后处理任务进行分页查询,支持过滤条件: 实景三维精修后处理任务ID(subtask_id):支持根据ID查询特定精修后处理任务。 实景三维精修后处理任务别名(subtask_name):支持根据精修后处理任务别名进行模糊查询。 实景三维精修后处理任务状态(subtask_status):支持同时查询多种状态的精修后处理任务。 实景三维精修后处理任务创建时间范围(create_time_from和create_time_to):为UTC时间格式字符串,格式为yyyy-MM-dd'T'HH:mm:ss'Z'。 实景三维精修后处理任务更新时间范围(update_time_from和update_time_to):为UTC时间格式字符串,格式为yyyy-MM-dd'T'HH:mm:ss'Z'。 分页参数:偏移量offset(缺省值为0)、每页数量limit(缺省值为10)。
  • URI GET /v1/real3d/{workspace_id}/tasks/{task_id}/subtasks 表1 路径参数 参数 是否必选 参数类型 描述 workspace_id 是 String 工作共享空间ID。 task_id 是 String 原始实景三维建模任务ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 偏移量。 最小值:0 最大值:2147483647 缺省值:0 limit 否 Integer 分页大小。 最小值:1 最大值:100 缺省值:10 subtask_id 否 String 精修后处理任务ID。 subtask_name 否 String 精修后处理任务别名,支持模糊查询。 subtask_status 否 Array 根据精修后处理任务状态查询,支持输入多个状态。 create_time_from 否 String 创建精修后处理任务的起始时间。格式为UTC时间:yyyy-MM-dd'T'HH:mm:ss'Z'。 create_time_to 否 String 创建精修后处理任务的截止时间。格式为UTC时间:yyyy-MM-dd'T'HH:mm:ss'Z'。 update_time_from 否 String 更新精修后处理任务的起始时间。格式为UTC时间:yyyy-MM-dd'T'HH:mm:ss'Z'。 update_time_to 否 String 更新精修后处理任务的截止时间。格式为UTC时间:yyyy-MM-dd'T'HH:mm:ss'Z'。
  • 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(精修后处理任务别名降序)。
  • 功能介绍 查询实景三维精修后处理成果的数据列表。支持的过滤参数: 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
  • 响应示例 状态码: 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 } }
  • 响应参数 状态码: 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
  • 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 请求成功。 { "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" : "参数不符合规范。" }
  • 请求参数 表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 表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
  • 响应参数 状态码: 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
  • 响应示例 状态码: 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 } }
  • 请求参数 表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)。
  • URI GET /v1/workspaces 表1 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 偏移量。查询时忽略的记录数量。 最小值:0 最大值:2147483647 缺省值:0 limit 否 Integer 分页大小。 最小值:1 最大值:100 缺省值:10 workspace_ids 否 Array 根据工作共享空间ID查询。 workspace_name 否 String 工作共享空间名称。支持模糊查询。 star 否 Boolean 工作共享空间是否置顶显示(最多可置顶4个)。 0:否 1:是 create_time_from 否 String 创建工作共享空间的起始时间。查询在该时间之后创建的工作共享空间。接收UTC时间格式字符串,格式为yyyy-MM-dd'T'HH:mm:ss'Z'。 create_time_to 否 String 创建工作共享空间的截止时间。查询在该时间之前创建的工作共享空间。接收UTC时间格式字符串,格式为yyyy-MM-dd'T'HH:mm:ss'Z'。 update_time_from 否 String 更新工作共享空间的起始时间。查询在该时间之后更新的工作共享空间。接收UTC时间格式字符串,格式为yyyy-MM-dd'T'HH:mm:ss'Z'。 update_time_to 否 String 更新工作共享空间的截止时间。查询在该时间之前更新的工作共享空间。接收UTC时间格式字符串,格式为yyyy-MM-dd'T'HH:mm:ss'Z'。 order_by 否 String 排序字段。置顶空间默认排列在列表最前面,并且根据该排序字段组合排序。 create_time_asc:按照创建时间升序排列。 create_time_desc:按照创建时间降序排列。
  • 响应示例 状态码: 200 请求成功。 { "data" : [ { "workspace_id" : "8c008cabac124f74ad7deba48e1bdf7a", "workspace_name" : "测试空间1", "workspace_description" : "空间描述", "creator" : "xxxx", "latest_operator" : "xxxx", "create_time" : "2023-05-23T07:57:14Z", "update_time" : "2023-05-23T07:57:14Z", "star" : 0, "can_delete" : false }, { "workspace_id" : "cd8a29375dc0452889e3cce805bace1d", "workspace_name" : "测试空间2", "workspace_description" : "空间描述", "creator" : "xxxx", "latest_operator" : "xxxx", "create_time" : "2023-05-23T07:36:30Z", "update_time" : "2023-05-23T07:36:30Z", "star" : 0, "can_delete" : true } ], "page" : { "offset" : 0, "limit" : 2, "total" : 12 } }
共100000条