CreateCompressPointCloudTask - 创建点云压缩任务

点云压缩功能可以将OSS中的点云数据进行压缩处理,减少网络数据传输。

接口说明

  • 请确保在使用该接口前,已充分了解智能媒体管理产品的收费方式和价格

    注意 异步任务不保证时效。

  • 文件格式限制:当前仅支持 PCD 格式的点云文件。

  • 该接口为异步接口,获取任务开始执行后,任务信息只保存 7 天,超过 7 天则无法再获取。调用 GetTaskListTasks 接口获取返回的TaskId,查看任务信息。也可以通过设置 Notification 消息通知参数,通过消息通知获取任务信息。>

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
imm:CreateCompressPointCloudTaskcreate
  • 全部资源
    *

请求参数

名称类型必填描述示例值
ProjectNamestring

项目名称,获取方式请参见创建项目

test-project
SourceURIstring

点云文件的 OSS 地址。

OSS 地址规则为 oss://${Bucket}/${Object},其中${Bucket}为和当前项目处于同一区域(Region)的 OSS Bucket 名称,${Object}为包含文件扩展名的文件完整路径。

oss://test/src/test.pcd
TargetURIstring

压缩后输出文件的 OSS 地址。

OSS 地址规则为 oss://${Bucket}/${Object},其中${Bucket}为和当前项目处于同一区域(Region)的 OSS Bucket 名称,${Object}为包含文件扩展名的文件完整路径。

oss://test/tgt
PointCloudFileFormatstring

点云文件格式。当前只支持 PCD 格式,默认值为 pcd。

pcd
CompressMethodstring

压缩算法名称。取值如下:

  • octree:八叉树

  • kdtree:K-d 树

octree
PointCloudFieldsarray

参与压缩的 PCD 属性字段以及压缩顺序,压缩完成后以此顺序进行解压数据。

  • 若采用 PCL 库 Octree 压缩,则支持["xyz"]

  • 若采用 Draco 库 Kdtree 压缩,则支持["xyz"]或者["xyz", "intensity"]

string

参与压缩的 PCD 属性字段值。可选参数为:

  • xyz

  • intensity

["xyz"]
KdtreeOptionKdtreeOption

Kdtree 压缩参数。

OctreeOptionOctreeOption

Octree 压缩参数。

UserDatastring

用户自定义信息,在异步消息通知中会为您返回,方便您系统内对消息通知进行关联处理。最大长度为 2048 字节。

{"ID": "user1","Name": "test-user1","Avatar": "http://example.com?id=user1"}
Tagsobject

自定义标签,用于对异步任务进行搜索、过滤。

{"LabelKey": "Value"}
CredentialConfigCredentialConfig

如无特殊需求,请保持留空即可。

链式授权配置,非必填。更多信息,请参见使用链式授权访问其他实体资源

NotificationNotification

消息通知配置,详细内容请单击 Notification 查看,异步通知消息格式请参见异步通知消息格式

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

CA995EFD-083D-4F40-BE8A-BDF75FFF****
TaskIdstring

任务 ID。

PointCloudCompress-badda57d-a3ab-4e6d-938f-49b77ce****
EventIdstring

事件 ID。

0B7-1LR4Wcue1aBhk2xT85MfL*****

示例

正常返回示例

JSON格式

{
  "RequestId": "CA995EFD-083D-4F40-BE8A-BDF75FFF****",
  "TaskId": "PointCloudCompress-badda57d-a3ab-4e6d-938f-49b77ce****",
  "EventId": "0B7-1LR4Wcue1aBhk2xT85MfL*****"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-04-03OpenAPI 入参发生变更查看变更详情
2023-03-09OpenAPI 入参发生变更查看变更详情
2022-08-16新增 OpenAPI查看变更详情