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

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

Response elements

Element	Type	Description	Example
	object	OpenApiMetaResultModel
Data	object	The response parameters.
NextToken	string	The pagination token for the next request to retrieve a new page of results.	123344
EntityList	array	The entities.
	Entity	The entities.
RequestId	string	The request ID. You can use the ID to locate logs and troubleshoot issues.	E25887B7-579C-54A5-9C4F-83A0DE367DD
Success	boolean	Indicates whether the request was successful. 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

Success response

JSON format

{
  "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.