GetMetaEntity-阿里云帮助中心

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
Id	string	Yes	The entity ID.	custom_entity-customer_api:api_001

Response elements

Element	Type	Description	Example
	object	The response schema.
RequestId	string	The request ID.	0A04C673-BEFA-5803-94E5-89E2D9F8C567
Success	boolean	Indicates whether the request succeeded.	true
MetaEntity	MetaEntity	The custom entity object.

Examples

Success response

JSON format

{
  "RequestId": "0A04C673-BEFA-5803-94E5-89E2D9F8C567",
  "Success": true,
  "MetaEntity": {
    "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": "customer_api",
      "EntityType": "custom_entity-customer_api",
      "DisplayName": "",
      "Description": "",
      "AttributeDefs": [
        {
          "Name": "apiCode",
          "DisplayName": "API编码",
          "Type": "STRING",
          "IsOptional": true,
          "SearchFilterEnabled": false,
          "DisplayEnabled": true,
          "AllowedValues": [
            "LABEL_1"
          ],
          "Description": "层级描述"
        }
      ],
      "Extend": "NONE",
      "CreateTime": 0,
      "ModifyTime": 0
    },
    "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.