ListResources - 获取数据开发文件资源列表

更新时间:
复制 MD 格式

调用此接口,可以分页获取资源文件,也可以对资源进行筛选。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dataworks:*

list

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

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

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情