GetDeploymentPackage - DataWorks - Centro de documentación de Alibaba Cloud

Obtiene los detalles de un paquete de despliegue.

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

No se requiere autorización para esta operación. Si experimenta problemas al ejecutarla, póngase en contacto con el soporte técnico.

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
ProjectId	integer	No	El ID del espacio de trabajo de DataWorks. Inicie sesión en la consola de DataWorks y acceda a la página de configuración del espacio de trabajo para obtener el ID del espacio de trabajo. Este parámetro especifica el espacio de trabajo de DataWorks para esta llamada a la API.	10000
ProjectIdentifier	string	No	El identificador único del espacio de trabajo de DataWorks, que es el identificador en inglés que se muestra en la parte superior de la página de Data Studio para cambiar de espacio de trabajo. Debe especificar este parámetro o ProjectId para determinar el espacio de trabajo de DataWorks para esta llamada a la API.	dw_project
DeploymentId	integer	Sí	El ID del paquete de despliegue. Se genera un ID de paquete de despliegue al llamar a SubmitFile o DeployFile.	1000000001

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	La respuesta.
HttpStatusCode	integer	El código de estado HTTP.	200
ErrorMessage	string	El mensaje de error.	You have no permission.
RequestId	string	El ID de la solicitud. Puede usar este ID para localizar registros y solucionar problemas.	0bc1ec92159376****
ErrorCode	string	El código de error.	Invalid.Tenant.ConnectionNotExists
Success	boolean	Indica si la llamada se realizó correctamente. true: la llamada se realizó correctamente. false: la llamada falló.	true
Data	object	Los detalles del paquete de despliegue.
Deployment	object	Los detalles del paquete de despliegue.
Status	integer	El estado actual del paquete de despliegue. Valores válidos: 0: listo 1: correcto 2: fallido	1
ErrorMessage	string	El mensaje de error registrado cuando falla la ejecución del paquete de despliegue (el estado es 2).	Success
FromEnvironment	integer	El entorno desde el que se inicia el despliegue. Valores válidos: 0: local 1: entorno de desarrollo	0
ToEnvironment	integer	El entorno de destino al que se despliega la información del archivo. Valores válidos: 1: entorno de desarrollo 2: entorno de producción	1
CheckingStatus	integer	El estado de comprobación de los nodos involucrados en el paquete de despliegue. Cuando el entorno de destino es el entorno de desarrollo (toEnvironment=1), puede desplegar el archivo en el entorno de producción solo cuando el Status del paquete de despliegue es 1 y CheckingStatus está vacío. 7: la comprobación falló. 8: la comprobación está en curso.	7
CreateTime	integer	La marca de tiempo en la que se generó el paquete de despliegue, en milisegundos.	1593877765000
HandlerId	string	El ID de usuario de Alibaba Cloud del usuario que ejecutó el paquete de despliegue.	2003****
CreatorId	string	El ID de usuario de Alibaba Cloud del usuario que creó el paquete de despliegue.	20030****
ExecuteTime	integer	La marca de tiempo en la que el paquete de despliegue comenzó a ejecutarse, en milisegundos.	1593877765000
Name	string	El nombre del paquete de despliegue, que se muestra en la página Publicación de tareas > Lista de paquetes de despliegue.	ods_user_info_d-2020-07-04_20030****
DeployedItems	array<object>	Los detalles de los elementos desplegados.
	object	Los detalles de los elementos desplegados.
FileId	integer	El ID del archivo.	5076****
FileVersion	integer	La versión del archivo.	7
Status	integer	El estado del elemento desplegado. Valores válidos: UNPUBLISHED(0): no desplegado SUCCESS(1): desplegado correctamente ERROR(2): despliegue fallido CLONED(3): clonado correctamente DEPLOY_ERROR(4): despliegue fallido CLONING(5): clonación en curso REJECT(6): despliegue rechazado	1

Ejemplos

Respuesta exitosa

JSON Formato

{
  "HttpStatusCode": 200,
  "ErrorMessage": "You have no permission",
  "RequestId": "0bc1ec92159376****",
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists",
  "Success": true,
  "Data": {
    "Deployment": {
      "Status": 1,
      "ErrorMessage": "Success",
      "FromEnvironment": 0,
      "ToEnvironment": 1,
      "CheckingStatus": 7,
      "CreateTime": 1593877765000,
      "HandlerId": "2003****",
      "CreatorId": "20030****",
      "ExecuteTime": 1593877765000,
      "Name": "ods_user_info_d-2020-07-04_20030****"
    },
    "DeployedItems": [
      {
        "FileId": 0,
        "FileVersion": 7,
        "Status": 1
      }
    ]
  }
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
500	InternalError.System	An internal system error occurred. Try again later.
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.
403	Forbidden.Access	Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.	Acceso denegado. Autorice primero.
429	Throttling.Api	The request for this resource has exceeded your available limit.
429	Throttling.System	The DataWorks system is busy. Try again later.
429	Throttling.User	Your request is too frequent. Try again later.

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.