Obtém as informações completas sobre uma tabela, incluindo informações de colunas.
Esta API foi descontinuada sem substituto. Embora o acesso temporário seja mantido, nenhuma atualização ou correção de bugs será fornecida. Para garantir a continuidade da funcionalidade, planeje sua migração e entre em contato com seu gerente de conta para obter suporte.
Descrição da operação
Somente tabelas do tipo de mecanismo EMR são suportadas.
Experimente agora
Testar
Autorização RAM
Parâmetros da solicitação
|
Parâmetro |
Tipo |
Obrigatório |
Descrição |
Exemplo |
| TableGuid |
string |
Não |
O identificador globalmente exclusivo (GUID) da tabela. Você pode chamar GetMetaDBTableList para obter o GUID da tabela. |
odps.engine_name.table_name |
| PageNum |
integer |
Não |
O número da página para paginação. |
1 |
| PageSize |
integer |
Não |
O número de entradas por página. Valor padrão: 10. Valor máximo: 100. |
10 |
| ClusterId |
string |
Não |
O ID do cluster EMR. Este parâmetro é obrigatório apenas quando o tipo de fonte de dados é EMR. Você pode fazer login no console do EMR para obter o ID do cluster. |
C-010A704DA760**** |
| DatabaseName |
string |
Não |
O nome do banco de dados. Este parâmetro é obrigatório apenas quando o tipo de fonte de dados é EMR. Você pode chamar a operação ListMetaDB para obter o nome do banco de dados. |
abc |
| TableName |
string |
Não |
O nome da tabela EMR. Este parâmetro é obrigatório apenas quando o tipo de fonte de dados é EMR. Você pode chamar a operação GetMetaDBTableList para obter o nome da tabela. |
abc |
| DataSourceType |
string |
Não |
O tipo de fonte de dados. Atualmente, apenas o EMR é suportado. |
emr |
Elementos de resposta
|
Elemento |
Tipo |
Descrição |
Exemplo |
|
object |
A estrutura da resposta. |
||
| HttpStatusCode |
integer |
O código de status HTTP. |
200 |
| ErrorMessage |
string |
A mensagem de erro. |
The specified parameters are invalid. |
| RequestId |
string |
O ID da solicitação. Você pode usar este ID para localizar logs e solucionar problemas. |
0bc1411515937**** |
| Success |
boolean |
Indica se a chamada foi bem-sucedida. |
true |
| ErrorCode |
string |
O código de erro. |
1031203110005 |
| Data |
object |
Os dados de negócios. |
|
| TableName |
string |
O nome da tabela. |
table_name |
| Comment |
string |
O comentário da tabela. |
comment |
| LifeCycle |
integer |
O ciclo de vida da tabela, em dias. |
5 |
| CreateTime |
integer |
A hora em que a tabela foi criada. O valor é um timestamp. Você pode converter o timestamp em uma data com base no fuso horário que você usa. |
1589870293000 |
| ProjectName |
string |
O nome do workspace ao qual a tabela pertence. |
test |
| ProjectId |
integer |
O ID do workspace ao qual a tabela pertence. |
22 |
| OwnerId |
string |
O ID do proprietário da tabela. |
123 |
| EnvType |
integer |
O tipo de ambiente. Valores válidos:
|
1 |
| LastAccessTime |
integer |
A hora em que a tabela foi acessada pela última vez. O valor é um timestamp. Você pode converter o timestamp em uma data com base no fuso horário que você usa. |
1589870294000 |
| DataSize |
integer |
O espaço de armazenamento ocupado pela tabela, em bytes. |
10 |
| LastModifyTime |
integer |
A hora em que a tabela foi atualizada pela última vez. O valor é um timestamp. Você pode converter o timestamp em uma data com base no fuso horário que você usa. |
1589870294000 |
| DatabaseName |
string |
O nome do banco de dados. |
abc |
| IsVisible |
integer |
A visibilidade da tabela. Valores válidos:
|
1 |
| TotalColumnCount |
integer |
O número total de colunas. |
22 |
| TableGuid |
string |
O GUID da tabela. |
odps.engine_name.table_name |
| PartitionKeys |
string |
As chaves de partição. |
abc |
| LastDdlTime |
integer |
A hora em que o esquema da tabela foi alterado pela última vez. O valor é um timestamp. Você pode converter o timestamp em uma data com base no fuso horário que você usa. |
1589870294000 |
| Location |
string |
O caminho de armazenamento da tabela Hive. |
hdfs://localhost:777/user/hadoop/test.txt |
| ClusterId |
string |
O ID do cluster EMR. |
C-010A704DA760**** |
| TenantId |
integer |
O ID do tenant. |
12345 |
| Schema |
string |
As informações de esquema da tabela. |
default |
| ColumnList |
array<object> |
A lista de colunas. |
|
|
object |
A estrutura da resposta. |
||
| ColumnName |
string |
O nome da coluna. |
1 |
| ColumnGuid |
string |
O GUID da coluna. |
odps.engine_name.table_name.1 |
| IsPartitionColumn |
boolean |
Indica se a coluna é uma coluna de partição. Valores válidos:
|
true |
| Comment |
string |
O comentário da coluna. |
comment |
| ColumnType |
string |
O tipo da coluna. |
string |
| IsPrimaryKey |
boolean |
Indica se a coluna é uma chave primária. Valores válidos:
|
false |
| Position |
integer |
A posição ordinal da coluna. |
1 |
| Caption |
string |
A descrição da coluna. |
data comment |
| IsForeignKey |
boolean |
Indica se a coluna é uma chave estrangeira. Valores válidos:
|
true |
Exemplos
Resposta de sucesso
JSON formato
{
"HttpStatusCode": 200,
"ErrorMessage": "Os parâmetros especificados são inválidos",
"RequestId": "0bc1411515937****",
"Success": true,
"ErrorCode": "1031203110005",
"Data": {
"TableName": "table_name",
"Comment": "comentário",
"LifeCycle": 5,
"CreateTime": 1589870293000,
"ProjectName": "teste",
"ProjectId": 22,
"OwnerId": "123",
"EnvType": 1,
"LastAccessTime": 1589870294000,
"DataSize": 10,
"LastModifyTime": 1589870294000,
"DatabaseName": "abc",
"IsVisible": 1,
"TotalColumnCount": 22,
"TableGuid": "odps.engine_name.table_name",
"PartitionKeys": "abc",
"LastDdlTime": 1589870294000,
"Location": "hdfs://localhost:777/user/hadoop/test.txt",
"ClusterId": "C-010A704DA760****",
"TenantId": 12345,
"Schema": "default",
"ColumnList": [
{
"ColumnName": "1",
"ColumnGuid": "odps.engine_name.table_name.1",
"IsPartitionColumn": true,
"Comment": "comentário",
"ColumnType": "string",
"IsPrimaryKey": false,
"Position": 1,
"Caption": "comentário de dados",
"IsForeignKey": true
}
]
}
}
Códigos de erro
|
Código de status HTTP |
Código de erro |
Mensagem de erro |
Descrição |
|---|---|---|---|
| 400 | InvalidParameter.Meta.CommonError | The specified parameter is invalid. | O parâmetro da solicitação é inválido. |
| 400 | InvalidParameter.Meta.Illegal | The app guid parameter is invalid. | O parâmetro App é inválido. |
| 400 | InvalidParameter.Meta.IllegalDate | The date format is invalid. | O formato da data é inválido. |
| 400 | InvalidParameter.Meta.IllegalPageError | The parameter for paging is invalid. | As informações de paginação são inválidas. |
| 400 | InvalidParameter.Meta.NotExist | The object does not exist. | |
| 400 | InternalError.Meta.NoCalcEngine | An error occurred while retrieving the compute engine based on the MaxCompute project. | O projeto especificado está incorreto. |
| 500 | InternalError.System | An internal system error occurred. Try again later. | |
| 500 | InternalError.UserId.Missing | An internal system error occurred. Try again later. | |
| 500 | InternalError.Meta.TenantTimeOut | Failed to connect to the interface network. | A rede da API está inacessível. |
| 500 | InternalError.Meta.Unknown | An unknown error occurred while processing your request. | Ocorreu um erro desconhecido. |
| 403 | Forbidden.Meta.NoTenant | The user is not the owner of any tenants. | O usuário atual não é proprietário de nenhum inquilino. |
| 403 | Forbidden.Access | Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition. | Você não tem as permissões necessárias. Conceda as permissões primeiro. |
| 429 | Throttling.Api | The request for this resource has exceeded your available limit. | |
| 429 | Throttling.Api.Risk | The request for this resource has exceeded your daily available limit. | |
| 429 | Throttling.System | The DataWorks system is busy. Try again later. | |
| 429 | Throttling.User | Your request is too frequent. Try again later. |
Consulte Códigos de Erro para uma lista completa.
Notas de versão
Consulte Notas de Versão para uma lista completa.