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

Lista entidades de metadados. O suporte atualmente é limitado a tipos personalizados.

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 da entidade a ser listada.	custom_entity-customer_api
MaxResults	integer	Não	O número máximo de resultados a serem retornados por página. Valor padrão: 10. Valor máximo: 100.	10
NextToken	string	Não	O token de paginação que especifica a próxima página de resultados. Para recuperar a primeira página, não especifique este parâmetro. Para recuperar as páginas subsequentes, defina este parâmetro com o valor NextToken da resposta anterior.	AAAAAaUpAxoCTD/+sbOf3f+uxvnYyILMeAjoTFQSX64R12GN
Name	string	Não	Filtra entidades por nome. Esta é uma correspondência de contenção.	xm_create_test
Comment	string	Não	Filtra entidades por comentário. Esta é uma correspondência baseada em tokens.	this is a comment
AttributeFilters	array<object>	Não	Condições para filtrar entidades por atributos da entidade. O operador AND é usado entre filtros diferentes, e o operador OR é usado para vários valores dentro de um único filtro.	[]
	object	Não	Uma única condição de filtro para um atributo da entidade.
Key	string	Sim	A chave do atributo da entidade pelo qual filtrar.	key1
Values	array	Não	Uma lista de valores para o atributo da entidade especificado.
	string	Não	Um valor para o atributo da entidade.	value1
CustomAttributeFilters	array<object>	Não	Condições para filtrar entidades por atributos personalizados. O operador AND é usado entre filtros diferentes, e o operador OR é usado para vários valores dentro de um único filtro. Este parâmetro suporta apenas atributos personalizados ENUM.	[]
	object	Não	Uma única condição de filtro para um atributo personalizado.
Key	string	Sim	A chave do atributo personalizado pelo qual filtrar.	custom_attr_1
Values	array	Não	Uma lista de valores para o atributo personalizado especificado.
	string	Não	Um valor para o atributo personalizado.	value1
SortBy	string	Não	O campo a ser usado para classificar os resultados.	Name
Order	string	Não	A ordem de classificação. Valores válidos: Asc e Desc.	Asc

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	O 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	Informações de paginação.
TotalCount	integer	O número total de entradas.	10
MaxResults	integer	O número máximo de entradas por página.	10
NextToken	string	O token usado para recuperar a próxima página de resultados. Se este parâmetro estiver vazio, não há mais resultados disponíveis.	AAAAAdEdsXbwG2ZlbWCzN4wTTg6NmTbhyvglcoMCJsiEdngaTov15YaMyduvjIHYeTOIcEeXqCevM1qffZkwCkUTUYc=
MetaEntities	array	Uma lista de entidades de metadados.
	MetaEntity	Um objeto de entidade de metadados.

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.