すべてのプロダクト
Search
ドキュメントセンター

DataWorks:ListResources

最終更新日:Sep 03, 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:*

list

*すべてのリソース。

*

なし なし

リクエストパラメーター

パラメーター

型

必須 / 任意

説明

例

ProjectId

integer

必須

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

このパラメーターは、この API 呼び出しの対象となる DataWorks ワークスペースを指定します。

10002

Owner

string

任意

オーナーの ID で、ワークスペース管理者のアカウント UID です。Alibaba Cloud マネジメントコンソールにログインし、アカウント管理のセキュリティ管理セクションでアカウント 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

任意

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

10

レスポンスフィールド

フィールド

型

説明

例

object

レスポンスのスキーマ。

RequestId

string

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

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

PagingInfo

object

ページネーション情報。

TotalCount

integer

フィルター条件に一致するエントリの総数。

131

PageSize

integer

1 ページあたりのエントリ数。

10

PageNumber

integer

リクエストのページ番号。ページネーションに使用されます。

1

Resources

array<object>

クエリによって返されるリソースのリスト。

array<object>

リソースリスト内の要素。

Name

string

リソース名。

math.py

ProjectId

integer

DataWorks ワークスペースの ID。ワークスペース ID を取得するには、DataWorks コンソールにログインし、ワークスペース設定ページに移動します。

344247

Owner

string

ファイルリソースの所有者。

110755000425XXXX

CreateTime

integer

ファイルリソースが作成された時刻。この値は UNIX タイムスタンプです。

1724505917000

ModifyTime

integer

ファイルリソースが最後に変更されたタイムスタンプ。

1724505917000

DataSource

object

データソース。

Name

string

データソースの名前。

odps_first

Type

string

データソースのタイプ。

odps

Script

object

スクリプト情報。

Path

string

スクリプトパス。

root/demo

Runtime

object

Runtime

Command

string

コマンド。このパラメーターはファイルタイプを示します。

ODPS_PYTHON

Id

string

スクリプトの ID。

説明

このフィールドは、SDK バージョン 8.0.0 以前では Long 型であり、SDK バージョン 8.0.0 以降では String 型です。この変更は、SDK の通常の使用には影響しません。パラメーターは、SDK で定義されたタイプに基づいて返されます。タイプ変更によって引き起こされるコンパイルエラーは、SDK をバージョン 8.0.0 を超えてアップグレードする場合にのみ発生する可能性があります。この場合、手動でデータの型を更新する必要があります。

123348864897630XXXX

Type

string

リソースタイプ。

有効な値:

  • Python

  • Jar

  • Archive

  • File

列挙値:

  • Archive :

    Archive

  • Jar :

    Jar

  • File :

    File

  • Python :

    Python

Jar

SourceType

string

ファイルリソースのソースストレージタイプ。

有効な値:

  • Local

  • OSS

列挙値:

  • Local :

    Local

  • Oss :

    Oss

Local

SourcePath

string

ファイルリソースのソースパス。タイプが Local の場合、このパラメーターは空です。

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

TargetType

string

送信先ストレージタイプ。

有効な値:

  • Gateway

  • OSS

  • HDFS

列挙値:

  • Gateway :

    Gateway

  • Hdfs :

    Hdfs

  • Oss :

    Oss

Oss

TargetPath

string

宛先のストレージパスです。

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

Id

string

ファイルリソースの一意の識別子。

説明

SDK バージョン 8.0.0 以前では、このフィールドは Long 型です。SDK バージョン 8.0.0 以降では、String 型です。この変更は、SDK の通常の使用には影響しません。パラメーターは、SDK で定義されたタイプに基づいて返されます。タイプ変更によって引き起こされるコンパイルエラーは、SDK をバージョン 8.0.0 を超えてアップグレードする場合にのみ発生する可能性があります。この場合、手動でデータの型を更新する必要があります。

631478864897630XXXX

例

成功レスポンス

JSONJSON

{
  "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"
      }
    ]
  }
}

エラーコード

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

変更履歴

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