Todos os produtos
Search
Central de documentação

DataWorks:GetMetaEntityDef

Última atualização: Sep 03, 2026

Obtém os detalhes de uma definição de entidade personalizada.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

Nenhuma autorização necessária para esta operação. Se você encontrar problemas com esta operação, entre em contato com o suporte técnico.

Sintaxe da solicitação

POST  HTTP/1.1

Parâmetros da solicitação

Parâmetro

Tipo

Obrigatório

Descrição

Exemplo

EntityType

string

Sim

O tipo de entidade. O valor deve corresponder à expressão regular ^custom_(?:entity-[A-Za-z0-9_]+|[A-Za-z0-9_]+-(?:database|table|column))$.

custom_entity-customer_api

Elementos de resposta

Elemento

Tipo

Descrição

Exemplo

object

O esquema da resposta.

RequestId

string

O ID da solicitação.

C636A747-7E4E-594D-94CD-2B4F8A9A9A63

Success

boolean

Indica se a solicitação foi bem-sucedida.

true

MetaEntityDef MetaEntityDef

A definição de entidade personalizada.

Exemplos

Resposta de sucesso

JSON formato

{
  "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
  }
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.