Loading...

Aviso:

Para brindarle información de soporte completa de manera más rápida, el contenido de esta página ha sido traducido al español mediante traducción automática. Para consultar la información de soporte más precisa, consulte la versión en inglés de este contenido.

Ejecutar Pipelines

Esta API te permite activar el pipeline en una rama particular del repositorio Git. Esto se puede hacer pasando el nombre de la rama como parámetro en el cuerpo de la solicitud. Al activar pipelines manuales, simplemente puedes ignorar el parámetro del nombre de la rama en el JSON de la solicitud.

Al activar esta API, el pipeline se ejecutará y el estado de la ejecución se devolverá como respuesta.

Obtener detalles del Pipeline

Esta API te permite obtener los detalles de un pipeline creado en la consola de Catalyst. Esto se puede hacer pasando el pipeline_id y el project_id en la URL de solicitud. La API obtiene los detalles del proyecto en el que se creó el pipeline y los detalles del pipeline.

Detalles de la solicitud

URL de solicitud

POST

{api-domain}/baas/v1/project/{project_id}/pipeline/{pipeline_id}/run

copy

api-domain
URL
La URL del dominio de tu DC

project_id
Numerical

El ID único del proyecto en el que se ha creado el pipeline


pipeline_id
Numerical

El ID único del pipeline para el que se deben obtener los detalles.


Propiedades JSON de la solicitud

BRANCH_NAME string
mandatory
Proporciona el nombre de la rama de Git
EVENT string
optional
Proporciona cualquier detalle del evento
URL url
optional
Cualquier parámetro adicional requerido

Nota:

  1. BRANCH_NAME es opcional cuando necesitas activar un pipeline manual de Catalyst.
  2. Hemos agregado las claves EVENT y URL como variables de entorno. Puedes pasar cualquier clave requerida para la ejecución del pipeline en el JSON del evento.

Alcance

pipeline.execution.CREATE

Detalles de la respuesta

Se devolverá como respuesta un objeto que contiene los detalles del historial de creación del pipeline. El objeto incluye detalles como el history_id, event_time, history_status.

Sample Request
copy

curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/pipeline/29810101101/run -H “Authorization: Zoho-oauthtoken 1000.91016.2f57”
-d ‘{ “BRANCH_NAME” : “main”,
“EVENT”: “push”, \ “URL”: “https://www.google.com”
}

Sample Response
copy

{ “status”: “success”, “data”: { “history_id”: “5000000021007”, “pipeline_id”: “29810101101”, “event_time”: “Mar 20, 2024 02:02 PM”, “event_details”: { “BRANCH_NAME”: “main”, “EVENT”: “push”, “URL”: “https://www.google.com” }, “history_status”: “Queued” } }