ListMetaEntityDefs - DataWorks - Alibaba Cloud Documentation Center

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
PageNumber	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each page. Default value: 10. Maximum value: 100.	10
DisplayName	string	No	The display name of the type definition. This parameter supports partial matching.	CustomReport
Description	string	No	A keyword to search for in the description. The system performs a fuzzy match.	description
Extend	string	No	Filters the results by extension mode. Valid values: `NONE` and `TABLE`.	NONE
SortBy	string	No	The sort field. Valid values: `Name`, `CreateTime`, and `ModifyTime`.	CreateTime
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 ID of the request.	ADFASDFASDFA-ADFASDF-ASDFADSDF-AFFADS
Success	boolean	Indicates whether the request succeeded.	true
PagingInfo	object	The pagination information.
TotalCount	integer	The total count.	10
PageNumber	integer	The page number.	1
PageSize	integer	The page size.	10
MetaEntityDefs	array	A list of custom entity definitions.
	MetaEntityDef	A custom entity definition.

Examples

Success response

JSON format

{
  "RequestId": "ADFASDFASDFA-ADFASDF-ASDFADSDF-AFFADS",
  "Success": true,
  "PagingInfo": {
    "TotalCount": 10,
    "PageNumber": 1,
    "PageSize": 10,
    "MetaEntityDefs": [
      {
        "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
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.