ListFlows を呼び出してフローのリストをクエリ - 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:ListFlows

get

*Flow

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
NextToken	string	任意	フロー検索の開始名です。	flow_nextxxx
Limit	integer	任意	検索件数です。有効値の範囲は [1, 1000) で、デフォルト値は 60 です。	1
ResourceGroupId	string	任意		rg-xxx

レスポンスフィールド

フィールド	型	説明	例
	object	フローリストです。
NextToken	string	次のクエリの開始キーです。他のデータが存在しない場合は返されません。	flow_nextxxx
RequestId	string	リクエスト ID です。	testRequestId
Flows	array<object>	フローリストです。
	array<object>	フローリストです。
Type	string	フローの種別です。	FDL
Definition	string	フロー定義で、FDL 構文標準に従います。	version: v1.0\ntype: flow\nname: test\nsteps:\n - type: pass\n name: mypass
RoleArn	string	フロー実行に必要なリソース記述子情報です。	acs:ram::${accountID}:${role}
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-3574ddf5****
ExecutionMode	string	実行モードです（列挙型）。Express または Standard のいずれかを指定できます。空文字列は Standard と同等です。	Standard
Environment	object	フロー実行中にアクセス可能な変数の一覧です。
Variables	array<object>	フロー実行中にアクセス可能な変数の一覧です。
	object	フロー実行中にアクセス可能な変数の一覧です。
Description	string	変数の説明です。	description
Name	string	変数名です。	key
Value	string	変数の値です。	value
ResourceGroupId	string		rg-xxx

例

成功レスポンス

JSONJSON

{
  "NextToken": "flow_nextxxx",
  "RequestId": "testRequestId",
  "Flows": [
    {
      "Type": "FDL",
      "Definition": "version: v1.0\\ntype: flow\\nname: test\\nsteps:\\n - type: pass\\n name: mypass",
      "RoleArn": "acs:ram::${accountID}:${role}",
      "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-3574ddf5****",
      "ExecutionMode": "Standard",
      "Environment": {
        "Variables": [
          {
            "Description": "description",
            "Name": "key",
            "Value": "value"
          }
        ]
      },
      "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	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.

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

変更履歴

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