CreateCompressPointCloudTask - Intelligent Media Management

Compresses point cloud data (PCD) in Object Storage Service (OSS) to reduce the amount of data transferred over networks.

Operation description

Before you call this operation, make sure that you are familiar with the billing of Intelligent Media Management (IMM).****

**

Note Asynchronous processing does not guarantee timely task completion.
This operation supports only Point Cloud Data (PCD) files.
This operation is an asynchronous operation. After a task is executed, the task information is retained only for seven days and cannot be retrieved when the retention period elapses. You can call the GetTask or ListTasks operation to query information about the task.`` If you specify Notification , you can obtain information about the task based on notifications. >

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
imm:CreateCompressPointCloudTask	create	*Project `acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
ProjectName	string	Yes	The name of the project. For more information, see CreateProject .	test-project
SourceURI	string	Yes	The OSS URL of the PCD file. Specify the value in the oss://${Bucket}/${Object} format. `${Bucket}` specifies the name of the OSS bucket that resides in the same region as the current project. `${Object}` specifies the path of the object with the extension included.	oss://test/src/test.pcd
TargetURI	string	Yes	The OSS URL of the output file after compression. Specify the value in the oss://${Bucket}/${Object} format. `${Bucket}` specifies the name of the OSS bucket that resides in the same region as the current project. `${Object}` specifies the path of the object with the extension included.	oss://test/tgt
PointCloudFileFormat	string	No	The file format. Set the value to the default value: pcd.	pcd
CompressMethod	string	Yes	The compression algorithm. Valid values: octree kdtree	octree
PointCloudFields	array	Yes	The PCD property fields and the compression order in which the data is decompressed after the compression is complete. If octree of Point Cloud Library (PCL) is used for compression, ["xyz"] is supported. If Draco k-dimensional (k-d) tree is used for compression, ["xyz"] and ["xyz", "intensity"] are supported.
	string	Yes	The value of the PCD property field in compression. Valid values: xyz intensity	["xyz"]
KdtreeOption	KdtreeOption	No	The k-d tree compression options.
OctreeOption	OctreeOption	No	The octree compression options.
UserData	string	No	The custom data, which is returned in an asynchronous notification and facilitates notification management. The maximum length is 2,048 bytes.	{"ID": "user1","Name": "test-user1","Avatar": "http://example.com?id=user1"}
Tags	object	No	The custom tags, which can be used to search for and filter asynchronous tasks.	{"LabelKey": "Value"}
CredentialConfig	CredentialConfig	No	If you have no special requirements, leave this parameter empty. The configurations of authorization chains. This parameter is optional. For more information, see Use authorization chains to access resources of other entities.
Notification	Notification	No	The notification settings. For information about the asynchronous notification format, see Asynchronous message examples.

Response parameters

Parameter	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

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-04-03	The request parameters of the API has changed	View Change Details
2023-03-09	The request parameters of the API has changed	View Change Details
2022-08-16	Add Operation	View Change Details