ListMetaEntityDefs-阿里云帮助中心

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:ListMetaEntityDefs

list

*All Resource

*

None

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 per page. Default value: 10. Maximum value: 100.	10
DisplayName	string	No	The display name of the type definition. Matched by plain text containment.	CustomReport
Description	string	No	The description. Matched by fuzzy match.	description
Extend	string	No	The extension mode filter. Valid values: NONE: custom entity only. TABLE: extension table entity. Valid values: TABLE : Extension table entity. NONE : Custom entity only.	TABLE
SortBy	string	No	The field by which to sort the results. Valid values: Name: sorted by name. CreateTime: sorted by creation time. ModifyTime: sorted by modification time. Valid values: ModifyTime : Sorted by modification time. CreateTime : Sorted by creation time. Name : Sorted by name.	CreateTime
Order	string	No	The sort direction. Valid values: Asc: ascending order. Desc: descending order. 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 was successful.	true
PagingInfo	object	The paging information.
TotalCount	integer	The total number of entries.	10
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	10
MetaEntityDefs	array	The list of custom entity definitions.
	MetaEntityDef	The 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.