GetTableInfo - MaxCompute: Central de Documentação do Alibaba Cloud

Consulta as informações sobre tabelas internas, visualizações, tabelas externas, tabelas clusterizadas ou tabelas transacionais do MaxCompute.

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

odps:GetTableInfo

get

*Project

acs:odps:{#regionId}:{#accountId}:projects/{#ProjectName}

Nenhuma

Sintaxe da solicitação

GET /api/v1/projects/{projectName}/tables/{tableName} HTTP/1.1

Parâmetros de caminho

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
projectName	string	Sim	O nome do projeto ao qual a tabela ou visualização pertence.	odps_project
tableName	string	Sim	O nome da tabela ou visualização que você deseja consultar.	sale_detail

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
schemaName	string	Não	O nome do esquema ao qual a tabela ou visualização pertence.	default
type	string	Não	O tipo da tabela ou visualização que você deseja consultar. Valores válidos: internal: tabela interna external: tabela externa view: visualização materializedView: visualização materializada	internal

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
requestId	string	O ID da solicitação.	0a06dd4516687375802853481ec9fd
data	object	Os dados retornados.
name	string	O nome da tabela ou visualização.	sale_detail
owner	string	As informações da conta do proprietário da tabela ou visualização.	ALIYUN$odps****@aliyunid.com
type	string	O tipo da tabela ou visualização. Valores válidos: internal: tabela interna external: tabela externa view: visualização materializedView: visualização materializada	internal
schema	string	O nome do esquema ao qual a tabela ou a visualização pertence.	default
creationTime	integer	A hora de criação.	2022-01-17T07:07:47Z
viewText	string	A instrução que gera a visualização. Este parâmetro de resposta é retornado quando o tipo é definido como view.	select shop_name, sum(total_price) from sale_detail group by shop_name
displayName	string	O nome de exibição.	odps_project.default.sale_detail
projectName	string	O nome do projeto ao qual a tabela ou visualização pertence.	odps_project
lastDDLTime	integer	A hora em que a instrução de linguagem de definição de dados (DDL) da tabela ou visualização foi modificada pela última vez.	2023-11-21T02:05:56Z
lastModifiedTime	integer	A hora em que os dados da tabela ou visualização foram modificados pela última vez.	2023-11-21T02:05:56Z
lastAccessTime	integer	A hora em que os dados da tabela ou visualização foram acessados pela última vez.	2023-11-21T02:05:56Z
lifecycle	string	O ciclo de vida. Unidade: dias.	-1
isExternalTable	boolean	Indica se a tabela é uma tabela externa. Este parâmetro de resposta é retornado quando o tipo é definido como external.	false
size	integer	O tamanho dos dados da tabela não particionada. Se a tabela for uma tabela particionada, o sistema não calculará o tamanho dos dados da tabela. Nesse caso, o valor deste parâmetro é NULL. A visualização PARTITIONS inclui o tamanho dos dados de cada partição em uma tabela particionada. Unidade: bytes.	5372
comment	string	Os comentários da tabela.	sale_detail
tableLabel	string	O rótulo de nível de sensibilidade da tabela. Para obter mais informações, consulte Controle de acesso baseado em rótulos.	0
createTableDDL	string	A instrução DDL para criar uma tabela.	create table if not exists sale_detail( shop_name STRING, customer_id STRING, total_price DOUBLE) partitioned by (sale_date STRING, region STRING);
nativeColumns	array<object>	As informações das colunas nativas.
	object	As informações das colunas nativas.
name	string	The column name.	shop_name
type	string	The column type.	STRING
label	string	The sensitivity-level label of the column. For more information, see Label-based access control.	0
comment	string	The column comments.	Store name
partitionColumns	array<object>	As informações sobre as colunas de chave de partição. Este parâmetro de resposta é retornado apenas para tabelas particionadas.
	object	As informações sobre a coluna de chave de partição.
name	string	The partition name.	ds='20190130'
type	string	The partition column type.	STRING
label	string	The sensitivity-level label of the column. For more information, see Label-based access control.	0
comment	string	The comments of the partition key column.	Sales date
materializedView	boolean	Indica se a tabela ou visualização é uma visualização materializada.	false
rewriteEnabled	boolean	Indica se a operação de reescrita de consulta pode ser realizada usando a visualização materializada. Este parâmetro de resposta é retornado quando o tipo é definido como materializedView.	false
autoRefreshEnabled	boolean	Indica se a visualização materializada é atualizada automaticamente. Este parâmetro de resposta é retornado quando o tipo é definido como materializedView.	false
isOutdated	boolean	Indica se os dados da visualização materializada são inválidos devido a alterações nos dados da tabela de origem. Este parâmetro de resposta é retornado quando o tipo é definido como materializedView.	false
physicalSize	integer	O tamanho físico da tabela.	2763
fileNum	integer	O número de arquivos da tabela.	200
storageHandler	string	O manipulador de armazenamento da tabela externa. Este parâmetro de resposta é retornado quando o tipo é definido como external.	com.aliyun.odps.CsvStorageHandler
location	string	O caminho da tabela externa. Este parâmetro de resposta é retornado quando o tipo é definido como external.	oss://oss-cn-hangzhou-internal.aliyuncs.com/oss-mc-test/Demo1/
odpsPropertiesRolearn	string	O Alibaba Cloud Resource Name (ARN) da função AliyunODPSDefaultRole no Resource Access Management (RAM). Este parâmetro de resposta é retornado quando o tipo é definido como external.	acs:ram::xxxxx:role/aliyunodpsdefaultrole
tablestoreColumnsMapping	string	As colunas da tabela do Tablestore a serem acessadas, incluindo a coluna de chave primária e a coluna de atributo. Este parâmetro de resposta é retornado quando o tipo é definido como external.	o_orderkey,o_orderdate,o_custkey,o_orderstatus,o_totalprice
tablesotreTableName	string	O nome da tabela do Tablestore a ser acessada. Este parâmetro de resposta é retornado quando o tipo é definido como external.	ots_tpch_orders
odpsSqlTextOptionFlushHeader	boolean	Indica se o cabeçalho da tabela é ignorado. Este parâmetro de resposta é retornado quando o tipo é definido como external.	true
odpsTextOptionHeaderLinesCount	integer	As primeiras N linhas que foram ignoradas no cabeçalho da tabela. Este parâmetro de resposta é retornado quando o tipo é definido como external.	1
clusterInfo	object	O atributo de clusterização. Este parâmetro de resposta é retornado quando a tabela é uma tabela clusterizada.
clusterType	string	The clustering type of the table. MaxCompute supports hash clustering and range clustering.	Hash
clusterCols	array	The cluster keys.
	string	The cluster keys.	col_1
sortCols	array<object>	The condition by which the results are sorted.
	object	The condition by which the results are sorted.
name	string	The name of the sorting field.	col_2
order	string	The sorting order.	DESC
bucketNum	integer	Optional. The number of buckets in the clustered table. The value 0 indicates that the number of buckets dynamically changes when a job is running.	1024

Exemplos

Resposta de sucesso

JSON formato

{
  "requestId": "0a06dd4516687375802853481ec9fd",
  "data": {
    "name": "sale_detail",
    "owner": "ALIYUN$odps****@aliyunid.com",
    "type": "internal",
    "schema": "default",
    "creationTime": 0,
    "viewText": "select shop_name, sum(total_price) from sale_detail group by shop_name",
    "displayName": "odps_project.default.sale_detail",
    "projectName": "odps_project",
    "lastDDLTime": 0,
    "lastModifiedTime": 0,
    "lastAccessTime": 0,
    "lifecycle": "-1",
    "isExternalTable": false,
    "size": 5372,
    "comment": "sale_detail",
    "tableLabel": "0",
    "createTableDDL": "create table if not exists sale_detail( shop_name STRING, customer_id STRING, total_price DOUBLE) partitioned by (sale_date STRING, region STRING);",
    "nativeColumns": [
      {
        "name": "shop_name",
        "type": "STRING",
        "label": "0",
        "comment": "Store name"
      }
    ],
    "partitionColumns": [
      {
        "name": "ds='20190130'",
        "type": "STRING",
        "label": "0",
        "comment": "Sales date"
      }
    ],
    "materializedView": false,
    "rewriteEnabled": false,
    "autoRefreshEnabled": false,
    "isOutdated": false,
    "physicalSize": 2763,
    "fileNum": 200,
    "storageHandler": "com.aliyun.odps.CsvStorageHandler",
    "location": "oss://oss-cn-hangzhou-internal.aliyuncs.com/oss-mc-test/Demo1/",
    "odpsPropertiesRolearn": "acs:ram::xxxxx:role/aliyunodpsdefaultrole",
    "tablestoreColumnsMapping": "o_orderkey,o_orderdate,o_custkey,o_orderstatus,o_totalprice",
    "tablesotreTableName": "ots_tpch_orders",
    "odpsSqlTextOptionFlushHeader": true,
    "odpsTextOptionHeaderLinesCount": 1,
    "clusterInfo": {
      "clusterType": "Hash",
      "clusterCols": [
        "col_1"
      ],
      "sortCols": [
        {
          "name": "col_2",
          "order": "DESC"
        }
      ],
      "bucketNum": 1024
    }
  }
}

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.