Converts multiple images into one single PDF file and stores the PDF file to the specified path in Object Storage Service (OSS).
Operation description
- Before you call this operation, make sure that you are familiar with the billing of Intelligent Media Management (IMM).****
- Make sure that the specified project exists in the current region. For more information, see Project management.
- You can specify up to 100 images in a call to the operation.
- This operation is an asynchronous operation. After a task is executed, the task information is saved only for seven days. When the retention period ends, the task information can no longer be retrieved. 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
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 Resourcesis 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:CreateImageToPDFTask | create | *Project acs:imm:{#regionId}:{#accountId}:project/{#ProjectName} |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| ProjectName | string | Yes | test-project | |
| Sources | array<object> | Yes | The list of images. The sequence of image URIs in the list determines the order in which they are converted. | |
| object | Yes | The image. | ||
| URI | string | Yes | The OSS URI of the input image. Specify the OSS URI in the oss://${Bucket}/${Object} format, where The operation supports the following image formats: JPG, JP2, PNG, TIFF, WebP, BMP, and SVG. | oss://examplebucket/sampleobject.jpg |
| Rotate | long | No | The rotation angle. Valid values:
| 90 |
| TargetURI | string | Yes | The OSS URI of the output file. Specify the OSS URI in the oss://${bucketname}/${objectname} format, where ${bucketname} is the name of the bucket in the same region as the current project and ${objectname} is the path of the object with the extension included. | oss://examplebucket/outputDocument.pdf |
| UserData | string | No | The custom information, which is returned in an asynchronous notification and facilitates notification management. The maximum length of the value is 2,048 bytes. | test-data |
| CredentialConfig | CredentialConfig | No | If you have no special requirements, leave this parameter empty. The configurations of authorization chains. For more information, see Use authorization chains to access resources of other entities. | |
| Tags | object | No | The custom tags. You can search for or filter asynchronous tasks by custom tag. | { "User": "Jane" } |
| Notification | Notification | No | The notification settings. For information about the asynchronous notification format, see Asynchronous message examples. |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "EC564A9A-BA5C-4499-A087-D9B9E76E*****",
"EventId": "0ED-1Bz8z71k5TtsUejT4UJ16Es*****",
"TaskId": "ImageToPDF-cbe6ae3e-f8dc-4566-9da7-535d5d*****"
}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 |