StopExecution - - Alibaba Cloud ドキュメントセンター

フローで実行中の実行を停止します。

操作説明

注意事項

フローが実行中である必要があります。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

fnf:StopExecution

update

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
FlowName	string	必須	停止するワークフローの名前。 ListFlows 操作を呼び出して、このパラメーターの値を取得できます。	flow
ExecutionName	string	必須	停止する実行の名前。 ListExecutions 操作を呼び出して、このパラメーターの値を取得できます。	exec
Cause	string	任意	実行を停止する理由。値の長さは 1～4,096 文字である必要があります。	for test
Error	string	任意	実行を停止するためのエラーコード。エラーコードの長さは 1～128 文字である必要があります。	nill

レスポンスフィールド

フィールド	型	説明	例
	object	応答のスキーマ。
Status	string	実行ステータス。有効な値： Starting Running Stopped Succeeded Failed TimedOut	Running
StoppedTime	string	実行が停止した時間。	2019-01-01T01:01:01.001Z
RequestId	string	リクエスト ID。	testRequestId
StartedTime	string	実行が開始された時間。	2019-01-01T01:01:01.001Z
FlowDefinition	string	フローの定義。	version: v1.0\ntype: flow\nname: test\nsteps:\n - type: pass\n name: mypass
Output	string	JSON 形式の実行結果。	{"key":"value"}
FlowName	string	フローの名前。	flow
Name	string	実行の名前。	exec
Input	string	JSON 形式の実行の入力。	{"key":"value"}
RoleArn	string	フローを実行したロールの Alibaba Cloud リソース名 (ARN)。フローの実行中にフロー定義の RoleArn が変更された場合、システムは元の RoleArn のスナップショットを記録して返します。説明リクエストパラメーターで RoleArn パラメーターを指定しない場合、レスポンスパラメーターには RoleArn パラメーターは含まれません。	acs:ram:${region}:${accountID}:${role}

例

成功レスポンス

JSONJSON

{
  "Status": "Running",
  "StoppedTime": "2019-01-01T01:01:01.001Z",
  "RequestId": "testRequestId",
  "StartedTime": "2019-01-01T01:01:01.001Z",
  "FlowDefinition": "version: v1.0\\ntype: flow\\nname: test\\nsteps:\\n - type: pass\\n name: mypass",
  "Output": "{\"key\":\"value\"}",
  "FlowName": "flow",
  "Name": "exec",
  "Input": "{\"key\":\"value\"}",
  "RoleArn": "acs:ram:${region}:${accountID}:${role}"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
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).
400	ExecutionAlreadyCompleted	Execution '%s' for flow '%s' has already completed.
400	InvalidArgument	Parameter error.
400	MissingRequiredHeader	The HTTP header '%s' must be specified.
400	MissingRequiredParams	The HTTP query '%s' must be specified.
500	InternalServerError	An internal error has occurred. Please retry.
403	AccessDenied	The resources doesn't belong to you.
403	InvalidAccessKeyID	The AccessKey ID %s is invalid.
403	RequestTimeTooSkewed	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.
404	ExecutionNotExists	Execution %s for flow %s does not exist.
404	FlowNotExists	Flow %s does not exist.
415	UnsupportedMediaType	The content type must be "application/json".
429	ResourceThrottled	The request is throttled. Please try again later.
409	ConcurrentUpdateError	Update conflict, please retry.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。