DescribeFlow - - 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:DescribeFlow

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Name	string	必須	フローの名前。	my_flow_name
FlowVersion	string	任意	フローのバージョン。	1

レスポンスフィールド

フィールド	型	説明	例
	object	返されるデータ。
Type	string	フローのタイプ。	FDL
Definition	string	フローの定義。フロー定義言語 (FDL) 構文標準に従います。上位互換性のため、システムは 2 つのバージョンのフロー定義仕様をサポートしています。	旧版： " 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 "
RoleArn	string	フローの実行に必要な権限付与ロールのリソース記述子。Serverless Workflow は、実行中に関連リソースを操作するためにこのロールを偽装します。	acs:ram:${region}:${accountID}:${role}
RequestId	string	リクエスト 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

例

成功レスポンス

JSONJSON

{
  "Type": "FDL",
  "Definition": "旧版：\n\"\ntype: flow\nversion: v1\nname: my_flow_name\nsteps:\n  - type: pass\n    name: mypass\n\"\n\n新版：\n\"\nType: StateMachine\nSpecVersion: v1\nName: my_flow_name\nStartAt: my_state\nStates:\n  - Type: Pass\n    Name: my_state\n    End: true\n\"",
  "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"
      }
    ]
  }
}

エラーコード

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.
412	PreconditionFailed	The resource to be modified has been changed.
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.

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

変更履歴

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