ListResources - DataWorks - Alibaba Cloud Documentation Center

Queries a list of file resources in DataStudio. You can also specify filter conditions to query specific file resources.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
ProjectId	string	Yes	The DataWorks workspace ID. You can log on to the DataWorks console and go to the Workspace page to query the ID. You must configure this parameter to specify the DataWorks workspace to which the API operation is applied.	10002
Owner	string	No	The ID of the Alibaba Cloud account used by the workspace administrator. You can log on to the Alibaba Cloud Management Console and view the ID on the Security Settings page.	110755000425XXXX
Type	string	No	The resource type. This parameter specifies a filter condition. Valid values: Python Jar Archive File	python
PageNumber	integer	No	The page number.	1
PageSize	integer	No	The number of entries per page. Default value: 10. Maximum value: 100.	10

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	99EBE7CF-69C0-5089-BE3E-79563C31XXXX
PagingInfo	object	The pagination information.
TotalCount	integer	The total number of entries returned.	131
PageSize	integer	The number of entries per page.	10
PageNumber	integer	The page number.	1
Resources	array<object>	The file resources.
resource	object	The information about the file resource.
Id	string	The ID of the file resource.	631478864897630XXXX
Name	string	The name of the file resource.	math.py
ProjectId	string	The DataWorks workspace ID. You can log on to the DataWorks console and go to the Workspace page to query the ID.	344247
Owner	string	The owner of the file resource.	110755000425XXXX
CreateTime	long	The time when the file resource was created. This value is a UNIX timestamp.	1724505917000
ModifyTime	long	The times when the file resource was last modified. This value is a UNIX timestamp.	1724505917000
DataSource	object	The information about the data source.
Name	string	The name of the data source.	odps_first
Type	string	The type of the data source.	odps
Script	object	The script information.
Path	string	The script path.	root/demo
Runtime	object	The runtime.
Command	string	The command used to distinguish file resource types.	ODPS_PYTHON
Id	string	The script ID.	123348864897630XXXX
Type	string	The type of the file resource. Valid values: Python Jar Archive File	jar
SourceType	string	The storage type of the source of the file resource. Valid values: Local Oss	local
SourcePath	string	The path of the source of the file resource. If the SourecType parameter is set to Local, this parameter is left empty.	XXX/unknown/ide/1/XXX/20240820200851_963a9da676de44ef8d06a6576a8c4d6a.py
TargetType	string	The storage type of the destination of the file resource. Valid values: Gateway Oss Hdfs	oss
TargetPath	string	The storage path of the destination of the file resource.	XXX/unknown/ide/1/XXX/20240820200851_963a9da676de44ef8d06a6576a8c4d6a.py

Examples

Sample success responses

JSONformat

{
  "RequestId": "99EBE7CF-69C0-5089-BE3E-79563C31XXXX",
  "PagingInfo": {
    "TotalCount": 131,
    "PageSize": 10,
    "PageNumber": 1,
    "Resources": [
      {
        "Id": "631478864897630XXXX",
        "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"
      }
    ]
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history