ListMetaEntityDefs - DataWorks: Central de Documentação do Alibaba Cloud

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

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

dataworks:ListMetaEntityDefs

list

*Todos os recursos.

*

Nenhuma

Sintaxe da solicitação

POST  HTTP/1.1

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
PageNumber	integer	Não	O número da página. Valor padrão: 1.	1
PageSize	integer	Não	O número de entradas por página. Valor padrão: 10. Valor máximo: 100.	10
DisplayName	string	Não	O nome de exibição da definição de tipo. Correspondência por contenção de texto simples.	CustomReport
Description	string	Não	A descrição. Correspondência por correspondência aproximada.	description
Extend	string	Não	O filtro de modo de extensão. Valores válidos: NONE: Apenas entidade personalizada. TABLE: Entidade de tabela de extensão. Valores válidos: TABLE : Entidade de tabela de extensão. NONE : Apenas entidade personalizada.	TABLE
SortBy	string	Não	O campo pelo qual ordenar os resultados. Valores válidos: Name: Ordenado por nome. CreateTime: Ordenado por hora de criação. ModifyTime: Ordenado por hora de modificação. Valores válidos: ModifyTime : Ordenado por hora de modificação. CreateTime : Ordenado por hora de criação. Name : Ordenado por nome.	CreateTime
Order	string	Não	A direção da ordenação. Valores válidos: Asc: Ordem crescente. Desc: Ordem decrescente. Valores válidos: Asc : Ordem crescente. Desc : Ordem decrescente.	Asc

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Esquema da resposta.
RequestId	string	O ID da solicitação.	ADFASDFASDFA-ADFASDF-ASDFADSDF-AFFADS
Success	boolean	Indica se a solicitação foi bem-sucedida.	true
PagingInfo	object	As informações de paginação.
TotalCount	integer	O número total de entradas.	10
PageNumber	integer	O número da página.	1
PageSize	integer	O número de entradas por página.	10
MetaEntityDefs	array	A lista de definições de entidades personalizadas.
	MetaEntityDef	A definição de entidade personalizada.

Exemplos

Resposta de sucesso

JSON formato

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

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.