Compress Point Cloud Data with CreateCompressPointCloudTask - IMM - Alibaba Cloud - Intelligent Media Management

Compresses point cloud data stored in Object Storage Service (OSS) to reduce network data transmission.

Operation description

Before you use this operation, make sure that you are familiar with the billing of Intelligent Media Management (IMM). For more information, see Billing.
Important Asynchronous tasks do not guarantee timeliness.
File format limit: Only point cloud files in PCD format are supported.
This is an asynchronous operation. After the task starts, task information is retained for only 7 days. After 7 days, the task information can no longer be retrieved. Call the GetTask or ListTasks operation to obtain the returned TaskId and view the task information. You can also configure the Notification parameter to receive task information through message notifications.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

imm:CreateCompressPointCloudTask

create

*Project

acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}

None

Request parameters

Parameter	Type	Required	Description	Example
ProjectName	string	Yes	The project name. For information about how to obtain the project name, see Create a project.	test-project
SourceURI	string	Yes	The OSS URI of the point cloud file. The OSS URI follows the format oss://${Bucket}/${Object}, where `${Bucket}` is the name of an OSS bucket in the same region as the current project, and `${Object}` is the full path of the file including the file name extension.	oss://test/src/test.pcd
TargetURI	string	Yes	The OSS URI of the compressed output file. The OSS URI follows the format oss://${Bucket}/${Object}, where `${Bucket}` is the name of an OSS bucket in the same region as the current project, and `${Object}` is the full path of the file including the file name extension.	oss://test/tgt
PointCloudFileFormat	string	No	The point cloud file format. Only PCD format is supported. Default value: pcd. Valid values: pcd : point cloud file format.	pcd
CompressMethod	string	Yes	The compression algorithm. Valid values: octree: octree kdtree: K-d tree Valid values: octree : octree. kdtree : K-d tree.	octree
PointCloudFields	array	Yes	The PCD attribute fields that participate in compression and the compression order. After compression, data is decompressed in this order. If you use PCL library octree compression, ["xyz"] is supported. If you use Draco library K-d tree compression, ["xyz"] or ["xyz", "intensity"] is supported.
	string	No	The PCD attribute field value that participates in compression. Valid values: xyz intensity	["xyz"]
KdtreeOption	KdtreeOption	No	The K-d tree compression parameters.
OctreeOption	OctreeOption	No	The octree compression parameters.
UserData	string	No	The custom information, which is returned in asynchronous message notifications to help you associate message notifications within your system. Maximum length: 2,048 bytes.	{"ID": "user1","Name": "test-user1","Avatar": "http://example.com?id=user1"}
Tags	object	No	The custom tags that are used to search for and filter asynchronous tasks.	{"LabelKey": "Value"}
CredentialConfig	CredentialConfig	No	Leave this parameter empty unless you have special requirements. The China authorization configuration. This parameter is optional. For more information, see Use chained authorization to access resources of other entities.
Notification	Notification	No	The message notification configuration. For more information, click Notification. For information about the format of asynchronous notification messages, see Asynchronous notification message format. Note Intelligent Media Management does not support specifying a callback URL for API call callbacks. Use Message Service (MNS) instead.

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	CA995EFD-083D-4F40-BE8A-BDF75FFF****
TaskId	string	The task ID.	PointCloudCompress-badda57d-a3ab-4e6d-938f-49b77ce****
EventId	string	The event ID.	0B7-1LR4Wcue1aBhk2xT85MfL*****

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.