ListDataAssets-阿里云帮助中心

Queries the information about DataWorks data assets to which tags are added by page.

Operation description

This API operation is available only for DataWorks Enterprise Edition or a more advanced edition.

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 tags that are added to data assets. This parameter specifies a filter condition. You can specify multiple tags, which are in the logical OR relation. For example, you can query the data assets that contain one of the following tags: `["key1:v1", "key2:v1", "key3:v1"]`. If you do not configure this parameter, tag-based filtering is not performed.
	object	Yes	The tag that is added to the data asset. The tag is specified in the key:value structure.
Key	string	Yes	The tag key. The tag key can be up to 64 characters in length and can contain letters, digits, and the following characters: `-@#*<>\|[]()+=&%$!~`. It cannot start with `dw:`.	key
Value	string	No	The tag value.	value
DataAssetIds	array	No	The data asset IDs.
	string	No	The data asset ID.	7000069357000
DataAssetType	string	No	The type of the data asset. Valid values: ACS::DataWorks::Table ACS::DataWorks::Task	ACS::DataWorks::Task
ProjectId	integer	No	The DataWorks 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 environment of the workspace to which the data asset belongs. Valid values: Dev: development environment Prod: production environment	Prod

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	0bc1ec92159376
PagingInfo	object	The pagination information.
TotalCount	integer	The total number of entries returned.	100
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	10
DataAssets	array<object>	The data assets.
	array<object>	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 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

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.