DocsICP FilingConsole
Documentation

ListDataCenterDatabase

Updated at:
Copy as MD
Product
My Favorites

Lists user-uploaded files in a data center, excluding databases.

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

list

*All Resource

*

 None None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example
DmsUnit

string

No

The DMS unit.

cn-hangzhou

ImportType

string

No

The import type.

  • FILE

FILE
SearchKey

string

No

The keyword for a fuzzy search for databases.

testdb
CallFrom

string

No

This parameter is for internal use.

仅前端使用
Language

string

No

This parameter is for internal use.

仅前端使用

Response elements

Element

Type

Description

Example

object

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 was successful.

  • false: The request failed.

true
ErrorCode

string

The error code returned if the request fails.

success
ErrorMessage

string

The error message returned if the request fails.

Specified parameter Tid is not valid.
Data

array<object>

The list of databases.

object

The details of a database.

DbId

string

The ID of the database.

6kv159u9vtpvl**********b8
DbType

string
  • If ImportType is FILE:

    • The file format, such as csv, xlsx, or xls.

csv
ImportType

string

The import type. Valid values:

  • FILE

  • RDS

  • ADB

  • PolarDB

  • Hologres

  • DMS

FILE
InstanceName

string

The name of the instance.

  • If ImportType is FILE, this parameter specifies the file ID in the data center.

f-ean8u5881qk4*********xh5y
DatabaseName

string

The name of the database.

  • If ImportType is FILE, this is the file name.

diamonds.csv
DatabaseDesc

string

The description of the database.

这是一份钻石数据。
DescUpdateTime

string

The time the database description was last updated.

2025-12-11T14:04:32.000+00:00
GmtCreated

string

The time the entry was created.

2025-12-11T14:04:32.000+00:00
Size

integer

The size of the file, in bytes.

999
IsInternal

string

Indicates whether the dataset is built-in. Valid values:

  • Y: The dataset is built-in.

  • N: The dataset is not built-in.

N
DmsInstanceId

integer

The ID of the DMS instance that manages the database.

  • This parameter is not returned if ImportType is FILE.

2740966
DmsDbId

integer

The ID of the database in DMS.

  • This parameter is not returned if ImportType is FILE.

73088962
UseUserOssBucket

boolean

OssBucket

string

Examples

Success response

JSON format

{
  "RequestId": "67E910F2-4B62-5B0C-ACA3-7547695C****",
  "Success": true,
  "ErrorCode": "success",
  "ErrorMessage": "Specified parameter Tid is not valid.",
  "Data": [
    {
      "DbId": "6kv159u9vtpvl**********b8",
      "DbType": "csv",
      "ImportType": "FILE",
      "InstanceName": "f-ean8u5881qk4*********xh5y",
      "DatabaseName": "diamonds.csv",
      "DatabaseDesc": "这是一份钻石数据。",
      "DescUpdateTime": "2025-12-11T14:04:32.000+00:00",
      "GmtCreated": "2025-12-11T14:04:32.000+00:00",
      "Size": 999,
      "IsInternal": "N",
      "DmsInstanceId": 2740966,
      "DmsDbId": 73088962,
      "UseUserOssBucket": false,
      "OssBucket": "",
      "DownloadLink": "",
      "IntranetDownloadLink": ""
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.