CreateCompressPointCloudTask - Intelligent Media Management

The point cloud compression feature compresses point cloud data in Object Storage Service (OSS). This helps reduce data transmission over the network.

Operation description

Before you use this API, make sure that you understand the billing methods and pricing of Intelligent Media Management.
Important The completion time of asynchronous tasks is not guaranteed.
File format: Only point cloud files in the PCD format are supported.
This is an asynchronous API. After a task starts, its information is saved for only 7 days. After this period, the information cannot be retrieved. To view task information, call the GetTask or ListTasks operation and use the returned TaskId. You can also set the Notification parameter to receive task information through notification messages.

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 more information, see Create a project.	test-project
SourceURI	string	Yes	The OSS URI of the point cloud file. The URI must be in the format oss://${Bucket}/${Object}. ${Bucket} is the name of the OSS bucket in the same region as the project. ${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 output file after compression. The URI must be in the format oss://${Bucket}/${Object}. ${Bucket} is the name of the OSS bucket in the same region as the project. ${Object} is the full path of the file, including the file name extension.	oss://test/tgt
PointCloudFileFormat	string	No	The format of the point cloud file. Only the PCD format is supported. The default value is pcd.	pcd
CompressMethod	string	Yes	The name of the compression algorithm. Valid values: octree: octree kdtree: K-d tree	octree
PointCloudFields	array	Yes	The PCD property fields to compress and the compression order. After compression, the data is decompressed in this order. If you use Octree compression from the Point Cloud Library (PCL), only ["xyz"] is supported. If you use K-d tree compression from the Draco library, ["xyz"] or ["xyz", "intensity"] is supported.
	string	No	The PCD property field to compress. Valid values: xyz intensity	["xyz"]
KdtreeOption	KdtreeOption	No	The parameters for K-d tree compression.
OctreeOption	OctreeOption	No	The parameters for Octree compression.
UserData	string	No	Custom information that is returned in the asynchronous notification message. You can use this information to associate notification messages in your system. The maximum length is 2048 bytes.	{"ID": "user1","Name": "test-user1","Avatar": "http://example.com?id=user1"}
Tags	object	No	Custom tags to search for and filter asynchronous tasks.	{"LabelKey": "Value"}
CredentialConfig	CredentialConfig	No	If you do not have special requirements, leave this parameter empty. The chained authorization configuration. This parameter is not required. For more information, see Use chained authorization to access other entity resources.
Notification	Notification	No	The notification configuration. For more information, click Notification. For the format of asynchronous notification messages, see Asynchronous notification message format. Note Intelligent Media Management API callbacks do not support specifying a webhook address. Use MNS instead.

Response elements

Element	Type	Description	Example
	object	Response schema
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.