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

Consulta uma lista de tabelas de dados no Data Map do DataWorks. Para tipos de fonte de dados que não suportam o nível de schema, esta operação consulta tabelas de dados em um banco de dados especificado. Para tipos de fonte de dados que suportam o nível de schema, esta operação consulta tabelas de dados em um banco de dados, projeto MaxCompute ou schema especificado. A resposta inclui apenas informações básicas sobre as tabelas de dados e exclui metadados técnicos e de negócios. Para fontes de dados que não sejam MaxCompute, a resposta não é em tempo real e pode ter um atraso de até uma hora em comparação com os resultados da coleta de metadados.

Descrição da operação

Você deve adquirir o DataWorks Basic Edition ou uma edição superior para usar esta operaçã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:ListTables

list

*All resources.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ParentMetaEntityId	string	Sim	O ID da entidade de metadados pai. Você pode consultar a resposta da operação ListDatabases ou ListSchemas, ou ver Conceitos de entidades de metadados. A entidade pai pode ser o banco de dados ao qual a tabela pertence. O formato de `ParentMetaEntityId` é `${EntityType}:${Instance ID or URL-encoded JDBC URL}:${Data catalog identifier}:${Database name}`. Use uma string vazia como espaço reservado para níveis inexistentes. A entidade pai também pode ser o schema do banco de dados ao qual a tabela pertence. O formato de `ParentMetaEntityId` é `${EntityType}:${Instance ID or URL-encoded JDBC URL}:${Data catalog identifier}:${Database name}:${Schema name}`. Use uma string vazia como espaço reservado para níveis inexistentes. Nota Você pode usar um schema de banco de dados para `ParentMetaEntityId` apenas quando o tipo de banco de dados suportar schemas (`maxcompute`, `holo`, `postgresql`, `sqlserver`, `hybriddb_for_postgresql` ou `oracle`). Para o MaxCompute, o modelo de três níveis deve estar ativado. Caso contrário, você só pode usar um banco de dados. Para fontes de dados MaxCompute e DLF, use uma string vazia como espaço reservado para o ID da instância. Para o MaxCompute, o nome do banco de dados é o nome do projeto MaxCompute. Para o StarRocks, o identificador do catálogo de dados é o nome do catálogo. Para o DLF, o identificador do catálogo de dados é o ID do catálogo. Outros tipos não suportam o nível de catálogo, portanto, você pode usar uma string vazia como espaço reservado. Os exemplos a seguir mostram os formatos de `ParentMetaEntityId` para tipos comuns de fontes de dados: `maxcompute-project:::project_name` `maxcompute-schema:::project_name:schema_name` (apenas quando o modelo de três níveis está ativado para o projeto) `dlf-database::catalog_id:database_name` `hms-database:instance_id::database_name` `holo-schema:instance_id::database_name:schema_name` `mysql-database:(instance_id\|encoded_jdbc_url)::database_name` Nota Onde: `instance_id`: o ID da instância, que é obrigatório quando a fonte de dados é registrada no modo de instância. `encoded_jdbc_url`: a string de conexão JDBC codificada por URL, que é obrigatória quando a fonte de dados é registrada usando uma string de conexão. `catalog_id`: o ID do catálogo DLF. `project_name`: o nome do projeto MaxCompute. `database_name`: o nome do banco de dados. `schema_name`: o nome do schema.	maxcompute-project:::project_name
Name	string	Não	O nome da tabela de dados. Há suporte para correspondência aproximada.	abc
Comment	string	Não	O comentário sobre a tabela de dados. Há suporte para correspondência aproximada.	this is a comment
TableTypes	array	Não	A lista de tipos de tabela a serem consultados. Se este parâmetro for deixado vazio, todos os tipos de tabela serão consultados.
	string	Não	O tipo de tabela. Os valores válidos variam de acordo com o tipo de banco de dados.	TABLE
SortBy	string	Não	O campo pelo qual ordenar os resultados. Valor padrão: CreateTime. Valores válidos: CreateTime: hora de criação ModifyTime: hora de modificação Name: nome TableType: tipo de tabela Valores válidos: ModifyTime : hora de modificação. TableType : tipo de tabela. CreateTime : hora de criação. Name : nome.	CreateTime
Order	string	Não	A ordem de classificação. Valor padrão: Asc. Valores válidos: Asc: ordem crescente Desc: ordem decrescente Valores válidos: Asc : ordem crescente. Desc : ordem decrescente.	Asc
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
IncludeExtendedProperties	boolean	Não	Especifica se as propriedades estendidas devem ser retornadas. Se este parâmetro for definido como `true`, as propriedades estendidas serão retornadas. Se este parâmetro for definido como `false`, as propriedades estendidas não serão retornadas.	true

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A resposta.
RequestId	string	O ID da solicitação.	E25887B7-579C-54A5-9C4F-83A****
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.	100
PageNumber	integer	O número da página.	1
PageSize	integer	O número de entradas por página.	10
Tables	array	A lista de tabelas de dados.
	Table	Os detalhes da tabela de dados.

Nota:

Os objetos Table retornados em Tables usam uma estrutura simplificada e não incluem as seguintes propriedades:

TechnicalMetadata
BusinessMetadata

Para obter os metadados técnicos ou de negócios de uma tabela, você deve chamar a operação GetTable para recuperar o objeto Table completo.

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "E25887B7-579C-54A5-9C4F-83A****",
  "Success": true,
  "PagingInfo": {
    "TotalCount": 100,
    "PageNumber": 1,
    "PageSize": 10,
    "Tables": [
      {
        "Id": "dlf-table::catalog_id:database_name::table_name",
        "Name": "table_name",
        "Comment": "Test table",
        "TableType": "TABLE",
        "PartitionKeys": [
          "ds"
        ],
        "ParentMetaEntityId": "dlf-database::catalog_id:database_name",
        "CreateTime": 1736852168000,
        "ModifyTime": 1736852168000,
        "TechnicalMetadata": {
          "Owner": "test_user",
          "Location": "oss://test-bucket/test_tbl",
          "Compressed": false,
          "InputFormat": "org.apache.hadoop.hive.ql.io.parquet.MapredParquetInputFormat",
          "OutputFormat": "org.apache.hadoop.hive.ql.io.parquet.MapredParquetOutputFormat",
          "SerializationLibrary": "org.apache.hadoop.hive.ql.io.parquet.serde.ParquetHiveSerDe",
          "Parameters": {
            "key": "value"
          }
        },
        "BusinessMetadata": {
          "Readme": "## Instructions",
          "CustomAttributes": {
            "key": [
              "John Doe"
            ]
          },
          "Tags": [
            {
              "Key": "tag_key",
              "Value": "tag_value"
            }
          ],
          "Categories": [
            [
              {
                "Id": "CATEGORY.456",
                "Name": "Test category",
                "ParentId": "CATEGORY.123"
              }
            ]
          ],
          "UpstreamTasks": [
            {
              "Id": 123456,
              "Name": "test_task"
            }
          ],
          "Extension": {
            "ProjectId": 234,
            "EnvType": "Dev",
            "ViewCount": 0,
            "ReadCount": 0,
            "FavorCount": 0
          }
        },
        "StatisticsInfos": {
          "key": "128"
        }
      }
    ]
  }
}

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.