GetTableMeta-阿里云帮助中心

Returns the details of a table.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

pairec:GetTableMeta

get

*All Resource

*

None

Request syntax

GET /api/v1/tablemetas/{TableMetaId} HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
TableMetaId	string	Yes	The table ID.	2

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the instance. Call the ListInstances API to obtain it.	实例ID pairec-cn-test1

Response elements

Element	Type	Description	Example
	object	The data returned.
RequestId	string	The request ID.	28C5E01-ABF6-5AA8-B9FC-B3BA05DECC77
Name	string	The table name.	test_table
Description	string	The table description.	this is a test table
ResourceId	string	The resource ID.	reso-wkgo***
ResourceType	string		Maxcompute
ResourceUri	string		test
TableName	string	The name of the table in the database.	table_mysql
Type	string	The table type. Valid values: `MaxCompute` `Hologres`	MaxCompute
Module	string	The table module. Valid values: `ABTest`: An A/B testing data table. `ExperimentTool`: An experiment tool table. `DataDiagnosis`: A table for data diagnosis.	ABTest
CanDelete	boolean	Indicates whether the table can be deleted. The value is `false` if other resources reference the table.	false
GmtCreateTime	string	The creation time.	2021-12-15:24:33
GmtModifiedTime	string	The modification time.	2021-12-15:24:33
Fields	array<object>	The fields in the table.
	object	Information about a field.
Name	string	The field name.	gender
Meaning	string	The field meaning.	the gender of people
Type	string	The field type.	BIGINT
IsDimensionField	boolean	Whether the field is a dimension field.	false
Url	string	The URL of the table in Data Map. This parameter is returned only for MaxCompute tables.	https://dmc-xxx.com/dm/table/xxx
TableMetaId	string	The table ID.	3
GmtImportedTime	string	The import time.	2021-12-15T23:24:33.132+08:00
Config	string	Additional configurations for the table, provided as a JSON string.	{"table_type":"item"}

Examples

Success response

JSON format

{
  "RequestId": "28C5E01-ABF6-5AA8-B9FC-B3BA05DECC77",
  "Name": "test_table",
  "Description": "this is a test table",
  "ResourceId": "reso-wkgo***",
  "ResourceType": "Maxcompute",
  "ResourceUri": "test",
  "TableName": "table_mysql",
  "Type": "MaxCompute",
  "Module": "ABTest",
  "CanDelete": false,
  "GmtCreateTime": "2021-12-15:24:33",
  "GmtModifiedTime": "2021-12-15:24:33",
  "Fields": [
    {
      "Name": "gender",
      "Meaning": "the gender of people",
      "Type": "BIGINT",
      "IsDimensionField": false
    }
  ],
  "Url": "https://dmc-xxx.com/dm/table/xxx\n",
  "TableMetaId": "3",
  "GmtImportedTime": "2021-12-15T23:24:33.132+08:00",
  "Config": "{\"table_type\":\"item\"}"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.