GetUserUploadFileJob - Data Management - Centro de documentación de Alibaba Cloud

Obtiene la información de una tarea de carga de archivos.

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

dms:GetUserUploadFileJob

get

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
JobKey	string	Sí	La clave de la tarea de carga de archivos. La clave se devuelve cuando se llama a la operación CreateUploadFileJob o CreateUploadOSSFileJob.	65254a49100e
Tid	integer	No	The tenant ID. Nota To view the tenant ID, move the pointer over the profile picture in the upper-right corner of the Data Management (DMS) console. For more information, see Manage DMS tenants.	-1

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Esquema de la respuesta.
RequestId	string	El ID de la solicitud.	BDEFE9F2-B3B4-42D0-83AE-ECF9FC067DCD
Success	boolean	Indica si la solicitud se realizó correctamente.	true
ErrorMessage	string	El mensaje de error.	UnknownError
ErrorCode	string	El código de error.	UnknownError
UploadFileJobDetail	object	Los detalles de la tarea de carga de archivos.
JobKey	string	La clave de la tarea de carga de archivos.	65254a4c1614235217749100e
FileName	string	El nombre del archivo.	test.sql
FileSize	integer	El tamaño del archivo. Unidad: byte.	2968269
FileSource	string	El propósito del archivo cargado. Valores válidos: datacorrect: El archivo se carga para modificar datos. order_info_attachment: El archivo se carga como adjunto en un ticket. big-file: El archivo se carga para importar varios registros de datos a la vez. sqlreview: El archivo se carga para revisión de SQL.	datacorrect
UploadType	string	El método utilizado para cargar el archivo. Valores válidos: URL OSS	URL
UploadURL	string	La URL del archivo. Nota Este parámetro se devuelve si el valor de UploadType es URL.	http://xxxx/test.sql
UploadOSSParam	object	La información sobre el bucket de Object Storage Service (OSS) desde el cual se carga el archivo. Nota Este parámetro se devuelve si el valor de UploadType es OSS.
Endpoint	string	El endpoint del bucket de OSS.	http://oss-cn-hangzhou.aliyuncs.com
BucketName	string	El nombre del bucket de OSS.	test_bucket
ObjectName	string	El nombre del objeto de OSS.	test.sql
UploadedSize	integer	El tamaño del archivo cargado. Unidad: byte.	2968269
JobStatus	string	El estado de la tarea de carga de archivos. Valores válidos: INIT: La tarea de carga de archivos se inicializó. PENDING: La tarea de carga de archivos estaba en espera de ejecución. BE_SCHEDULED: La tarea de carga de archivos estaba en espera de programación. FAIL: La tarea de carga de archivos falló. SUCCESS: La tarea de carga de archivos se completó correctamente. RUNNING: La tarea de carga de archivos se estaba ejecutando.	SUCCESS
JobStatusDesc	string	La información sobre el estado de la tarea de carga de archivos.	success
AttachmentKey	string	La clave del archivo que se devuelve después de cargar el archivo. Puede utilizar esta clave cuando cargue el archivo como adjunto en un ticket.	upload_3c7edea3-e4c3-4403-857d-737043036f69_test.sql

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "BDEFE9F2-B3B4-42D0-83AE-ECF9FC067DCD",
  "Success": true,
  "ErrorMessage": "UnknownError",
  "ErrorCode": "UnknownError",
  "UploadFileJobDetail": {
    "JobKey": "65254a4c1614235217749100e",
    "FileName": "test.sql",
    "FileSize": 2968269,
    "FileSource": "datacorrect",
    "UploadType": "URL",
    "UploadURL": "http://xxxx/test.sql",
    "UploadOSSParam": {
      "Endpoint": "http://oss-cn-hangzhou.aliyuncs.com",
      "BucketName": "test_bucket",
      "ObjectName": "test.sql"
    },
    "UploadedSize": 2968269,
    "JobStatus": "SUCCESS",
    "JobStatusDesc": "success",
    "AttachmentKey": "upload_3c7edea3-e4c3-4403-857d-737043036f69_test.sql"
  }
}

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.