すべてのプロダクト
Search

このプロダクト

    DataWorks:ListFiles

    ドキュメントセンター

    DataWorks:ListFiles

    最終更新日:Sep 03, 2026

    ファイルのリストを照会します。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    FileFolderPath

    string

    任意

    ファイルが保存されているフォルダのパス。

    Business_process/my_first_business_process/MaxCompute/ods_layer
    ProjectId

    integer

    任意

    DataWorks ワークスペースの ID。DataWorks コンソール にログインし、ワークスペース構成ページに移動してワークスペース ID を取得できます。

    この API 呼び出しの対象となる DataWorks ワークスペースを特定するには、このパラメーターまたは ProjectIdentifier パラメーターのいずれかを指定する必要があります。

    10000
    Keyword

    string

    任意

    ファイル名のキーワード。あいまい一致がサポートされています。キーワードを入力すると、名前にそのキーワードを含むすべてのファイルをクエリできます。

    ods
    ProjectIdentifier

    string

    任意

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

    この API 呼び出しの対象となる DataWorks ワークスペースを特定するには、このパラメーターまたは ProjectId パラメーターのいずれかを指定する必要があります。

    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 (foreach ノード)、1221 (PyODPS 3) があります。

    10,23
    Owner

    string

    任意

    ファイルのオーナー。

    3726346****
    NodeId

    integer

    任意

    スケジューリングノードの ID。 ListNodes 操作を呼び出してノード ID を取得できます。

    123541234
    NeedContent

    boolean

    任意

    クエリ結果にファイルの内容を含めるかどうかを指定します。内容が large のファイルの場合、ネットワーク伝送遅延が大きくなる可能性があります。

    false
    NeedAbsoluteFolderPath

    boolean

    任意

    クエリ結果にファイルが保存されているフォルダのパスを含めるかどうかを指定します。

    false
    ExactFileName

    string

    任意

    完全に一致させるファイル名。クエリ結果のファイル名は、このパラメーター値と完全に一致します。

    ods_create.sql
    FileIdIn

    string

    任意

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

    78237,816123
    LastEditUser

    string

    任意

    ファイルを最後に更新したユーザーの Alibaba Cloud ID。

    11233***
    CommitStatus

    integer

    任意

    ファイルの現在のコミットステータス。有効な値: 0 (最新のコードがコミットされていない)、1 (最新のコードがコミット済み)。

    1

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答パラメーター。

    HttpStatusCode

    integer

    HTTP 状態コード。

    200
    ErrorMessage

    string

    エラーメッセージ。

    The connection does not exist
    RequestId

    string

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

    0000-ABCD-****
    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 (最新のコードがコミット済み)。

    1
    AutoParsing

    boolean

    ファイルに対して自動解析特徴が有効かどうかを示します。有効な値:

    • true: ファイルはコードを自動的に解析します。

    • false: ファイルはコードを自動的に解析しません。

    このパラメーターは、DataWorks コンソール で DataStudio タスクの「スケジューリング構成 > スケジューリング依存関係」で「同一サイクル」を選択した際の「コード解析」オプションに対応します。

    true
    Owner

    string

    ファイル所有者の Alibaba Cloud ユーザー ID。

    3872572****
    CreateTime

    integer

    ファイルが作成されたタイムスタンプ (ミリ秒単位)。

    1593950832000
    FileType

    integer

    ファイルタイプ。ファイルタイプごとに異なるコードが割り当てられています。詳細については、「DataWorks ノード」を参照してください。

    10
    CurrentVersion

    integer

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

    2
    BizId

    integer

    [非推奨] ファイルが属するワークフローの ID。このフィールドは非推奨です。代わりに BusinessId フィールドを使用してください。

    300000
    LastEditUser

    string

    ファイルを最後に更新したユーザーの Alibaba Cloud ID。

    382762****
    FileName

    string

    ファイルの名前。

    ods_user_info_d
    ConnectionName

    string

    ファイルに対応するタスクの実行時に使用されるデータソースの名前。

    odps_source
    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

    ファイルの最終編集タイムスタンプ (ミリ秒単位)。

    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": "382762****",
        "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.

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

    変更履歴

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