StopExecution - CloudFlow: Central de Documentação do Alibaba Cloud

Interrompe uma execução em andamento em um fluxo.

Descrição da operação

Notas de uso

O fluxo deve estar em andamento.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

fnf:StopExecution

update

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
FlowName	string	Sim	O nome do fluxo de trabalho a ser interrompido. Você pode chamar a operação ListFlows para obter o valor deste parâmetro.	my_flow_name
ExecutionName	string	Sim	O nome da execução a ser interrompida. Você pode chamar a operação ListExecutions para obter o valor deste parâmetro.	my_exec_name
Cause	string	Não	O motivo para interromper a execução. O valor deve ter de 1 a 4.096 caracteres.	for test
Error	string	Não	O código de erro para interromper a execução. O código de erro deve ter de 1 a 128 caracteres.	InvalidArgument

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Schema da resposta.
Status	string	O status da execução. Valores válidos: Starting Running Stopped Succeeded Failed TimedOut	Running
StoppedTime	string	A hora em que a execução foi interrompida.	2019-01-01T01:01:01.001Z
RequestId	string	O ID da solicitação.	testRequestId
StartedTime	string	A hora em que a execução foi iniciada.	2019-01-01T01:01:01.001Z
FlowDefinition	string	A definição do fluxo.	Legacy version: "type: flow\nversion: v1\nname: my_flow_name\nsteps:\n - type: pass\n name: mypass" New version: "Type: StateMachine\nSpecVersion: v1\nName: my_flow_name\nStartAt: my_state\nStates:\n - Type: Pass\n Name: my_state\n End: true"
Output	string	O resultado da execução, em formato JSON.	{"key":"value"}
FlowName	string	O nome do fluxo.	my_flow_name
Name	string	O nome da execução.	my_exec_name
Input	string	A entrada da execução, em formato JSON.	{"key":"value"}
RoleArn	string	O nome de recurso Alibaba Cloud (ARN) da função que executou o fluxo. Se o RoleArn na definição do fluxo for alterado durante a execução do fluxo, o sistema registra e retorna um snapshot do RoleArn original. Nota Se você não especificar o parâmetro RoleArn nos parâmetros da solicitação, os parâmetros de resposta não conterão o parâmetro RoleArn.	acs:ram:${region}:${accountID}:${role}

Exemplos

Resposta de sucesso

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 erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
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 Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.