ListDataCenterTable-阿里云帮助中心

Retrieves a list of user-uploaded tables from the data center, for file types only.

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

dms:ListDataCenterTable

list

*All Resource

*

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
DmsUnit	string	No	The current DMS unit.	cn-hangzhou
InstanceName	string	No	The name of the instance. If `ImportType` is `FILE`, this parameter represents the file ID of the data center.	f-ean8u5881qk4*********xh5y
DatabaseName	string	No	The name of the database. If `ImportType` is `FILE`, this parameter represents the file name.	diamonds.csv
TableName	string	No	The name of the table.	diamonds
SearchKey	string	No	The keyword for a fuzzy search of database tables.	testdb
ImportType	string	No	The import type. FILE	FILE
PageNumber	integer	No	The page number, starting from 1.	1
PageSize	integer	No	The number of records to return per page. Default: 20.	20
CallFrom	string	No	For frontend use only.	仅前端使用

Response elements

Element	Type	Description	Example
	object	The response schema.
RequestId	string	The ID of the request.	67E910F2-4B62-5B0C-ACA3-7547695C****
Success	boolean	Indicates whether the request was successful. Valid values: true: The request succeeded. false: The request failed.	true
ErrorCode	string	The code that indicates the result of the request. If the request fails, an error code is returned.	success
ErrorMessage	string	The error message returned if the request fails.	Specified parameter Tid is not valid.
Data	object	The data returned in the response.
Content	array<object>	A list of the data tables.
	object	The details of a data table.
TableId	string	The ID of the data table.	xa8wib4ga3a2*********fjbx
ImportType	string	The import type. Valid value: FILE: The data is imported from a file.	FILE
InstanceName	string	The instance name. If `ImportType` is `FILE`, this parameter returns the file ID.	f-ean8u5881qk4*********xh5y
DatabaseName	string	The database name. If `ImportType` is `FILE`, this parameter returns the file name.	diamonds.csv
TableName	string	The table name.	diamonds
TableDesc	string	The description of the data table.	这是一份钻石数据。
DescUpdateTime	string	The time when the data table description was last updated.	2025-12-11T14:04:32.000+00:00
GmtCreated	string	The time when the data table was created.	2025-12-11T14:04:32.000+00:00
DmsInstanceId	integer	The ID of the DMS instance that hosts the database. This parameter is not returned if `ImportType` is `FILE`.	2310246
DmsDbId	integer	The ID of the DMS database. This parameter is not returned if `ImportType` is `FILE`.	69950353
TotalElements	integer	The total number of entries.	20
TotalPages	integer	The total number of pages.	1
PageNumber	integer	The page number.	1
PageSize	integer	The page size.	20

Examples

Success response

JSON format

{
  "RequestId": "67E910F2-4B62-5B0C-ACA3-7547695C****",
  "Success": true,
  "ErrorCode": "success",
  "ErrorMessage": "Specified parameter Tid is not valid.",
  "Data": {
    "Content": [
      {
        "TableId": "xa8wib4ga3a2*********fjbx",
        "ImportType": "FILE",
        "InstanceName": "f-ean8u5881qk4*********xh5y",
        "DatabaseName": "diamonds.csv",
        "TableName": "diamonds\n",
        "TableDesc": "这是一份钻石数据。",
        "DescUpdateTime": "2025-12-11T14:04:32.000+00:00",
        "GmtCreated": "2025-12-11T14:04:32.000+00:00",
        "DmsInstanceId": 2310246,
        "DmsDbId": 69950353
      }
    ],
    "TotalElements": 20,
    "TotalPages": 1,
    "PageNumber": 1,
    "PageSize": 20
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.