ListWorkflowDefinitions API による DataWorks ワークフローのフィルタリングと一覧表示 - DataWorks - Alibaba Cloud - DataWorks

DataStudio のワークフローのリストをクエリします。特定のワークフローをクエリするために、フィルター条件を指定することもできます。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

dataworks:*

list

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ProjectId	integer	必須	DataWorks ワークスペース ID です。DataWorks コンソールにログインし、ワークスペースページに移動して ID をクエリできます。 API オペレーションが適用される DataWorks ワークスペースを指定するには、このパラメーターを設定する必要があります。	10000
Type	string	任意	フィルター条件: ワークフローのタイプです。デフォルト値は CycleWorkflow です。有効な値: CycleWorkflow ManualWorkflow	CycleWorkflow
Owner	string	任意	フィルター条件: ワークフローのタイプです。デフォルト値は CycleWorkflow です。有効な値: CycleWorkflow ManualWorkflow	110755000425XXXX
Name	string	任意	ワークフロー名です。あいまい検索がサポートされています。	test
PageNumber	integer	任意	取得するデータのページ番号で、ページネーションに使用されます。	1
PageSize	integer	任意	取得するデータのページ番号で、ページネーションに使用されます。	10

レスポンスフィールド

フィールド	型	説明	例
	object	応答のスキーマ
RequestId	string	リクエスト ID です。	8C3ED0C5-ABAB-55E1-854B-DAC02B11XXXX
PagingInfo	object	ページネーション情報です。
TotalCount	integer	返されるエントリの総数です。	227
PageSize	integer	1 ページあたりのエントリ数です。	10
PageNumber	integer	ページ番号です。	1
WorkflowDefinitions	array<object>	ワークフローです。
	array<object>
ProjectId	integer	ワークフローが属する DataWorks ワークスペースの ID です。	4710
Owner	string	所有者	110755000425XXXX
CreateTime	integer	ワークフローが作成されたときのタイムスタンプです。	1698057323000
ModifyTime	integer	ワークフローが最後に変更されたときのタイムスタンプです。	1698057323000
Description	string	説明	Workflow description
Type	string	ワークフローのタイプです。有効な値: CycleWorkflow ManualWorkflow	CycleWorkflow
Script	object	スクリプト情報です。
Path	string	スクリプトパスです。	XX/OpenAPI_test/workflow_test/OpenAPI_test_workflow_Demo
Runtime	object	ランタイム
Command	string	コマンド	WORKFLOW
Id	string	スクリプトの ID です。説明 SDK バージョン 8.0.0 より前では、このフィールドは Long 型であり、SDK バージョン 8.0.0 以降では String 型です。この変更は SDK の通常の使用には影響しません。パラメーターは SDK で定義されたタイプに基づいて返されます。タイプ変更によるコンパイルエラーは、SDK をバージョン 8.0.0 をまたいでアップグレードする場合にのみ発生する可能性があり、その場合、ユーザーは手動でデータの型を修正する必要があります。	698002781368644XXXX
Name	string	ワークフロー名です。	OpenAPI test workflow Demo
Id	string	ワークフローの一意の識別子です。説明 SDK バージョン 8.0.0 より前では、このフィールドは Long 型です。SDK バージョン 8.0.0 以降では、String 型です。この変更は SDK の通常の使用には影響しません。パラメーターは SDK で定義されたタイプに基づいて返されます。タイプ変更によって引き起こされるコンパイルエラーは、SDK をバージョン 8.0.0 をまたいでアップグレードする場合にのみ発生する可能性があり、この場合、データの型を手動で更新する必要があります。	463497880880954XXXX

例

成功レスポンス

JSONJSON

{
  "RequestId": "8C3ED0C5-ABAB-55E1-854B-DAC02B11XXXX",
  "PagingInfo": {
    "TotalCount": 227,
    "PageSize": 10,
    "PageNumber": 1,
    "WorkflowDefinitions": [
      {
        "ProjectId": 4710,
        "Owner": "110755000425XXXX",
        "CreateTime": 1698057323000,
        "ModifyTime": 1698057323000,
        "Description": "Workflow description",
        "Type": "CycleWorkflow",
        "Script": {
          "Path": "XX/OpenAPI_test/workflow_test/OpenAPI_test_workflow_Demo",
          "Runtime": {
            "Command": "WORKFLOW"
          },
          "Id": "698002781368644XXXX"
        },
        "Name": "OpenAPI test workflow Demo",
        "Id": "463497880880954XXXX"
      }
    ]
  }
}

エラーコード

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

変更履歴

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