StopExecution - CloudFlow - Centro de documentación de Alibaba Cloud

Detiene una ejecución en curso dentro de un flujo.

Descripción de la operación

Notas de uso

El flujo debe estar en curso.

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

fnf:StopExecution

update

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
FlowName	string	Sí	El nombre del flujo de trabajo que se va a detener. Puede llamar a la operación ListFlows para obtener el valor de este parámetro.	flow
ExecutionName	string	Sí	El nombre de la ejecución que se va a detener. Puede llamar a la operación ListExecutions para obtener el valor de este parámetro.	exec
Cause	string	No	El motivo para detener la ejecución. El valor debe tener una longitud de 1 a 4,096 caracteres.	for test
Error	string	No	El código de error para detener la ejecución. El código de error debe tener una longitud de 1 a 128 caracteres.	nill

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Esquema de la respuesta.
Status	string	El estado de la ejecución. Valores válidos: Starting Running Stopped Succeeded Failed TimedOut	Running
StoppedTime	string	La hora en que se detuvo la ejecución.	2019-01-01T01:01:01.001Z
RequestId	string	El ID de la solicitud.	testRequestId
StartedTime	string	La hora en que se inició la ejecución.	2019-01-01T01:01:01.001Z
FlowDefinition	string	La definición del flujo.	version: v1.0\ntype: flow\nname: test\nsteps:\n - type: pass\n name: mypass
Output	string	El resultado de la ejecución, en formato JSON.	{"key":"value"}
FlowName	string	El nombre del flujo.	flow
Name	string	El nombre de la ejecución.	exec
Input	string	La entrada de la ejecución, en formato JSON.	{"key":"value"}
RoleArn	string	El nombre de recurso de Alibaba Cloud (ARN) del rol que ejecutó el flujo. Si el RoleArn en la definición del flujo cambia durante la ejecución del flujo, el sistema registra y devuelve una instantánea del RoleArn original. Nota Si no especifica el parámetro RoleArn en los parámetros de la solicitud, los parámetros de la respuesta no contendrán el parámetro RoleArn.	acs:ram:${region}:${accountID}:${role}

Ejemplos

Respuesta exitosa

JSON Formato

{
  "Status": "Running",
  "StoppedTime": "2019-01-01T01:01:01.001Z",
  "RequestId": "testRequestId",
  "StartedTime": "2019-01-01T01:01:01.001Z",
  "FlowDefinition": "Legacy version:\n\"type: flow\\nversion: v1\\nname: my_flow_name\\nsteps:\\n - type: pass\\n name: mypass\"\n\nNew version:\n\"Type: StateMachine\\nSpecVersion: v1\\nName: my_flow_name\\nStartAt: my_state\\nStates:\\n - Type: Pass\\n Name: my_state\\n End: true\"",
  "Output": "{\"key\":\"value\"}",
  "FlowName": "my_flow_name",
  "Name": "my_exec_name",
  "Input": "{\"key\":\"value\"}",
  "RoleArn": "acs:ram:${region}:${accountID}:${role}"
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	ActionNotSupported	The requested API operation '%s' is incorrect. Please check.
400	APIVersionNotSupported	The requested API version '%s' is not supported yet. Please check.
400	EntityTooLarge	The payload size exceeds maximum allowed size (%s bytes).	The payload size exceeds maximum allowed size (%s bytes).
400	ExecutionAlreadyCompleted	Execution '%s' for flow '%s' has already completed.
400	InvalidArgument	Parameter error.	Parameter error.
400	MissingRequiredHeader	The HTTP header '%s' must be specified.	The HTTP header '%s' must be specified.
400	MissingRequiredParams	The HTTP query '%s' must be specified.	The HTTP query '%s' must be specified.
500	InternalServerError	An internal error has occurred. Please retry.	An internal error has occurred. Please retry.
403	AccessDenied	The resources doesn't belong to you.
403	InvalidAccessKeyID	The AccessKey ID %s is invalid.	The AccessKey ID %s is invalid.
403	RequestTimeTooSkewed	The difference between the request time %s and the current time %s is too large.	The difference between the request time %s and the current time %s is too large.
403	SignatureNotMatch	The request signature we calculated does not match the signature you provided. Check your access key and signing method.	The calculated signature of the request does not match the signature you provided. Check your AccessKey Secret and signing algorithm.
404	ExecutionNotExists	Execution %s for flow %s does not exist.	Execution %s for flow %s does not exist.
404	FlowNotExists	Flow %s does not exist.	Flow %s does not exist.
415	UnsupportedMediaType	The content type must be "application/json".	The content type must be "application/json".
429	ResourceThrottled	The request is throttled. Please try again later.	The request is throttled. Please try again later.
409	ConcurrentUpdateError	Update conflict, please retry.	Update conflict, please retry.

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.