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

フローの実行を開始します。

操作説明

説明

指定されたフローが存在し、標準実行モードである必要があります。
実行名が指定されていない場合、サービスは自動的に名前を生成し、実行を開始します。
同じ名前の実行がすでに進行中の場合、新しい実行は開始されません。代わりに、システムは進行中の実行の詳細を返します。
同じ名前の実行がすでに完了している場合、実行が成功したか失敗したかにかかわらず、システムは ExecutionAlreadyExists エラーを返します。
同じ名前の実行が存在しない場合、新しい実行が開始されます。

今すぐお試しください

この 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:StartExecution

update

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
FlowName	string	必須	実行するフローの名前。	my_flow_name
ExecutionName	string	任意	実行の名前。名前は同じフロー内で一意である必要があります。名前は次の要件を満たす必要があります。文字 (a-z または A-Z) またはアンダースコア (_) で始まる必要があります。文字 (a-z または A-Z)、数字 (0-9)、アンダースコア (_)、およびハイフン (-) を含めることができます。大文字と小文字が区別されます。長さは 1～128 文字である必要があります。	my_exec_name
Input	string	任意	実行の入力。入力は JSON オブジェクト形式である必要があります。	{"key":"value"}
CallbackFnFTaskToken	string	任意	フローの実行完了後にコールバックされるタスクのトークン。	12
Qualifier	string	任意	フローのバージョンまたはエイリアス。	1

レスポンスフィールド

フィールド	型	説明	例
	object	返されるデータ。
Status	string	実行のステータス。有効な値: Starting Running Stopped Succeeded Failed TimedOut	Succeeded
StoppedTime	string	実行が停止した時刻。	2019-01-01T01:01:01.001Z
RequestId	string	リクエスト ID。	testRequestId
StartedTime	string	実行が開始された時刻。	2019-01-01T01:01:01.001Z
FlowDefinition	string	実行されたフローの定義。	旧版： "type: flow\nversion: v1\nname: my_flow_name\nsteps:\n - type: pass\n name: mypass" 新版： "Type: StateMachine\nSpecVersion: v1\nName: my_flow_name\nStartAt: my_state\nStates:\n - Type: Pass\n Name: my_state\n End: true"
Output	string	実行の出力。JSON オブジェクト形式。	{"key":"value"}
FlowName	string	フローの名前。	my_flow_name
Name	string	実行の名前。	my_exec_name
Input	string	実行の入力。JSON オブジェクト形式。	{"key":"value"}

例

成功レスポンス

JSONJSON

{
  "Status": "Succeeded",
  "StoppedTime": "2019-01-01T01:01:01.001Z",
  "RequestId": "testRequestId",
  "StartedTime": "2019-01-01T01:01:01.001Z",
  "FlowDefinition": "旧版：\n\"type: flow\\nversion: v1\\nname: my_flow_name\\nsteps:\\n  - type: pass\\n    name: mypass\"\n\n新版：\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\"}"
}

エラーコード

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	ExecutionAlreadyExists	Execution %s for flow %s already exists.
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	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.

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

変更履歴

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