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

Queries a list of metadata entities. Currently, only custom entity types are supported.

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dataworks:ListMetaEntities

list

*All Resource

*

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
EntityType	string	Yes	The entity type.	custom_entity-customer_api
MaxResults	integer	No	The maximum number of results per page. Default value: 10. Maximum value: 100.	10
NextToken	string	No	The pagination token. Do not specify this parameter for the first request. For subsequent requests, use the NextToken value returned in the previous response.	AAAAAaUpAxoCTD/+sbOf3f+uxvnYyILMeAjoTFQSX64R12GN
Name	string	No	The entity name filter. Performs keyword-contains matching.	xm_create_test
Comment	string	No	The comment filter. Performs token matching.	this is a comment
AttributeFilters	array<object>	No	The entity attribute filter conditions. Multiple filter conditions have an AND relationship. Multiple values within the same filter condition have an OR relationship.	[]
	object	No	The entity attribute filter.
Key	string	Yes	The filter attribute key.	key1
Values	array	No	The list of filter attribute values.
	string	No	The filter attribute value.	value1
CustomAttributeFilters	array<object>	No	The custom attribute filter conditions. Multiple filter conditions have an AND relationship. Multiple values within the same filter condition have an OR relationship. Only ENUM custom attributes are supported.	[]
	object	No	The custom attribute filter.
Key	string	Yes	The filter attribute key.	custom_attr_1
Values	array	No	The list of filter attribute values.
	string	No	The filter attribute value.	value1
SortBy	string	No	The sort field. Valid values: ModifyTime : sort by modification time. CreateTime : sort by creation time. Name : sort by name.	Name
Order	string	No	The sort direction. Valid values: Asc : ascending order. Desc : descending order.	Asc

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	ADFASDFASDFA-ADFASDF-ASDFADSDF-AFFADS
Success	boolean	Indicates whether the request is successful.	true
PagingInfo	object	The pagination information.
TotalCount	integer	The total number of entries.	10
MaxResults	integer	The maximum number of results per page.	10
NextToken	string	The pagination token for the next page.	AAAAAdEdsXbwG2ZlbWCzN4wTTg6NmTbhyvglcoMCJsiEdngaTov15YaMyduvjIHYeTOIcEeXqCevM1qffZkwCkUTUYc=
MetaEntities	array	The list of custom entities.
	MetaEntity	The custom 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.