GetMetaTableColumn - DataWorks - Centro de documentación de Alibaba Cloud

Consulta la información de los campos de una metatabla.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

dataworks:*

get

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
TableGuid	string	No	El GUID de la metatabla. Puede llamar a la operación GetMetaDBTableList para consultar el GUID.	odps.engine_name.table_name
PageNum	integer	No	El número de página.	1
PageSize	integer	No	El número de entradas por página. Valor predeterminado: 10. Valor máximo: 100.	10
ClusterId	string	No	El ID del clúster de E-MapReduce (EMR). Puede iniciar sesión en la consola de EMR para obtener el ID.	C-010A704DA760****
DatabaseName	string	No	El nombre de la metadatabase del clúster EMR. Puede llamar a la operación ListMetaDB para consultar el nombre.	abc
TableName	string	No	El nombre de la metatabla en el clúster EMR. Puede llamar a la operación GetMetaDBTableList para consultar el nombre.	abc
DataSourceType	string	No	El tipo de origen de datos. Establezca el valor en emr.	emr

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Los parámetros de respuesta.
HttpStatusCode	integer	El código de estado HTTP.	200
ErrorMessage	string	El mensaje de error.	The connection does not exist.
RequestId	string	El ID de la solicitud. Puede localizar los registros y solucionar problemas en función del ID.	0bc1ec92159376
Success	boolean	Indica si la solicitud se realizó correctamente.	true
ErrorCode	string	El código de error.	Invalid.Tenant.ConnectionNotExists
Data	object	Los datos empresariales.
PageNum	integer	El número de página.	1
PageSize	integer	El número de entradas por página. Valor predeterminado: 10. Valor máximo: 100.	10
TotalCount	integer	El número total de campos.	100
ColumnList	array<object>	La información de los campos.
	object	La estructura devuelta.
ColumnGuid	string	El GUID del campo.	odps.engine_name.table_name.name
ColumnName	string	El nombre del campo.	name
IsPartitionColumn	boolean	Indica si el campo es un campo de partición. Valores válidos: true false	false
Comment	string	Los comentarios del campo.	comment
ColumnType	string	El tipo de datos del campo.	string
IsPrimaryKey	boolean	Indica si el campo es una clave principal. Valores válidos: true false	false
Position	integer	El número de secuencia del campo.	1
Caption	string	La descripción del campo.	data column
IsForeignKey	boolean	Indica si el campo es una clave externa. Valores válidos: true false	true
RelationCount	integer	La popularidad del campo.	2

Ejemplos

Respuesta exitosa

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 error

Código de estado HTTP	Código de error	Mensaje de error
400	InvalidParameter.Meta.CommonError	The specified parameter is invalid.
400	InvalidParameter.Meta.GuidFormat	The GUID format is invalid.
400	InvalidParameter.Meta.Illegal	The app guid parameter is invalid.
400	InvalidParameter.Meta.IllegalDate	The date format is invalid.
400	InvalidParameter.Meta.IllegalPageError	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.
500	InternalError.System	An internal system error occurred. Try again later.
500	InternalError.Meta.TenantTimeOut	Failed to connect to the interface network.
500	InternalError.Meta.Unknown	An unknown error occurred while processing your request.
403	Forbidden.Meta.NoTenant	The user is not the owner of any tenants.
403	Forbidden.Access	Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.
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 error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.