点云压缩功能可以将OSS中的点云数据进行压缩处理,减少网络数据传输。
接口说明
-
请确保在使用该接口前,已充分了解智能媒体管理产品的收费方式和价格。
注意 异步任务不保证时效。 -
文件格式限制:当前仅支持 PCD 格式的点云文件。
-
该接口为异步接口,获取任务开始执行后,任务信息只保存 7 天,超过 7 天则无法再获取。调用 GetTask 或 ListTasks 接口获取返回的
TaskId
,查看任务信息。也可以通过设置 Notification 消息通知参数,通过消息通知获取任务信息。>
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
imm:CreateCompressPointCloudTask | create |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ProjectName | string | 是 | 项目名称,获取方式请参见创建项目。 | test-project |
SourceURI | string | 是 | 点云文件的 OSS 地址。 OSS 地址规则为 oss://${Bucket}/${Object},其中 | oss://test/src/test.pcd |
TargetURI | string | 是 | 压缩后输出文件的 OSS 地址。 OSS 地址规则为 oss://${Bucket}/${Object},其中 | oss://test/tgt |
PointCloudFileFormat | string | 否 | 点云文件格式。当前只支持 PCD 格式,默认值为 pcd。 | pcd |
CompressMethod | string | 是 | 压缩算法名称。取值如下:
| octree |
PointCloudFields | array | 是 | 参与压缩的 PCD 属性字段以及压缩顺序,压缩完成后以此顺序进行解压数据。
| |
string | 是 | 参与压缩的 PCD 属性字段值。可选参数为:
| ["xyz"] | |
KdtreeOption | KdtreeOption | 否 | Kdtree 压缩参数。 | |
OctreeOption | OctreeOption | 否 | Octree 压缩参数。 | |
UserData | string | 否 | 用户自定义信息,在异步消息通知中会为您返回,方便您系统内对消息通知进行关联处理。最大长度为 2048 字节。 | {"ID": "user1","Name": "test-user1","Avatar": "http://example.com?id=user1"} |
Tags | object | 否 | 自定义标签,用于对异步任务进行搜索、过滤。 | {"LabelKey": "Value"} |
CredentialConfig | CredentialConfig | 否 | 如无特殊需求,请保持留空即可。 链式授权配置,非必填。更多信息,请参见使用链式授权访问其他实体资源。 | |
Notification | Notification | 否 | 消息通知配置,详细内容请单击 Notification 查看,异步通知消息格式请参见异步通知消息格式。 |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "CA995EFD-083D-4F40-BE8A-BDF75FFF****",
"TaskId": "PointCloudCompress-badda57d-a3ab-4e6d-938f-49b77ce****",
"EventId": "0B7-1LR4Wcue1aBhk2xT85MfL*****"
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2023-04-03 | OpenAPI 入参发生变更 | 查看变更详情 |
2023-03-09 | OpenAPI 入参发生变更 | 查看变更详情 |
2022-08-16 | 新增 OpenAPI | 查看变更详情 |