CreateOfficeConversionTask - Intelligent Media Management - Centro de documentación de Alibaba Cloud

Crea una tarea de conversión de documentos que convierte archivos, como Word, PowerPoint, Excel y PDF, almacenados en Object Storage Service (OSS) a imágenes, archivos de texto o archivos PDF.

Descripción de la operación

Antes de utilizar esta operación, asegúrese de comprender los métodos de facturación y los precios de Intelligent Media Management (IMM).
Importante No se garantiza el tiempo de ejecución de las tareas asíncronas.
Formatos de archivo de entrada admitidos:
- Documentos de procesamiento de textos (Word): doc, docx, wps, wpss, docm, dotm, dot y dotx.
- Documentos de presentación (PowerPoint): pptx, ppt, pot, potx, pps, ppsx, dps, dpt, pptm, potm, ppsm y dpss.
- Documentos de hoja de cálculo (Excel): xls, xlt, et, ett, xlsx, xltx, csv, xlsb, xlsm, xltm y ets.
- Documentos PDF: pdf.
Formatos de archivo de salida admitidos:
- Imágenes: png y jpg.
- Texto: txt.
- PDF: pdf.
El tamaño máximo de un solo archivo es de 200 MB. Este límite no se puede modificar.
Si un archivo es grande o su contenido es complejo, la conversión puede agotar el tiempo de espera.
El número de solicitudes por segundo está limitado a 50 para un solo usuario.
La información de la tarea se almacena solo durante 7 días después de que se inicia la tarea. Después de este período, no se puede recuperar la información. Puede obtener la información de la tarea de manera oportuna mediante uno de los siguientes métodos:
- Puede llamar a la operación GetTask o ListTasks para obtener el TaskId devuelto y ver la información de la tarea.
- Puede activar Message Service (MNS) en la misma región que IMM y configurar una suscripción para recibir notificaciones de información de tareas de manera oportuna. Para obtener más información sobre el formato de los mensajes de notificación asíncrona, consulte Formato de mensaje de notificación asíncrona. Para obtener más información sobre el kit de desarrollo de software (SDK) de MNS, consulte Recibir y eliminar mensajes.
- Puede activar RocketMQ en la misma región que IMM, y crear una instancia de RocketMQ 4.0, un tema y un grupo para recibir notificaciones de información de tareas de manera oportuna. Para obtener más información sobre el formato de los mensajes de notificación asíncrona, consulte Formato de mensaje de notificación asíncrona. Para obtener más información sobre cómo utilizar RocketMQ, consulte Utilizar un SDK para HTTP para enviar y recibir mensajes normales.
- Puede activar y conectarse a EventBridge en la misma región que IMM para recibir notificaciones de información de tareas de manera oportuna. Para obtener más información, consulte Eventos de Intelligent Media Management IMM.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

imm:CreateOfficeConversionTask

create

*Project

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

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
ProjectName	string	Sí	El nombre del proyecto. Para obtener más información sobre cómo conseguir el nombre del proyecto, consulte Crear un proyecto.	test-project
SourceURI	string	No	La dirección de almacenamiento de los datos de origen. La dirección de OSS debe tener el formato oss://${Bucket}/${Object}. `${Bucket}` es el nombre del bucket de OSS que se encuentra en la misma región que el proyecto actual. `${Object}` es la ruta completa del archivo, incluida la extensión del nombre del archivo.	oss://test-bucket/test-object
Sources	array<object>	No	Una lista de imágenes de entrada. Las imágenes se convierten en el orden de sus URI en la lista. (Este parámetro aún no se ha publicado. No lo utilice.)	oss://imm-test/test.pptx
	object	No	La información sobre una imagen de entrada.
URI	string	No	La dirección de OSS de la imagen de origen. La dirección de OSS debe tener el formato oss://${Bucket}/${Object}. ${Bucket} es el nombre del bucket de OSS que se encuentra en la misma región que el proyecto actual. ${Object} es la ruta completa del archivo, incluida la extensión del nombre del archivo. Formatos de imagen admitidos: jpg, jp2, png, tiff, webp, bmp y svg.	oss://examplebucket/sampleobject.jpg
Rotate	integer	No	El ángulo de rotación de la imagen. Valores válidos: 0 (predeterminado) 90 180 270	90
TargetURI	string	No	La plantilla para la dirección de salida del documento convertido. La dirección debe tener el formato `oss://{bucket}/{tags.custom}/{dirname}/{barename}.{autoext}`. Para obtener más información, consulte Plantillas de TargetURI. Nota Especifique este parámetro o `TargetURIPrefix`.	oss://examplebucket/outputDocument.pdf
TargetURIPrefix	string	No	El prefijo de la dirección de almacenamiento para el archivo de salida después de la conversión del documento. El prefijo debe tener el formato `oss://${Bucket}/${Prefix}/`. `${Bucket}` es el nombre del bucket de OSS que se encuentra en la misma región que el proyecto actual. `${Prefix}` es el prefijo de la dirección de almacenamiento para el archivo de salida. Nota Especifique este parámetro o `TargetURI`.	oss://examplebucket/outputprefix/
SourceType	string	No	El tipo de extensión de los datos de origen. De forma predeterminada, el tipo de los datos de origen se determina por la extensión del objeto de OSS. Si el objeto de OSS no tiene extensión, puede configurar este parámetro. Valores válidos: Documentos de procesamiento de textos (Word): doc, docx, wps, wpss, docm, dotm, dot y dotx Documentos de presentación (PowerPoint): pptx, ppt, pot, potx, pps, ppsx, dps, dpt, pptm, potm, ppsm y dpss Documentos de hoja de cálculo (Excel): xls, xlt, et, ett, xlsx, xltx, csv, xlsb, xlsm, xltm y ets Documentos PDF: pdf	doc
TargetType	string	Sí	El tipo de archivo de salida. Valores válidos: png: Convierte el documento a imágenes PNG. jpg: Convierte el documento a imágenes JPG. pdf: Convierte el documento a un archivo PDF. txt: Convierte el documento a un archivo de solo texto. Se utiliza principalmente para extraer contenido de texto del archivo. Esta opción solo se admite para documentos de presentación, documentos de procesamiento de textos y documentos de hoja de cálculo. Cuando convierte un documento de hoja de cálculo, se genera un solo archivo txt y las configuraciones de variables relacionadas con hojas no surten efecto.	png
UserData	string	No	La información personalizada. Esta información se devuelve en el mensaje de notificación asíncrona para ayudarle a asociar la notificación con sus servicios. El valor puede tener una longitud de hasta 2,048 bytes.	{ "id": "test-id", "name": "test-name" }
Tags	object	No	Las etiquetas personalizadas. El valor es un diccionario. Puede utilizar etiquetas para buscar tareas.	{ "key": "value" }
StartPage	integer	No	La página inicial para la conversión del documento. El valor predeterminado es 1. Nota Si el archivo de origen es una hoja de cálculo, debe especificar el número de hoja de trabajo. Este parámetro solo surte efecto cuando convierte el documento a imágenes. No surte efecto cuando convierte el documento a un archivo PDF o a un archivo de texto.	1
EndPage	integer	No	La página final para la conversión del documento. El valor predeterminado es -1, lo que indica que se convierten todas las páginas desde la página inicial hasta la última página. Nota Si el archivo de origen es una hoja de cálculo, debe especificar el número de hoja de trabajo (`SheetIndex`). Si el documento tiene muchas páginas, le recomendamos que las convierta en lotes. De lo contrario, la conversión puede agotar el tiempo de espera. Este parámetro solo surte efecto cuando convierte el documento a imágenes. No surte efecto cuando convierte el documento a un archivo PDF o a un archivo de texto.	-1
Password	string	No	La contraseña para abrir el documento. Configure este parámetro si desea convertir un documento protegido con contraseña.	123456
ScalePercentage	integer	No	La relación de escala del documento. Valores válidos: 20 a 199. El valor predeterminado es 100, lo que indica que el documento no se escala. Nota Un valor menor que 100 indica que el documento se reduce. Un valor mayor que 100 indica que el documento se amplía.	100
Quality	integer	No	La calidad del archivo convertido. Valores válidos: 0 a 100. Un valor de 0 indica la calidad más baja y el mejor rendimiento. Un valor de 100 indica la calidad más alta y el peor rendimiento. De forma predeterminada, el sistema establece un valor adecuado según el contenido del documento para equilibrar la calidad y el rendimiento.	60
Pages	string	No	Los números de página a convertir. Este parámetro tiene mayor prioridad que los parámetros `StartPage` y `EndPage`. El formato es el siguiente: Separe varios números de página con comas (,), por ejemplo, 1,2. Especifique un rango de páginas consecutivas con un guion (-), por ejemplo, 1,2-4,7.	1,2-4,7
MaxSheetRow	integer	No	El número máximo de filas a convertir cuando convierte un documento de hoja de cálculo a imágenes. De forma predeterminada, se convierten todas las filas. Nota Este parámetro solo surte efecto cuando configura LongPicture en `true`.	10
MaxSheetColumn	integer	No	El número máximo de columnas a convertir cuando convierte un documento de hoja de cálculo a imágenes. De forma predeterminada, se convierten todas las columnas. Nota Este parámetro solo surte efecto cuando configura LongPicture en `true`.	10
SheetCount	integer	No	El número de hojas de trabajo a convertir a imágenes en el documento de hoja de cálculo. De forma predeterminada, se convierten todas las hojas de trabajo.	1
SheetIndex	integer	No	El número de la hoja de trabajo a convertir a imágenes en el documento de hoja de cálculo. Valores válidos: 1 hasta el número de la última hoja de trabajo. El valor predeterminado es 1.	1
FitToWidth	boolean	No	Cuando convierte un documento de hoja de cálculo a imágenes o a un archivo PDF, especifica si se deben representar todas las columnas en una sola imagen o página PDF. Valores válidos: false (predeterminado): No. El contenido se representa en varias imágenes o páginas PDF. true: Sí. El contenido se representa en una sola imagen o página PDF.	false
FitToHeight	boolean	No	Cuando convierte un documento de hoja de cálculo a imágenes o a un archivo PDF, especifica si se deben representar todas las filas en una sola imagen o página PDF. Valores válidos: false (predeterminado): No. El contenido se representa en varias imágenes o páginas PDF. true: Sí. El contenido se representa en una sola imagen o página PDF.	false
FirstPage	boolean	No	Cuando convierte un documento de hoja de cálculo a imágenes, especifica si se debe devolver solo la primera imagen del resultado de la conversión. El número de filas y columnas en la imagen es el resultado de la división automática. Valores válidos: false (predeterminado): No. Se devuelven todas las imágenes. true: Sí. Solo se devuelve la primera imagen. Esto se utiliza para extraer una miniatura. Nota Este parámetro solo surte efecto si configura el parámetro LongPicture en `true`.	false
PaperSize	string	No	El tamaño de papel para convertir un documento de hoja de cálculo a imágenes. La imagen de salida es similar a una página impresa. Valores válidos: A0 A2 A4 (predeterminado) Nota Este parámetro solo surte efecto cuando se utiliza junto con los parámetros FitToHeight y FitToWidth.	A4
PaperHorizontal	boolean	No	Cuando convierte un documento de hoja de cálculo a imágenes, especifica si se debe colocar el papel horizontalmente. La imagen de salida es similar a una página impresa. Valores válidos: false (predeterminado): No. El papel se coloca verticalmente. true: Sí. El papel se coloca horizontalmente.	false
TrimPolicy	TrimPolicy	No	La política de recorte para la conversión de hojas de cálculo. Por ejemplo, si una hoja de cálculo contiene muchas filas y columnas vacías, se puede generar una gran cantidad de espacio en blanco si no se especifica ninguna política de recorte.
ShowComments	boolean	No	Cuando convierte un documento de procesamiento de textos a imágenes, especifica si se deben mostrar los comentarios. Valores válidos: false (predeterminado): No. Los comentarios no se muestran. true: Sí. Los comentarios se muestran.	false
LongPicture	boolean	No	Cuando convierte un documento a imágenes, especifica si se debe convertir en una imagen larga. Valores válidos: false (predeterminado): No. El documento se convierte en varias imágenes. true: Sí. El documento se convierte en una imagen larga. Nota Puede combinar un máximo de 20 páginas en una imagen larga. Si el número de páginas supera este límite, la tarea de conversión puede fallar.	false
ImageDPI	integer	No	Los DPI de la imagen de salida. Valores válidos: 96 a 600. El valor predeterminado es 96.	96
LongText	boolean	No	Cuando convierte un documento a texto, especifica si se debe convertir en un archivo de texto largo. Valores válidos: false (predeterminado): No. Cada página del documento se convierte en un archivo de texto independiente. true: Sí. Todo el contenido se coloca en un solo archivo de texto.	false
HoldLineFeed	boolean	No	Cuando convierte un documento a texto, especifica si se deben conservar los saltos de línea en el documento. Valores válidos: false (predeterminado): No. Los saltos de línea no se conservan. true: Sí. Los saltos de línea se conservan.	false
CredentialConfig	CredentialConfig	No	Si no tiene requisitos especiales, deje este parámetro vacío. La configuración de autorización encadenada. Este parámetro no es obligatorio. Para obtener más información, consulte Utilizar autorización encadenada para acceder a recursos de otras entidades.
Notification	Notification	No	La configuración de notificación de mensajes. Para obtener más información, haga clic en Notificación. Para obtener más información sobre el formato de los mensajes de notificación asíncrona, consulte Formato de mensaje de notificación asíncrona.

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	La respuesta para la tarea asíncrona.
RequestId	string	El ID de la solicitud.	FF3B7D81-66AE-47E0-BF69-157DCF18*****
TaskId	string	El ID de la tarea.	formatconvert-00bec802-073a-4b61-ba3b-39bc2fdd*****
EventId	string	El ID del evento.	2C2-1I0EG57VR37J4rQ8oKG6C9*****

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "FF3B7D81-66AE-47E0-BF69-157DCF18*****",
  "TaskId": "formatconvert-00bec802-073a-4b61-ba3b-39bc2fdd*****",
  "EventId": "2C2-1I0EG57VR37J4rQ8oKG6C9*****"
}

Códigos de error

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.