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

Obtiene una lista paginada de procesos de despliegue. También puede filtrar esta lista según criterios específicos.

Descripción de la operación

Importante

Es posible que las versiones anteriores del SDK no incluyan esta operación. Si es así, utilice la operación ListDeployments, que acepta los mismos parámetros.

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

dataworks:*

list

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
ProjectId	integer	Sí	El ID del espacio de trabajo de DataWorks. Puede obtener este ID en la página Administración de espacios de trabajo de la consola de DataWorks. Este parámetro especifica el espacio de trabajo de DataWorks que se usará para la llamada a la API.	10000
Creator	string	No	Filtra los resultados por el creador de la canalización.	110755000425****
Status	string	No	Filtra los resultados por el estado actual de la canalización. Valores válidos: `Init`: inicializando `Running`: en ejecución `Success`: exitoso `Fail`: fallido `Termination`: terminado `Cancel`: cancelado	Running
ObjectId	string	No	El ID del artefacto.	860438872620113XXXX
PageNumber	integer	No	El número de página. Las páginas comienzan en 1. Valor predeterminado: 1.	1
PageSize	integer	No	El número de entradas por página. Valor predeterminado: 10. Valor máximo: 100.	10

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	El esquema de respuesta.
RequestId	string	El ID de la solicitud. Utilice este ID para localizar registros y solucionar problemas.	7C352CB7-CD88-50CF-9D0D-E81BDF02XXXX
PagingInfo	object	La información de paginación.
TotalCount	integer	El número total de entradas que cumplen con los criterios de filtro.	2524
PageSize	integer	El número de entradas por página.	10
PageNumber	integer	El número de página devuelto.	1
PipelineRuns	array<object>	Una lista de ejecuciones de la canalización de despliegue.
	array<object>	Una ejecución de la canalización de despliegue.
Id	string	El ID de la ejecución de la canalización de despliegue.	097c73fe-ed6e-4fb1-b109-a5d59e46cd58
ProjectId	integer	El ID del proyecto.	70199
CreateTime	integer	La marca de tiempo de creación de la ejecución de la canalización de despliegue.	1702736654000
ModifyTime	integer	La marca de tiempo de la última modificación de la ejecución de la canalización de despliegue.	1702736654000
Creator	string	El creador de la ejecución de la canalización de despliegue.	110755000425XXXX
Status	string	El estado de la ejecución de la canalización de despliegue. Valores válidos: `Init`: inicializando `Running`: en ejecución `Success`: exitoso `Fail`: fallido `Termination`: terminado `Cancel`: cancelado Valores válidos: Init : 初始化 Cancel : 被取消 Running : 运行中 Termination : 被终止 Success : 运行成功 Fail : 运行失败	Running
Message	string	El mensaje de error devuelto si la ejecución de la canalización de despliegue falla.	Error message
Stages	array<object>	Una lista de etapas de despliegue.
	array<object>	Una etapa de despliegue.
Code	string	El código de la etapa de despliegue.	DEV_CHECK
Step	integer	El número de paso de la etapa de despliegue.	1
Type	string	El tipo de etapa de despliegue. Valores válidos: `Deploy`: una operación de despliegue `Check`: una operación de comprobación `Offline`: una operación de desconexión `Build`: una operación de compilación `Delete`: una operación de eliminación	Check
Name	string	El nombre de la etapa.	Check before going online to development
Description	string	La descripción de la etapa.	Check before going online to development
Message	string	El mensaje de error devuelto si la etapa de despliegue falla.	Error message
Status	string	El estado de la etapa de despliegue. Valores válidos: `Init`: inicializando `Running`: en ejecución `Success`: exitoso `Fail`: fallido `Termination`: terminado `Cancel`: cancelado	Running
Detail	object	Información adicional sobre la etapa de despliegue.
	any	Detalles adicionales de la etapa, devueltos como pares clave-valor.	{ "checkerList": [ { "code": "BuildPackageChecker", "name": "package check" }, { "code": "NodeParentDependency", "name": "downstream dependency check" }, { "code": "NodeInProcess", "name": "offline process check" } ] }
Description	string	La descripción de la ejecución de la canalización de despliegue.	发布流程描述信息

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "7C352CB7-CD88-50CF-9D0D-E81BDF02XXXX",
  "PagingInfo": {
    "TotalCount": 2524,
    "PageSize": 10,
    "PageNumber": 1,
    "PipelineRuns": [
      {
        "Id": "097c73fe-ed6e-4fb1-b109-a5d59e46cd58",
        "ProjectId": 70199,
        "CreateTime": 1702736654000,
        "ModifyTime": 1702736654000,
        "Creator": "110755000425XXXX",
        "Status": "Running",
        "Message": "Error message",
        "Stages": [
          {
            "Code": "DEV_CHECK",
            "Step": 1,
            "Type": "Check",
            "Name": "Verificación antes de pasar a desarrollo",
            "Description": "Verificación antes de pasar a desarrollo",
            "Message": "Error message",
            "Status": "Running",
            "Detail": {
              "key": "{\n  \"checkerList\": [\n    {\n      \"code\": \"BuildPackageChecker\",\n      \"name\": \"verificación de paquete\"\n    },\n    {\n      \"code\": \"NodeParentDependency\",\n      \"name\": \"verificación de dependencia descendente\"\n    },\n    {\n      \"code\": \"NodeInProcess\",\n      \"name\": \"verificación de proceso sin conexión\"\n    }\n  ]\n}"
            }
          }
        ],
        "Description": "发布流程描述信息"
      }
    ]
  }
}

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.