Todos os produtos
Search
Central de documentação

DataWorks:ListMetaCollectionEntities

Última atualização: Sep 04, 2026

Consulta entidades em uma coleção.

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

list

*Todos os recursos.

*

Nenhuma Nenhuma

Parâmetros da solicitação

Parâmetro

Tipo

Obrigatório

Descrição

Exemplo

CollectionQualifiedName

string

Sim

O identificador único da coleção.

album.12345

EntityType

string

Não

O tipo de entidade. Exemplo: maxcompute-table indica o tipo de tabela do MaxCompute.

maxcompute-table

Keyword

string

Não

A palavra-chave de pesquisa.

teste

NextToken

string

Não

O token de paginação que especifica o ponto inicial da operação de leitura atual.

12222

PageSize

integer

Não

O tamanho da página.

10

Elementos de resposta

Elemento

Tipo

Descrição

Exemplo

object

OpenApiMetaResultModel.

Data

object

A estrutura da resposta.

NextToken

string

O token para a próxima página.

123344

EntityList

array

O array de entidades.

Entity

As informações da entidade.

RequestId

string

O ID da solicitação. Você pode usar este ID para localizar logs e solucionar problemas.

E25887B7-579C-54A5-9C4F-83A0DE367DD

Success

boolean

Indica se a chamada foi bem-sucedida. Valores válidos:\n- true: A chamada foi bem-sucedida.\n- false: A chamada falhou.

true

ErrorCode

string

O código de erro.

Invalid.Collection.NotExists

ErrorMessage

string

A mensagem de erro.

Os parâmetros especificados são inválidos

HttpStatusCode

integer

O código de status HTTP.

200

Exemplos

Resposta de sucesso

JSON formato

{
  "Data": {
    "NextToken": "123344",
    "EntityList": [
      {
        "QualifiedName": "maxcompute_table.563f0357118d05ef145d6bddf2966cc23e86ca8f2f013f915e565afdf09f7a23",
        "TenantId": 12345,
        "EntityContent": {
          "test": "test",
          "test2": 1
        }
      }
    ]
  },
  "RequestId": "E25887B7-579C-54A5-9C4F-83A0DE367DD",
  "Success": true,
  "ErrorCode": "Invalid.Collection.NotExists",
  "ErrorMessage": "The specified parameters are invalid.",
  "HttpStatusCode": 200
}

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.