すべてのプロダクト
Search

このプロダクト

    DataWorks:ListFiles

    ドキュメントセンター

    DataWorks:ListFiles

    最終更新日:Mar 21, 2026

    ファイルの一覧を照会します。

    今すぐお試しください

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

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    FileFolderPath

    string

    任意

    ファイルが属するフォルダのパス。

    Business_process/my_first_business_process/MaxCompute/ods_layer
    ProjectId

    integer

    任意

    DataWorks ワークスペースの ID。 DataWorks コンソール にログインし、ワークスペース管理ページでワークスペース ID を取得できます。

    この操作を適用する DataWorks ワークスペースを特定するために、ProjectId または ProjectIdentifier のいずれかを設定する必要があります。

    10000
    Keyword

    string

    任意

    ファイル名に含まれるキーワード。あいまい一致に使用されます。キーワードを指定すると、そのキーワードを含むすべてのファイルを照会できます。

    ods
    ProjectIdentifier

    string

    任意

    DataWorks ワークスペースの名前。 DataWorks コンソール にログインし、ワークスペース管理ページでワークスペース名を取得できます。

    この操作を適用する DataWorks ワークスペースを特定するために、ProjectId または ProjectIdentifier のいずれかを設定する必要があります。

    dw_project
    PageNumber

    integer

    任意

    ページ番号。

    1
    PageSize

    integer

    任意

    1 ページあたりのエントリ数。デフォルト値：10。最大値：100。

    10
    UseType

    string

    任意

    ファイルが属するモジュール。有効な値：

    • NORMAL：ファイルは DataStudio 用です。

    • MANUAL：ファイルは手動トリガーノード用です。

    • MANUAL_BIZ：ファイルは手動トリガーワークフロー用です。

    • SKIP：ファイルは DataStudio のドライランノード用です。

    • ADHOCQUERY：ファイルはアドホッククエリ用です。

    • COMPONENT：ファイルはスニペット用です。

    NORMAL
    FileTypes

    string

    任意

    ファイル内のコードのタイプ。

    有効な値：6 (Shell)、10 (ODPS SQL)、11 (ODPS MR)、23 (Data Integration)、24 (ODPS Script)、97 (PAI)、98 (ノードグループ)、99 (ゼロロード)、221 (PyODPS 2)、225 (ODPS Spark)、227 (EMR Hive)、228 (EMR Spark)、229 (EMR Spark SQL)、230 (EMR MR)、239 (OSS オブジェクト検査)、257 (EMR Shell)、258 (EMR Spark Shell)、259 (EMR Presto)、260 (EMR Impala)、900 (リアルタイム同期)、1002 (PAI 内部ノード)、1089 (テナント間連携)、1091 (Hologres 開発)、1093 (Hologres SQL)、1100 (代入)、1106 (for-each)、1221 (PyODPS 3)。

    10,23
    Owner

    string

    任意

    ファイルの所有者。

    3726346****
    NodeId

    integer

    任意

    スケジュールされたノードの ID。ListNodes 操作を呼び出してノードの ID を照会できます。

    123541234
    NeedContent

    boolean

    任意

    照会結果にファイルの内容を含めるかどうか（内容が多いファイルの場合、ネットワーク伝送遅延が長くなる可能性があります）。

    false
    NeedAbsoluteFolderPath

    boolean

    任意

    照会結果にファイルが配置されているフォルダのパスを含めるかどうか。

    false
    ExactFileName

    string

    任意

    完全一致ファイル名。照会結果のファイル名は、このパラメーターと完全に一致します。

    ods_create.sql
    FileIdIn

    string

    任意

    ファイル ID リスト。照会結果のファイル ID セットは、このリストのサブセットのみになります。一度に最大 50 個のファイル ID を指定できます。

    78237,816123
    LastEditUser

    string

    任意

    ファイルを最後に変更した Alibaba Cloud アカウントの ID。

    38748246285727

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    返されたデータ。

    HttpStatusCode

    integer

    返された HTTP ステータスコード。

    200
    ErrorMessage

    string

    返されたエラーメッセージ。

    The connection does not exist.
    RequestId

    string

    リクエスト ID。この ID を使用して問題をトラブルシューティングできます。

    0000-ABCD-EFG
    ErrorCode

    string

    返されたエラーコード。

    Invalid.Tenant.ConnectionNotExists
    Success

    boolean

    リクエストが成功したかどうかを示します。有効な値：

    • true：リクエストが成功しました。

    • false：リクエストが失敗しました。

    true
    Data

    object

    返されたファイル。

    PageNumber

    integer

    返されたページのページ番号。

    1
    PageSize

    integer

    1 ページあたりに返されるエントリ数。

    10
    TotalCount

    integer

    返されたエントリの総数。

    13
    Files

    array<object>

    ファイルの詳細。

    object

    ファイルに関する情報。

    CommitStatus

    integer

    ファイル内の最新コードがコミットされているかどうかを示します。有効な値：0 および 1。値 0 は、ファイル内の最新コードがコミットされていないことを示します。値 1 は、ファイル内の最新コードがコミットされていることを示します。

    1
    AutoParsing

    boolean

    ファイルに対して自動解析機能が有効かどうかを指定します。有効な値：

    • true：ファイルに対して自動解析機能が有効です。

    • false：ファイルに対して自動解析機能は無効です。

    このパラメーターは、DataWorks コンソール のプロパティパネルの [依存関係] セクションにある [コードの分析] パラメーターに相当します。

    true
    Owner

    string

    ファイル所有者が使用している Alibaba Cloud アカウントの ID。

    3872572****
    CreateTime

    integer

    ファイルが作成された時刻。この値は UNIX タイムスタンプであり、協定世界時 (UTC) 1970 年 1 月 1 日 00:00:00 から経過したミリ秒数を表します。

    1593950832000
    FileType

    integer

    ファイル内のコードのタイプ。有効な値：6 (Shell)、10 (ODPS SQL)、11 (ODPS MR)、23 (Data Integration)、24 (ODPS Script)、99 (ゼロロード)、221 (PyODPS 2)、225 (ODPS Spark)、227 (EMR Hive)、228 (EMR Spark)、229 (EMR Spark SQL)、230 (EMR MR)、239 (OSS オブジェクト検査)、257 (EMR Shell)、258 (EMR Spark Shell)、259 (EMR Presto)、260 (EMR Impala)、900 (リアルタイム同期)、1089 (テナント間連携)、1091 (Hologres 開発)、1093 (Hologres SQL)、1100 (代入)、1221 (PyODPS 3)。

    10
    CurrentVersion

    integer

    ファイルの最新バージョン番号。

    2
    BizId

    integer

    ファイルが属するワークフローの ID。このパラメーターは非推奨となり、BusinessId パラメーターに置き換えられています。

    300000
    LastEditUser

    string

    ファイルを最後に変更した Alibaba Cloud アカウントの ID。

    38748246285727
    FileName

    string

    ファイル名。

    ods_user_info_d
    ConnectionName

    string

    ファイルに対応するノードを実行するために使用されるコンピュートエンジンインスタンスの ID。

    odps_first
    UseType

    string

    ファイルが属するモジュール。有効な値：

    • NORMAL：ファイルは DataStudio 用です。

    • MANUAL：ファイルは手動トリガーノード用です。

    • MANUAL_BIZ：ファイルは手動トリガーワークフロー用です。

    • SKIP：ファイルは DataStudio のドライランノード用です。

    • ADHOCQUERY：ファイルはアドホッククエリ用です。

    • COMPONENT：ファイルはスニペット用です。

    NORMAL
    FileFolderId

    string

    ファイルが属するフォルダの ID。

    2735c2****
    FileId

    integer

    ファイルの ID。

    10000001
    ParentId

    integer

    現在のファイルが属するノードグループファイルの ID。このパラメーターは、現在のファイルがノードグループファイルの内部ファイルである場合にのみ返されます。

    -1
    CreateUser

    string

    ファイルを作成した Alibaba Cloud アカウントの ID。

    382762****
    IsMaxCompute

    boolean

    ファイルが MaxCompute リソースファイルの場合、MaxCompute にアップロードする必要があるかどうかを示します。

    このパラメーターは、ファイルが MaxCompute リソースファイルである場合にのみ返されます。

    false
    BusinessId

    integer

    ファイルが属するワークフローの ID。

    300000
    FileDescription

    string

    ファイルの説明。

    my test datastudio file
    LastEditTime

    integer

    ファイルが最後に変更された時刻。この値は UNIX タイムスタンプであり、協定世界時 (UTC) 1970 年 1 月 1 日 00:00:00 から経過したミリ秒数を表します。

    1593950832000
    Content

    string

    このパラメーターは非推奨です。GetFile 操作を呼び出してファイルの詳細を照会できます。

    SHOW TABLES;
    NodeId

    integer

    ファイルがコミットされた後にスケジューリングシステムで生成される自動トリガーノードの ID。

    300001
    AbsoluteFolderPath

    string

    ファイルが属するフォルダのパス。

    Business_process/my_first_business_process/MaxCompute/ods_layer

    例

    成功レスポンス

    JSONJSON

    {
  "HttpStatusCode": 200,
  "ErrorMessage": "The connection does not exist.",
  "RequestId": "0000-ABCD-****",
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists",
  "Success": true,
  "Data": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 13,
    "Files": [
      {
        "CommitStatus": 1,
        "AutoParsing": true,
        "Owner": "3872572****",
        "CreateTime": 1593950832000,
        "FileType": 10,
        "CurrentVersion": 2,
        "BizId": 300000,
        "LastEditUser": "38748246285727",
        "FileName": "ods_user_info_d",
        "ConnectionName": "odps_source",
        "UseType": "NORMAL",
        "FileFolderId": "2735c2****",
        "FileId": 10000001,
        "ParentId": -1,
        "CreateUser": "382762****",
        "IsMaxCompute": false,
        "BusinessId": 300000,
        "FileDescription": "my test datastudio file",
        "LastEditTime": 1593950832000,
        "Content": "SHOW TABLES;",
        "NodeId": 300001,
        "AbsoluteFolderPath": "Business_process/my_first_business_process/MaxCompute/ods_layer"
      }
    ]
  }
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    500 InternalError.System An internal system error occurred. Try again later.
    500 InternalError.UserId.Missing An internal system error occurred. Try again later.
    403 Forbidden.Access Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.
    429 Throttling.Api The request for this resource has exceeded your available limit.
    429 Throttling.System The DataWorks system is busy. Try again later.
    429 Throttling.User Your request is too frequent. Try again later.

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

    変更履歴

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