ListDataAssets-DataWorks(DataWorks)-阿里云帮助中心

Queries DataWorks data assets that are associated with tags by paging.

Operation description

You must purchase DataWorks Enterprise Edition or a higher edition to use this feature.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dataworks:*

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Tags	array<object>	No	The list of tags associated with data assets. Tags are used as query filters: Multiple values have an OR relationship. For example, `["key1:v1", "key2:v1", "key3:v1"]` queries data assets that contain any one of the specified tags. If this parameter is not specified or is left empty, no tag-based filtering is applied.
	object	No	The tag key-value structure definition.
Key	string	No	The custom tag key specified by the user. The tag key can be up to 64 characters in length, cannot start with `dw:`, and supports only letters, digits, and the following special characters: `-@#*<>\|[]()+=&%$!~`.	key
Value	string	No	The tag value.	value
DataAssetIds	array	No	The list of unique data asset IDs.
	string	No	The unique ID of the data asset.	7000069357000
DataAssetType	string	No	The Asset Type of the data asset. Valid values: ACS::DataWorks::Table: data table. ACS::DataWorks::Task: scheduling node.	ACS::DataWorks::Task
ProjectId	integer	No	The ID of the workspace.	10000
PageNumber	integer	No	The page number. Pages start from 1. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Default value: 10. Maximum value: 100.	10
EnvType	string	No	The workspace environment to which the data asset belongs. Valid values: Dev: development environment. Prod: production environment.	Prod
AssetDomainId	integer	No	The ID of the asset domain.	1001
CategoryUuid	string	No	The ID of the asset category.	cate-xxxxxxxx
Name	string	No	The name of the asset. Fuzzy search by name is supported.	AssetDomainName

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	Id of the request	0bc1ec92159376
PagingInfo	object	The pagination information.
TotalCount	integer	The total number of entries.	100
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	10
DataAssets	array<object>	The list of data assets.
	array<object>	The schema definition of the data asset.
Id	string	The data asset ID.	7259557313
Name	string	The name of the data asset.	ali_cn_es_gfn
Type	string	The Asset Type of the data asset. Valid values: ACS::DataWorks::Table: table. ACS::DataWorks::Task: scheduling node.	ACS::DataWorks::Task
EnvType	string	The workspace environment to which the data asset belongs. Valid values: Dev: development environment. Prod: production environment.	Prod
ProjectId	integer	The DataWorks workspace ID.	54275
DataAssetTagMappings	array<object>	The list of tags associated with the data asset.
	object	The schema definition of the mapping between a data asset and a tag.
Key	string	The tag key.	key
Value	string	The tag value.	value
TagSource	string	The source of the mapping between the data asset and the tag. Valid values: System: The mapping is created by the data asset governance system. UserDefined: The mapping is manually created by a user.	UserDefined
Creator	string	The creator of the mapping between the data asset and the tag.	12345
AutoTraceEnabled	boolean	Indicates whether automatic lineage tracing is enabled.	false
DataAssetId	string	The data asset ID.	7259557313
AssetCategories	array<object>
	object
Id	string		cate-xxxxxx
Name	string		资产域名称
AssetDomainId	string		1001

Examples

Success response

JSON format

{
  "RequestId": "0bc1ec92159376",
  "PagingInfo": {
    "TotalCount": 100,
    "PageNumber": 1,
    "PageSize": 10,
    "DataAssets": [
      {
        "Id": "7259557313",
        "Name": "ali_cn_es_gfn",
        "Type": "ACS::DataWorks::Task",
        "EnvType": "Prod",
        "ProjectId": 54275,
        "DataAssetTagMappings": [
          {
            "Key": "key",
            "Value": "value",
            "TagSource": "UserDefined",
            "Creator": "12345",
            "AutoTraceEnabled": false,
            "DataAssetId": "7259557313"
          }
        ],
        "AssetCategories": [
          {
            "Id": "cate-xxxxxx",
            "Name": "资产域名称",
            "AssetDomainId": "1001"
          }
        ]
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.