CreateFlow API を呼び出してフローを作成 - CloudFlow

フローを作成します。

操作説明

説明

各ユーザーが作成できるフローの数は、リソースの使用制限の対象となります。詳細については、「使用制限」をご参照ください。特別な要件がある場合は、チケットを送信して制限の調整をリクエストしてください。
フローはアカウント内で名前によって一意に識別されます。したがって、単一のアカウントで同じ名前の複数のフローを作成することはできません。

今すぐお試しください

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

create

*Flow

acs:fnf:{#regionId}:{#accountId}:flow/*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Name	string	必須	フローの名前です。名前は同じリージョン内で一意である必要があり、フロー作成後に変更することはできません。名前は次の要件を満たす必要があります。英字 (a～z、A～Z)、数字 (0～9)、アンダースコア (_)、ハイフン (-) を含めることができます。英字またはアンダースコア (_) で始める必要があります。大文字と小文字を区別します。長さは 1～128 文字である必要があります。	my_flow_name
Definition	string	必須	フローの定義です。フロー定義言語 (FDL) の構文に準拠している必要があります。上位互換性のため、システムはフロー定義仕様の 2 つのバージョンをサポートしています。説明フロー定義の例では、Name: my_flow_name はフロー名を参照し、Name 入力パラメーターと同じである必要があります。	旧版： " type: flow version: v1 name: my_flow_name steps: - type: pass name: mypass " 新版： " Type: StateMachine SpecVersion: v1 Name: my_flow_name StartAt: my_state States: - Type: Pass Name: my_state End: true "
Description	string	必須	フローの説明です。	my test flow
Type	string	必須	フローのタイプです。値は FDL である必要があります。列挙値: FDL : フロー定義言語	FDL
RoleArn	string	任意	フローが実行に依存するロールのリソース記述子です。フローの実行時、Serverless Workflow はこのロール (AssumeRole) を引き受けて、関連するフローリソースを操作します。	acs:ram:${region}:${accountID}:${role}
ExternalStorageLocation	string	任意	外部ストレージの場所です。	/path
ExecutionMode	string	任意	実行モードです。これは列挙型です。有効な値は Express と Standard です。上位互換性のため、空の文字列は Standard 実行モードとして扱われます。列挙値: Express : Express 実行モード Standard : Standard 実行モード	Standard
Environment	object	任意	フローが実行中にアクセスできる環境コンテキストです。
Variables	array<object>	任意	フローが実行中にアクセスできる環境変数のリストです。
	object	任意	フローが実行中にアクセスできる変数のリストです。
Name	string	任意	変数名です。	key
Value	string	任意	変数値です。	value
Description	string	任意	変数の説明です。	description

レスポンスフィールド

フィールド	型	説明	例
	object	返されるデータです。
Type	string	フローのタイプです。列挙値: FDL : フロー定義言語	FDL
Definition	string	フローの定義です。上位互換性のため、システムはフロー定義仕様の 2 つのバージョンをサポートしています。	旧版： "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"
RoleArn	string	フローが実行に依存するロールのリソース記述子です。フローの実行時、Serverless Workflow はこのロール (AssumeRole) を引き受けて、関連するフローリソースを操作します。	acs:ram:${region}:${accountID}:${role}
RequestId	string	リクエスト ID です。Serverless Workflow は、`HTTP 状態コード` を受信するすべてのリクエストに対してリクエスト ID を返します。	testRequestID
Description	string	フローの説明です。	my test flow
Name	string	フローの名前です。	my_flow_name
CreatedTime	string	フローが作成された時刻です。	2019-01-01T01:01:01.001Z
LastModifiedTime	string	フローが最後に変更された時刻です。	2019-01-01T01:01:01.001Z
Id	string	フローの一意の ID です。	e589e092-e2c0-4dee-b306-3574ddfdddf5****
ExecutionMode	string	実行モードです。これは列挙型です。有効な値は Express と Standard です。上位互換性のため、このフィールドは空の文字列にすることができ、その場合は Standard モードとして扱われます。	Standard
Environment	object	フローが実行中にアクセスできる変数のリストです。
Variables	array<object>	フローが実行中にアクセスできる変数のリストです。
	object	フローが実行中にアクセスできる変数のリストです。
Name	string	変数名です。	key
Value	string	変数値です。	value
Description	string	変数の説明です。	description
ResourceGroupId	string		rg-xxx

例

成功レスポンス

JSONJSON

{
  "Type": "FDL",
  "Definition": "旧版：\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\"",
  "RoleArn": "acs:ram:${region}:${accountID}:${role}",
  "RequestId": "testRequestID",
  "Description": "my test flow",
  "Name": "my_flow_name",
  "CreatedTime": "2019-01-01T01:01:01.001Z",
  "LastModifiedTime": "2019-01-01T01:01:01.001Z",
  "Id": "e589e092-e2c0-4dee-b306-3574ddfdddf5****",
  "ExecutionMode": "Standard",
  "Environment": {
    "Variables": [
      {
        "Name": "key",
        "Value": "value",
        "Description": "description"
      }
    ]
  },
  "ResourceGroupId": "rg-xxx"
}

エラーコード

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	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.
415	UnsupportedMediaType	The content type must be "application/json".
429	ResourceThrottled	The request is throttled. Please try again later.
409	FlowAlreadyExists	Flow %s already exists.

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

変更履歴

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