全部產品
Search
文件中心

DataWorks:ListResources

更新時間:Oct 09, 2026

呼叫此介面,可以分頁獲取資源檔案,也可以對資源進行篩選。

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊,可以在RAM權限原則語句的Action元素中使用,用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下:

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

dataworks:*

list

*All Resource

*

無 無

請求參數

名稱

類型

必填

描述

樣本值

ProjectId

integer

是

DataWorks 工作空間的 ID。您可以登入 DataWorks 控制台,進入工作空間設定頁面獲取工作空間 ID。

該參數用來確定本次 API 呼叫操作使用的 DataWorks 工作空間。

10002

Owner

string

否

負責人的 ID,即工作空間管理員的帳號 UID。您可登入阿里雲控制台後,在帳號管理的安全管理中檢視帳號 UID。

110755000425XXXX

Type

string

否

篩選條件:資源類型

可選值

  • Python

  • Jar

  • Archive

  • File

枚舉值:

  • Archive :

    Archive

  • Jar :

    Jar

  • File :

    File

  • Python :

    Python

Python

Name

string

否

檔案資源名稱,支援模糊搜尋。

test

PageNumber

integer

否

請求的資料頁數,用於翻頁。

1

PageSize

integer

否

每頁顯示的筆數,預設為 10 筆,最大 100 筆。

10

返回參數

名稱

類型

描述

樣本值

object

Schema of Response

RequestId

string

本次呼叫的唯一 ID。出現錯誤後,您可以根據該 ID 排查問題。

99EBE7CF-69C0-5089-BE3E-79563C31XXXX

PagingInfo

object

分頁資訊。

TotalCount

integer

滿足條件的資料總筆數。

131

PageSize

integer

每頁顯示的筆數。

10

PageNumber

integer

請求的資料頁數,用於翻頁。

1

Resources

array<object>

查詢傳回的資源清單。

array<object>

資源清單元素。

Name

string

資源名稱。

math.py

ProjectId

integer

DataWorks 工作空間的 ID。您可以登入 DataWorks 控制台,進入工作空間設定頁面獲取工作空間 ID。

344247

Owner

string

檔案資源的責任人。

110755000425XXXX

CreateTime

integer

檔案資源的建立時間戳記。

1724505917000

ModifyTime

integer

檔案資源最近修改的時間戳記。

1724505917000

DataSource

object

資料來源。

Name

string

資料來源名稱。

odps_first

Type

string

資料來源類型。

odps

Script

object

指令碼資訊。

Path

string

指令碼路徑。

root/demo

Runtime

object

執行階段。

Command

string

命令,表示檔案類型。

ODPS_PYTHON

Id

string

指令碼 id。

重要 該欄位在 SDK8.0.0 版本之前為 Long 類型,SDK8.0.0 版本及之後為 String 類型。該變更不影響 SDK 正常使用,參數仍會按 SDK 中定義的類型傳回。只有在跨 8.0.0 版本的 SDK 升級時,類型變更可能會導致專案編譯不通過,需要使用者手動修正資料類型。

123348864897630XXXX

Type

string

資源類型。

可選值:

  • Python

  • Jar

  • Archive

  • File

枚舉值:

  • Archive :

    Archive

  • Jar :

    Jar

  • File :

    File

  • Python :

    Python

Jar

SourceType

string

檔案資源來源儲存類型。

可選值

  • Local 本地

  • Oss 物件儲存

枚舉值:

  • local :

    本地。

  • oss :

    物件儲存。

Local

SourcePath

string

檔案資源來源路徑,type 為 local 時為空。

XXX/unknown/ide/1/XXX/20240820200851_963a9da676de44ef8d06a6576a8c4d6a.py

TargetType

string

檔案目標儲存類型。

可選值

  • Gateway 閘道

  • Oss 物件儲存服務

  • Hdfs hdfs 檔案儲存系統

枚舉值:

  • hdfs :

    hdfs 檔案儲存系統。

  • gateway :

    閘道。

  • oss :

    物件儲存服務。

Oss

TargetPath

string

檔案目標儲存路徑。

XXX/unknown/ide/1/XXX/20240820200851_963a9da676de44ef8d06a6576a8c4d6a.py

Id

string

檔案資源唯一識別碼。

重要 該欄位在 SDK8.0.0 版本之前為 Long 類型,SDK8.0.0 版本及之後為 String 類型。該變更不影響 SDK 正常使用,參數仍會按 SDK 中定義的類型傳回。只有在跨 8.0.0 版本的 SDK 升級時,類型變更可能會導致專案編譯不通過,需要使用者手動修正資料類型。

631478864897630XXXX

樣本

正常返回樣本

JSON格式

{
  "RequestId": "99EBE7CF-69C0-5089-BE3E-79563C31XXXX",
  "PagingInfo": {
    "TotalCount": 131,
    "PageSize": 10,
    "PageNumber": 1,
    "Resources": [
      {
        "Name": "math.py",
        "ProjectId": 344247,
        "Owner": "110755000425XXXX",
        "CreateTime": 1724505917000,
        "ModifyTime": 1724505917000,
        "DataSource": {
          "Name": "odps_first",
          "Type": "odps"
        },
        "Script": {
          "Path": "root/demo",
          "Runtime": {
            "Command": "ODPS_PYTHON"
          },
          "Id": "123348864897630XXXX"
        },
        "Type": "Jar",
        "SourceType": "Local",
        "SourcePath": "XXX/unknown/ide/1/XXX/20240820200851_963a9da676de44ef8d06a6576a8c4d6a.py",
        "TargetType": "Oss",
        "TargetPath": "XXX/unknown/ide/1/XXX/20240820200851_963a9da676de44ef8d06a6576a8c4d6a.py",
        "Id": "631478864897630XXXX"
      }
    ]
  }
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情。