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

Consulta uma lista de entidades de metadados. Atualmente, apenas tipos de entidade personalizados são suportados.

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

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
EntityType	string	Sim	O tipo de entidade.	custom_entity-customer_api
MaxResults	integer	Não	O número máximo de resultados por página. Valor padrão: 10. Valor máximo: 100.	10
NextToken	string	Não	O token de paginação. Não especifique este parâmetro para a primeira solicitação. Para solicitações subsequentes, use o valor NextToken retornado na resposta anterior.	AAAAAaUpAxoCTD/+sbOf3f+uxvnYyILMeAjoTFQSX64R12GN
Name	string	Não	O filtro de nome da entidade. Realiza correspondência por contenção de palavra-chave.	xm_create_test
Comment	string	Não	O filtro de comentário. Realiza correspondência de tokens.	this is a comment
AttributeFilters	array<object>	Não	As condições de filtro de atributos da entidade. Múltiplas condições de filtro têm uma relação AND. Múltiplos valores dentro da mesma condição de filtro têm uma relação OR.	[]
	object	Não	O filtro de atributo da entidade.
Key	string	Sim	A chave do atributo de filtro.	key1
Values	array	Não	A lista de valores do atributo de filtro.
	string	Não	O valor do atributo de filtro.	value1
CustomAttributeFilters	array<object>	Não	As condições de filtro de atributos personalizados. Múltiplas condições de filtro têm uma relação AND. Múltiplos valores dentro da mesma condição de filtro têm uma relação OR. Apenas atributos personalizados ENUM são suportados.	[]
	object	Não	O filtro de atributo personalizado.
Key	string	Sim	A chave do atributo de filtro.	custom_attr_1
Values	array	Não	A lista de valores do atributo de filtro.
	string	Não	O valor do atributo de filtro.	value1
SortBy	string	Não	O campo de ordenação. Valores válidos: ModifyTime : Ordenar por hora de modificação. CreateTime : Ordenar por hora de criação. Name : Ordenar por nome.	Name
Order	string	Não	A direção da ordenação. 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
MaxResults	integer	O número máximo de resultados por página.	10
NextToken	string	O token de paginação para a próxima página.	AAAAAdEdsXbwG2ZlbWCzN4wTTg6NmTbhyvglcoMCJsiEdngaTov15YaMyduvjIHYeTOIcEeXqCevM1qffZkwCkUTUYc=
MetaEntities	array	A lista de entidades personalizadas.
	MetaEntity	O objeto de entidade personalizada.

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "ADFASDFASDFA-ADFASDF-ASDFADSDF-AFFADS",
  "Success": true,
  "PagingInfo": {
    "TotalCount": 10,
    "MaxResults": 10,
    "NextToken": "AAAAAdEdsXbwG2ZlbWCzN4wTTg6NmTbhyvglcoMCJsiEdngaTov15YaMyduvjIHYeTOIcEeXqCevM1qffZkwCkUTUYc=",
    "MetaEntities": [
      {
        "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": "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
        },
        "CreateTime": 1780553640613,
        "ModifyTime": 1763380628000,
        "Attributes": {
          "key": "v1"
        }
      }
    ]
  }
}

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.