ListMetaCollectionEntities - DataWorks - Alibaba Cloud Documentation Center

Queries the entities in a collection.

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
CollectionQualifiedName	string	Yes	The unique identifier of the collection.	album.12345
EntityType	string	No	The type of the entities. For example, if this parameter is set to maxcompute-table, the entity is a MaxCompute table.	maxcompute-table
Keyword	string	No	The search keyword.	test
NextToken	string	No	The pagination token that is used in the next request to retrieve a new page of results.	12222
PageSize	integer	No	The number of entries per page.	10

Response parameters

Parameter	Type	Description	Example
	object	OpenApiMetaResultModel
Data	object	The response parameters.
NextToken	string	A pagination token. It can be used in the next request to retrieve a new page of results.	123344
EntityList	array	The entities.
EntityList	Entity	The entities.
RequestId	string	The request ID. You can locate logs and troubleshoot issues based on the ID.	E25887B7-579C-54A5-9C4F-83A0DE367DD
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
ErrorCode	string	The error code.	Invalid.Collection.NotExists
ErrorMessage	string	The error message.	The specified parameters are invalid.
HttpStatusCode	integer	The HTTP status code.	200

Examples

Sample success responses

JSONformat

{
  "Data": {
    "NextToken": "123344",
    "EntityList": [
      {
        "QualifiedName": "maxcompute_table.563f0357118d05ef145d6bddf2966cc23e86ca8f2f013f915e565afdf09f7a23",
        "TenantId": 12345,
        "EntityContent": {
          "test": "test",
          "test2": 1
        }
      }
    ]
  },
  "RequestId": "E25887B7-579C-54A5-9C4F-83A0DE367DD",
  "Success": true,
  "ErrorCode": "Invalid.Collection.NotExists",
  "ErrorMessage": "The specified parameters are invalid.",
  "HttpStatusCode": 200
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2024-04-17	The internal configuration of the API is changed, but the call is not affected	View Change Details