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

Descrição da operação

Você deve adquirir o DataWorks Basic Edition ou uma edição superior para usar esta API.

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

get

*All resources.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Id	string	Sim	O ID. Você pode consultar a resposta da operação ListTables e Conceitos de entidades de metadados. O formato é `${EntityType}:${Instance ID or URL-encoded JDBC URL}:${Catalog ID}:${Database name}:${Schema name}:${Table name}`. Use uma string vazia como espaço reservado para níveis inexistentes. Nota Para MaxCompute e DLF, use uma string vazia como espaço reservado para o ID da instância. Nota Para StarRocks, o identificador do catálogo é o nome do catálogo. Para DLF, o identificador do catálogo é 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. Nota Para MaxCompute, o nome do banco de dados é o nome do projeto MaxCompute. Para projetos com o modelo de três níveis ativado, você deve fornecer o nome do schema. Para projetos com o modelo de três níveis desativado, use uma string vazia como espaço reservado para o nome do schema. A seguir estão os formatos de ID para vários tipos comuns: `maxcompute-table:::project_name:[schema_name]:table_name` `dlf-table::catalog_id:database_name::table_name` `hms-table:instance_id::database_name::table_name` `holo-table:instance_id::database_name:schema_name:table_name` `mysql-table:(instance_id\|encoded_jdbc_url)::database_name::table_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 no modo de 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. Para MaxCompute, isso é obrigatório apenas quando o modelo de três níveis está ativado para o projeto. Se estiver desativado, use uma string vazia como espaço reservado. `table_name`: o nome da tabela. Processo recomendado para obter este parâmetro: Primeiro, chame ListCrawlers para obter o MetaEntityId do rastreador de metadados. Para tipos que incluem o nível de catálogo, como DLF e StarRocks, chame ListCatalogs para obter o ID do catálogo. Em seguida, chame ListDatabases para obter o ID do banco de dados. Se necessário, chame ListSchemas para obter o ID do schema. Por fim, chame ListTables para obter o ID da tabela de destino e use o ID da tabela retornado como o parâmetro Id para esta API.	maxcompute-table:::project_name:[schema_name]:table_name
IncludeBusinessMetadata	boolean	Não	Especifica se os metadados de negócios devem ser incluídos. Valor padrão: false.	true
IncludeExtendedProperties	boolean	Não	Especifica se as propriedades estendidas devem ser retornadas. Se você definir este parâmetro como `true`, as propriedades estendidas serão retornadas. Se você definir este parâmetro como `false`, as propriedades estendidas não serão retornadas.

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A resposta.
RequestId	string	O ID da solicitação.	7B3435F4-2D91-XXX
Success	boolean	Indica se a solicitação foi bem-sucedida.	true
Table	Table	Os detalhes da tabela.

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "7B3435F4-2D91-XXX",
  "Success": true,
  "Table": {
    "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.