ListEntitiesInMetaCollection-阿里云帮助中心

Operation description

DataWorks Professional Edition or a higher edition is required.

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
Id	string	Yes	The collection ID.	as78d756asd
EntityType	string	No	The entity type.	dlf-table
EntityName	string	No	The entity name. Supports fuzzy matching.	test1
EntityDescription	string	No	The description specified when the entity was added to the collection. Supports fuzzy matching. Valid only for the album type.	test
SortBy	string	No	The sort field. Valid values: Name (default) CreateTime	Name
Order	string	No	The sort order. Valid values: Asc (default): ascending order. Desc	Asc
PageNumber	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of records per page. Default value: 10. Maximum value: 100.	10

Response elements

Element	Type	Description	Example
	object	The response.
RequestId	string	The request ID.	F05080B0-CCE6-5D22-B284-34A51C5D4E28
PagingInfo	object	The pagination result.
TotalCount	integer	The total number of records.	100
PageNumber	integer	The current page number.	1
PageSize	integer	The number of records per page.	1
Entities	array<object>	The list of entities in the collection.
	object	The entity in the collection.
Id	string	The ID of the entity. Currently, only the Table type is supported. If the entity is deleted, this field is empty.	maxcompute-table:::project_name:[schema_name]:table_name
Type	string	The entity type.	maxcompute-table
Name	string	The entity name.	test_table
Comment	string	The entity comment.	test
CreateTime	integer	The creation time in milliseconds.	1737078994080
ModifyTime	integer	The last modified time in milliseconds.	1737078994080
Description	string	The description specified when the entity was added to the collection. Valid only for albums.	test

Examples

Success response

JSON format

{
  "RequestId": "F05080B0-CCE6-5D22-B284-34A51C5D4E28",
  "PagingInfo": {
    "TotalCount": 100,
    "PageNumber": 1,
    "PageSize": 1,
    "Entities": [
      {
        "Id": "maxcompute-table:::project_name:[schema_name]:table_name",
        "Type": "maxcompute-table",
        "Name": "test_table",
        "Comment": "test",
        "CreateTime": 1737078994080,
        "ModifyTime": 1737078994080,
        "Description": "test"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.