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

Consulta la información básica de una metatabla.

Descripción de la operación

前置条件：调用本接口前，请先开通 DataWorks 企业版或旗舰版；未开通时服务会返回 403 Forbidden.Access。

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 tabla de MaxCompute. Especifique el GUID en el formato odps.projectName.tableName. Nota Este parámetro es opcional para las tablas de E-MapReduce (EMR).	odps.engine_name.table_name
ClusterId	string	No	El ID del clúster de EMR. Este parámetro es obligatorio solo si establece el parámetro DataSourceType en emr. Puede iniciar sesión en la consola de EMR para consultar el ID.	abc
DatabaseName	string	No	El nombre de la metadatabase. Este parámetro es obligatorio solo si establece el parámetro DataSourceType en 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 de EMR. Este parámetro es obligatorio solo si establece el parámetro DataSourceType en emr. Puede llamar a la operación GetMetaDBTableList para consultar el nombre.	abc
DataSourceType	string	No	El tipo de origen de datos. Valores válidos: odps y emr.	emr
Extension	boolean	No	Especifica si se deben incluir campos extendidos en los resultados de la consulta. Los campos extendidos incluyen ReadCount, FavoriteCount y ViewCount. Este parámetro solo surte efecto si establece el parámetro DataSourceType en odps.	false

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	La 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.	0bc1411515937
Success	boolean	Indica si la solicitud se realizó correctamente.	true
ErrorCode	string	El código de error.	Invalid.Tenant.ConnectionNotExists
Data	object	Los datos de negocio.
TableName	string	El nombre de la metatabla.	table_name
FavoriteCount	integer	El número de veces que la metatabla se agregó a una lista de favoritos. Este parámetro se devuelve solo si establece el parámetro Extension en true y solo surte efecto si establece el parámetro DataSourceType en odps.	6
Comment	string	El comentario de la metatabla.	test table
ColumnCount	integer	El número de campos.	3
CreateTime	integer	La hora en que se creó la metatabla.	1589870294000
ProjectId	integer	El ID del espacio de trabajo.	232
OwnerId	string	El ID del propietario de la metatabla.	123
EnvType	integer	El tipo de entorno. Valores válidos: 0: entorno de desarrollo 1: entorno de producción	1
DatabaseName	string	El nombre de la metadatabase.	abc
IsVisible	integer	El ámbito en el que la metatabla es visible. Valores válidos: 0: La metatabla es visible para los miembros del espacio de trabajo. 1: La metatabla es visible para los usuarios dentro del inquilino. 2: La metatabla es visible para todos los inquilinos. 3: La metatabla es visible solo para el propietario de la metatabla.	1
TableGuid	string	El GUID de la metatabla.	odps.engine_name.table_name
ReadCount	integer	El número de veces que se leyó la metatabla. Este parámetro se devuelve solo si establece el parámetro Extension en true y solo surte efecto si establece el parámetro DataSourceType en odps.	3
ClusterId	string	El ID del clúster de EMR.	abc
IsPartitionTable	boolean	Indica si la metatabla es una tabla particionada. Valores válidos: true false	true
IsView	boolean	Indica si la metatabla es una vista. Valores válidos: true false	false
LifeCycle	integer	El ciclo de vida de la tabla. Unidad: día. Nota Si no se establece el ciclo de vida para una tabla de MaxCompute, el valor devuelto es 0, lo que indica que la tabla es válida permanentemente.	5
ProjectName	string	El nombre del espacio de trabajo.	test
ViewCount	integer	El número de veces que se visualizó la metatabla. Este parámetro se devuelve solo si establece el parámetro Extension en true y solo surte efecto si establece el parámetro DataSourceType en odps.	2
LastAccessTime	integer	La hora en que se accedió por última vez a la metatabla.	1589870294000
DataSize	integer	El tamaño del espacio de almacenamiento que ocupa la metatabla. Unidad: bytes.	10
LastModifyTime	integer	La hora en que se actualizó por última vez la metatabla.	1589870294000
LastDdlTime	integer	La hora en que se modificó por última vez el esquema de la metatabla.	1589870294000
PartitionKeys	string	La clave de partición de la metatabla de Hive.	ab
Location	string	La ruta de almacenamiento de la metadatabase de Hive.	hdfs://
Caption	string	El nombre para mostrar de la metatabla.	Chinese name
TenantId	integer	El ID del inquilino.	12345
Schema	string	La información de esquema de la metatabla. Este parámetro se devuelve si el modelo de tres capas de MaxCompute está habilitado.	default

Ejemplos

Respuesta exitosa

JSON Formato

{
  "HttpStatusCode": 200,
  "ErrorMessage": "The connection does not exist",
  "RequestId": "0bc1411515937",
  "Success": true,
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists",
  "Data": {
    "TableName": "table_name",
    "FavoriteCount": 6,
    "Comment": "test table",
    "ColumnCount": 3,
    "CreateTime": 1589870294000,
    "ProjectId": 232,
    "OwnerId": "123",
    "EnvType": 1,
    "DatabaseName": "abc",
    "IsVisible": 1,
    "TableGuid": "odps.engine_name.table_name",
    "ReadCount": 3,
    "ClusterId": "abc",
    "IsPartitionTable": true,
    "IsView": false,
    "LifeCycle": 5,
    "ProjectName": "test",
    "ViewCount": 2,
    "LastAccessTime": 1589870294000,
    "DataSize": 10,
    "LastModifyTime": 1589870294000,
    "LastDdlTime": 1589870294000,
    "PartitionKeys": "ab",
    "Location": "hdfs://",
    "Caption": "中文名",
    "TenantId": 12345,
    "Schema": "default"
  }
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error
400	Invalid.Meta.TableNotExist	The table does not exist.
400	InvalidParameter.Meta.CommonError	The specified parameter 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.