GetMetaEntityDef-阿里云帮助中心

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 entity type. The value must match the regular expression `^custom_(?:entity-[A-Za-z0-9_]+\|[A-Za-z0-9_]+-(?:database\|table\|column))$`.	custom_entity-customer_api

Response elements

Element	Type	Description	Example
	object	The response schema.
RequestId	string	The request ID.	C636A747-7E4E-594D-94CD-2B4F8A9A9A63
Success	boolean	Indicates whether the request succeeded.	true
MetaEntityDef	MetaEntityDef	The custom entity definition.

Examples

Success response

JSON format

{
  "RequestId": "C636A747-7E4E-594D-94CD-2B4F8A9A9A63",
  "Success": true,
  "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
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.