ListDataAssets API Reference for Tagged Asset Retrieval - DataWorks - Alibaba Cloud - 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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
Tags	array<object>	Yes	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 of the specified tags. If this parameter is not specified or is left empty, no tag-based filtering is applied.
	object	Yes	The tag key-value pair definition.
Key	string	Yes	The custom tag key. 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: table. ACS::DataWorks::Task: scheduling node.	ACS::DataWorks::Task
ProjectId	integer	No	The workspace ID.	10000
PageNumber	integer	No	The page number. Pages start from page 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

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 data asset schema definition.
Id	string	The data asset ID.	7259557313
Name	string	The name of the data asset.	ali_cn_es_gfn
Type	string	The type of the data asset. Valid values: ACS::DataWorks::Table ACS::DataWorks::Task	ACS::DataWorks::Task
EnvType	string	The environment of the workspace 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 mappings between data assets and tags.
	object	The mapping between the data asset and the tag.
Key	string	The tag key.	key
Value	string	The tag value.	value
TagSource	string	The way in which the mapping between the data asset and the tag is created. Valid values: System UserDefined	UserDefined
Creator	string	The creator of the mapping between the data asset and the tag.	12345
AutoTraceEnabled	boolean	Indicates whether the lineage-based automatic backtrack feature is enabled for the mapping.	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.