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

Consulta as informações de campo de uma metatabela.

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

Nenhuma autorização necessária para esta operação. Se você encontrar problemas com esta operação, entre em contato com o suporte técnico.

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
TableGuid	string	Não	O GUID da metatabela. Você pode chamar a operação GetMetaDBTableList para consultar o GUID.	odps.engine_name.table_name
PageNum	integer	Não	O número da página.	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 E-MapReduce (EMR). Você pode fazer logon no console do EMR para obter o ID.	C-010A704DA760****
DatabaseName	string	Não	O nome do metabanco de dados do cluster EMR. Você pode chamar a operação ListMetaDB para consultar o nome.	abc
TableName	string	Não	O nome da metatabela no cluster EMR. Você pode chamar a operação GetMetaDBTableList para consultar o nome.	abc
DataSourceType	string	Não	O tipo da fonte de dados. Defina o valor como emr.	emr

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
HttpStatusCode	integer	O código de status HTTP.	200
ErrorMessage	string	A mensagem de erro.	The connection does not exist.
RequestId	string	O ID da solicitação. Você pode localizar logs e solucionar problemas com base no ID.	0bc1ec92159376
Success	boolean	Indica se a solicitação foi bem-sucedida.	true
ErrorCode	string	O código de erro.	Invalid.Tenant.ConnectionNotExists
Data	object	Os dados de negócio.
PageNum	integer	O número da página.	1
PageSize	integer	O número de entradas por página. Valor padrão: 10. Valor máximo: 100.	10
TotalCount	integer	O número total de campos.	100
ColumnList	array<object>	As informações sobre os campos.
	object
ColumnGuid	string	The GUID of the field.	odps.engine_name.table_name.name
ColumnName	string	The name of the field.	name
IsPartitionColumn	boolean	Indicates whether the field is a partition field. Valid values: true false	false
Comment	string	The remarks of the field.	comment
ColumnType	string	The data type of the field.	string
IsPrimaryKey	boolean	Indicates whether the field is a primary key. Valid values: true false	false
Position	integer	The sequence number of the field.	1
Caption	string	The description of the field.	data column
IsForeignKey	boolean	Indicates whether the field is a foreign key. Valid values: true false	true
RelationCount	integer	The number of times the field is read.	2

Exemplos

Resposta de sucesso

JSON formato

{
  "HttpStatusCode": 200,
  "ErrorMessage": "The connection does not exist.",
  "RequestId": "0bc1ec92159376",
  "Success": true,
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists",
  "Data": {
    "PageNum": 1,
    "PageSize": 10,
    "TotalCount": 100,
    "ColumnList": [
      {
        "ColumnGuid": "odps.engine_name.table_name.name",
        "ColumnName": "name",
        "IsPartitionColumn": false,
        "Comment": "comment ",
        "ColumnType": "string",
        "IsPrimaryKey": false,
        "Position": 1,
        "Caption": "data column",
        "IsForeignKey": true,
        "RelationCount": 2
      }
    ]
  }
}

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.	The request parameter is invalid.
400	InvalidParameter.Meta.GuidFormat	The GUID format is invalid.	The GUID format is invalid.
400	InvalidParameter.Meta.Illegal	The app guid parameter is invalid.	The app guid parameter is invalid.
400	InvalidParameter.Meta.IllegalDate	The date format is invalid.	The date format is invalid.
400	InvalidParameter.Meta.IllegalPageError	The parameter for paging is invalid.	The parameter for paging is invalid.
400	InvalidParameter.Meta.NotExist	The object does not exist.
400	InternalError.UserId.Missing	An internal system error occurred. Try again later.
400	InternalError.Meta.NoCalcEngine	An error occurred while retrieving the compute engine based on the MaxCompute project.	Incorrect project entered by user
500	InternalError.System	An internal system error occurred. Try again later.
500	InternalError.Meta.TenantTimeOut	Failed to connect to the interface network.	Failed to connect to the interface network.
500	InternalError.Meta.Unknown	An unknown error occurred while processing your request.	An unknown error occurred while processing your request.
403	Forbidden.Meta.NoTenant	The user is not the owner of any tenants.	The user is not the owner of any tenants.
403	Forbidden.Access	Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.	No permission, please authorize
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.