ListTableMetas-阿里云帮助中心

Retrieves a list of data tables.

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:ListTableMetas

list

*All Resource

*

None

Request syntax

GET /api/v1/tablemetas HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
Type	string	No	The type of the data table. Valid values: MaxCompute Hologres	MaxCompute
Name	string	No	The table name to filter on.	test1
Module	string	Yes	The module of the data table. Valid values: ABTest: A/B testing data tables ExperimentTool: experiment tool tables DataDiagnosis: data diagnosis tables	ABTest
PageNumber	integer	No	The page number.	1
PageSize	integer	No	The number of entries to return on each page.	10
InstanceId	string	Yes	The instance ID. You can get this ID by calling the ListInstances operation.	pairec-cn-test1

Response elements

Element	Type	Description	Example
	object	The data returned.
RequestId	string	The request ID.	728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77
TotalCount	integer	The total number of data tables.	20
TableMetas	array<object>	The list of data tables.
	array<object>	The metadata of a data table.
TableMetaId	string	The ID of the data table.	3
Name	string	The name of the data table.	test_table
Description	string	The description of the data table.	this is a test table
ResourceId	string	The resource ID.	reso-2s416t***
TableName	string	The name of the table in the database.	table_mysql
Type	string	The type of the data table. Valid values: MaxCompute Hologres	MaxCompute
Module	string	The module of the data table. Valid values: ABTest: A/B testing ExperimentTool: Experiment tool DataDiagnosis: data diagnosis	ABTest
CanDelete	boolean	Indicates whether the data table can be deleted. A value of `false` indicates that the table is in use by other resources.	true
GmtCreateTime	string	The time when the data table was created.	2021-12-12 12:24:33
GmtModifiedTime	string	The time when the data table was last modified.	2021-12-12 12:24:33
GmtImportedTime	string	The time when the fields were imported.	imprecation
Fields	array<object>	The fields in the data table.
	object	The details of a field.
Name	string	The name of the field.	gender
Meaning	string	The business meaning of the field.	the gender of people
Type	string	The data type of the field.	BIGINT
IsDimensionField	boolean	Indicates 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 data tables.	https://dmc-xxx.com/dm/table/xxx
Config	string	The additional configurations for the data table.	{"table_type":"item"}
ResourceType	string		Maxcompute
ResourceUri	string		test

Examples

Success response

JSON format

{
  "RequestId": "728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77",
  "TotalCount": 20,
  "TableMetas": [
    {
      "TableMetaId": "3",
      "Name": "test_table",
      "Description": "this is a test table",
      "ResourceId": "reso-2s416t***",
      "TableName": "table_mysql",
      "Type": "MaxCompute",
      "Module": "ABTest",
      "CanDelete": true,
      "GmtCreateTime": "2021-12-12 12:24:33",
      "GmtModifiedTime": "2021-12-12 12:24:33",
      "GmtImportedTime": "imprecation",
      "Fields": [
        {
          "Name": "gender",
          "Meaning": "the gender of people",
          "Type": "BIGINT",
          "IsDimensionField": false
        }
      ],
      "Url": "https://dmc-xxx.com/dm/table/xxx",
      "Config": "{\"table_type\":\"item\"}",
      "ResourceType": "Maxcompute",
      "ResourceUri": "test"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.