activity
El dominio activity tiene 4 acciones. En la superficie meta se alcanzan todas a través de arcane_activity; en la individual, cada una es una herramienta propia; en la dinámica se ejecutan con arcane_execute_action y el ID canónico.
Resumen
Sección titulada «Resumen»| Acción | Título | Tipo |
|---|---|---|
activity.cancel | Cancel a background activity | escritura |
activity.clear_history | Clear background activity history | destructiva |
activity.get | Get background activity | lectura |
activity.list | List background activities | lectura |
Acciones
Sección titulada «Acciones»activity.cancel
Sección titulada «activity.cancel»Cancel a background activity
Request cancellation of a running or queued background activity
- Tipo: escritura
- Parámetros obligatorios:
activityId - Meta-herramienta:
arcane_activitycon"action": "cancel" - Herramienta individual:
arcane_activity_cancel - Ruta de Arcane:
POST /api/environments/{id}/activities/{activityId}/cancel - ID de operación:
cancel-activity - Uso: Cancels a queued or running activity (activityId from activity.list). A finished one, or any job_run activity (use job.cancel_run for those), is refused with ‘activity is not running’. When the work is still running in Arcane the returned activity is the snapshot from before the cancellation (still queued or running), so poll activity.get until it reaches a final status. The action that started it then fails with a cancellation, while orphaned work (e.g. after a restart) is marked cancelled directly and returned as cancelled. requestedBy only names the canceller when the caller has no user name of its own.
- Acciones relacionadas:
activity.list,activity.get,job.cancel_run
activity.clear_history
Sección titulada «activity.clear_history»Clear background activity history
Delete completed background activity history for an environment
- Tipo: destructiva — exige
confirm: true - Parámetros obligatorios: ninguno
- Meta-herramienta:
arcane_activitycon"action": "clear_history" - Herramienta individual:
arcane_activity_clear_history - Ruta de Arcane:
DELETE /api/environments/{id}/activities/history - ID de operación:
clear-activity-history - Uso: Deletes the finished (success, failed, cancelled) activities of this one environment, with their messages, and returns the deleted count. For a remote environment it clears both the manager’s copies and the agent’s. Queued and running activities and the event log (event.list) are untouched.
- Acciones relacionadas:
activity.list,event.list
activity.get
Sección titulada «activity.get»Get background activity
Get a background activity with its recent output messages
- Tipo: lectura
- Parámetros obligatorios:
activityId - Meta-herramienta:
arcane_activitycon"action": "get" - Herramienta individual:
arcane_activity_get - Ruta de Arcane:
GET /api/environments/{id}/activities/{activityId} - ID de operación:
get-activity - Uso: One activity (activityId from activity.list, or the activityId returned by long-running actions such as environment.sync) with its output messages in chronological order. limit keeps only the newest N messages (default and maximum 500). Poll it until activity.status is success, failed or cancelled to follow progress.
- Acciones relacionadas:
activity.list,activity.cancel,environment.sync
activity.list
Sección titulada «activity.list»List background activities
Get current and recent background activities for an environment
- Tipo: lectura
- Parámetros obligatorios: ninguno
- Meta-herramienta:
arcane_activitycon"action": "list" - Herramienta individual:
arcane_activity_list - Ruta de Arcane:
GET /api/environments/{id}/activities - ID de operación:
list-activities - Uso: Background tasks of one environment (image pulls, project deploys, container stops, update checks, scans, prunes, job runs), by default queued or running first, then finished ones newest first (sort overrides this), each with id, status, progress, step, latestMessage and resourceId/resourceName. Filter by status (queued, running, success, failed, cancelled), type (e.g. container_stop, image_pull, project_deploy) or resourceType. Search matches type, resource name, latest message, step and error. For the audit log of what happened use event.list.
- Acciones relacionadas:
activity.get,activity.cancel,activity.clear_history,event.list