ListMetaEntities - DataWorks - Alibaba Cloud Documentation Center

Lists metadata entities. Support is currently limited to custom types.

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 syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
EntityType	string	Yes	The type of the entity to list.	custom_entity-customer_api
MaxResults	integer	No	The maximum number of results to return per page. Default value: 10. Maximum value: 100.	10
NextToken	string	No	The pagination token that specifies the next page of results. To retrieve the first page, do not specify this parameter. To retrieve subsequent pages, set this parameter to the `NextToken` value from the previous response.	AAAAAaUpAxoCTD/+sbOf3f+uxvnYyILMeAjoTFQSX64R12GN
Name	string	No	Filters entities by name. This is a containment match.	xm_create_test
Comment	string	No	Filters entities by comment. This is a token-based match.	this is a comment
AttributeFilters	array<object>	No	Conditions for filtering entities by entity attributes. The `AND` operator is used between different filters, and the `OR` operator is used for multiple values within a single filter.	[]
	object	No	A single filter condition for an entity attribute.
Key	string	Yes	The key of the entity attribute to filter by.	key1
Values	array	No	A list of values for the specified entity attribute.
	string	No	A value for the entity attribute.	value1
CustomAttributeFilters	array<object>	No	Conditions for filtering entities by custom attributes. The `AND` operator is used between different filters, and the `OR` operator is used for multiple values within a single filter. This parameter supports only `ENUM` custom attributes.	[]
	object	No	A single filter condition for a custom attribute.
Key	string	Yes	The key of the custom attribute to filter by.	custom_attr_1
Values	array	No	A list of values for the specified custom attribute.
	string	No	A value for the custom attribute.	value1
SortBy	string	No	The field to use for sorting the results.	Name
Order	string	No	The sort order. Valid values: `Asc` and `Desc`.	Asc

Response elements

Element	Type	Description	Example
	object	The response schema.
RequestId	string	The request ID.	ADFASDFASDFA-ADFASDF-ASDFADSDF-AFFADS
Success	boolean	Indicates whether the request succeeded.	true
PagingInfo	object	Pagination information.
TotalCount	integer	The total number of entries.	10
MaxResults	integer	The maximum number of entries per page.	10
NextToken	string	The token used to retrieve the next page of results. If this parameter is empty, no more results are available.	AAAAAdEdsXbwG2ZlbWCzN4wTTg6NmTbhyvglcoMCJsiEdngaTov15YaMyduvjIHYeTOIcEeXqCevM1qffZkwCkUTUYc=
MetaEntities	array	A list of metadata entities.
	MetaEntity	A metadata entity object.

Examples

Success response

JSON format

{
  "RequestId": "ADFASDFASDFA-ADFASDF-ASDFADSDF-AFFADS",
  "Success": true,
  "PagingInfo": {
    "TotalCount": 10,
    "MaxResults": 10,
    "NextToken": "AAAAAdEdsXbwG2ZlbWCzN4wTTg6NmTbhyvglcoMCJsiEdngaTov15YaMyduvjIHYeTOIcEeXqCevM1qffZkwCkUTUYc=",
    "MetaEntities": [
      {
        "Id": "custom_entity-customer_api:api_001",
        "EntityType": "custom_entity-customer_api",
        "Name": "api_001",
        "Comment": "this is a comment",
        "OwnerId": "207924799988354",
        "CustomAttributes": {
          "key": [
            "张三"
          ]
        },
        "MetaEntityDef": {
          "Name": "biz_api",
          "EntityType": "custom_entity-biz_api",
          "DisplayName": "业务API",
          "Description": "test",
          "AttributeDefs": [
            {
              "Name": "apiCode",
              "DisplayName": "API编码",
              "Type": "STRING",
              "IsOptional": true,
              "SearchFilterEnabled": false,
              "DisplayEnabled": true,
              "AllowedValues": [
                "LABEL_1"
              ],
              "Description": "层级描述"
            }
          ],
          "Extend": "NONE",
          "CreateTime": 1780553640613,
          "ModifyTime": 1780553640613
        },
        "CreateTime": 1780553640613,
        "ModifyTime": 1763380628000,
        "Attributes": {
          "key": "v1"
        }
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.