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

Consulta una lista de paquetes de despliegue. Esta operación equivale a ver una lista de paquetes de despliegue en la página Paquetes de despliegue de la consola de DataWorks.

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
ProjectIdentifier	string	No	El nombre del espacio de trabajo de DataWorks. Puede iniciar sesión en la consola de DataWorks e ir a la página de configuración del espacio de trabajo para obtener el nombre del espacio de trabajo. Debe configurar este parámetro o el parámetro ProjectId para determinar el espacio de trabajo de DataWorks al que se aplica la operación.	dw_project
ProjectId	integer	No	El ID del espacio de trabajo de DataWorks. Puede iniciar sesión en la consola de DataWorks e ir a la página de configuración del espacio de trabajo para obtener el ID del espacio de trabajo. Debe configurar este parámetro o el parámetro ProjectIdentifier para determinar el espacio de trabajo de DataWorks al que se aplica la operación.	10000
Creator	string	No	El ID de la cuenta de Alibaba Cloud que utiliza el usuario que crea los paquetes de despliegue.	20030****
EndCreateTime	integer	No	El límite superior del tiempo de creación de los paquetes de despliegue que se van a consultar. Este valor debe ser una marca de tiempo UNIX que represente el número de milisegundos transcurridos desde el 1 de enero de 1970, 00:00:00 UTC.	1593877765000
Executor	string	No	El ID de la cuenta de Alibaba Cloud que utiliza el usuario que ejecuta los paquetes de despliegue.	2003****
EndExecuteTime	integer	No	El límite superior del tiempo de inicio de ejecución de los paquetes de despliegue. Este valor debe ser una marca de tiempo UNIX que represente el número de milisegundos transcurridos desde el 1 de enero de 1970, 00:00:00 UTC.	1593877765000
Status	integer	No	El estado de los paquetes de despliegue. Valores válidos: 0: Los paquetes de despliegue están listos. 1: Los paquetes de despliegue están desplegados. 2: Los paquetes de despliegue no se pudieron desplegar. 6: Los paquetes de despliegue están rechazados.	1
Keyword	string	No	La palabra clave contenida en los nombres de los paquetes de despliegue. Se admite una búsqueda aproximada. Después de escribir una palabra clave, se muestran todos los paquetes de despliegue cuyos nombres contienen la palabra clave.	hello
PageNumber	integer	No	El número de página.	1
PageSize	integer	No	El número de entradas por página. Valor predeterminado: 10. Valor máximo: 100.	20

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Los parámetros de respuesta.
RequestId	string	El ID de la solicitud.	0000-ABCD-EFG
Data	object	Los datos devueltos.
PageNumber	integer	El número de página.	1
PageSize	integer	El número de entradas por página.	10
TotalCount	integer	El número total de entradas que coinciden con las condiciones de consulta.	13
Deployments	array<object>	Los paquetes de despliegue.
	object	Los detalles del paquete de despliegue.
Status	integer	El estado del paquete de despliegue. Valores válidos: 0: El paquete de despliegue está listo. 1: El paquete de despliegue está desplegado. 2: El paquete de despliegue no se pudo desplegar. 6: El paquete de despliegue está rechazado.	1
ErrorMessage	string	El mensaje de error que se devuelve cuando el paquete de despliegue falla.	OK
CreateTime	integer	La hora en que se creó el paquete de despliegue.	1593877765000
Executor	string	El ID de la cuenta de Alibaba Cloud que utilizó el usuario que ejecutó el paquete de despliegue.	2003****
Creator	string	El ID de la cuenta de Alibaba Cloud que utilizó el usuario que creó el paquete de despliegue.	2003****
ExecuteTime	integer	La hora en que se ejecutó el paquete de despliegue. Este valor es una marca de tiempo UNIX que representa el número de milisegundos transcurridos desde el 1 de enero de 1970, 00:00:00 UTC.	1593877765000
Name	string	El nombre del paquete de despliegue.	auto_created
Id	integer	El ID del paquete de despliegue. Puede llamar a la operación GetDeployment con este ID para consultar los detalles del paquete de despliegue.	11111

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "0000-ABCD-EFG",
  "Data": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 13,
    "Deployments": [
      {
        "Status": 1,
        "ErrorMessage": "OK",
        "CreateTime": 1593877765000,
        "Executor": "2003****",
        "Creator": "2003****",
        "ExecuteTime": 1593877765000,
        "Name": "auto_created",
        "Id": 11111
      }
    ]
  }
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error
500	InternalError.System	An internal system error occurred. Try again later.
403	Forbidden.Access	Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.
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.