ListDatabases - Data Management - Alibaba Cloud Documentation Center

Queries the databases in a database instance.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
Tid	long	No	The ID of the tenant. Note : To view the ID of the tenant, move the pointer over the profile picture in the upper-right corner of the Data Management (DMS) console. For more information, see Manage DMS tenants.	3***
InstanceId	string	Yes	The ID of the instance. The valid value is returned if you call the ListInstances operation. The instance ID is not the ID of the RDS instance.	12***
PageNumber	integer	Yes	The number of the page to return.	1
PageSize	integer	No	The number of entries to return per page.	10

Response parameters

Parameter	Type	Description	Example
	object
TotalCount	long	The number of databases that belong to an instance.	1
RequestId	string	The ID of the request.	5541CDA6-F674-435C-81BD-40C2FB926CE3
DatabaseList	array<object>	The details of the databases.
Database	object
DatabaseId	string	The ID of the database.	1
Host	string	The endpoint of the instance to which the database belongs.	xxx.xxx.xxx.xxx
CatalogName	string	The name of the catalog to which the database belongs.	1
DbaName	string	The nickname of the Database administrator (DBA) to which the database belongs.	dba_user
State	string	The state of the database. Valid values: NORMAL: The database is normal. DISABLE: The database is disabled. OFFLINE: The database is unpublished. NOT_EXIST: The database does not exist.	NORMAL
DbaId	string	The ID of the DBA.	1
SchemaName	string	The name of the database.	test
InstanceId	string	The ID of the instance to which the database belongs.	1
Port	integer	The connection port of the instance to which the database belongs.	3306
EnvType	string	The type of the environment to which the database belongs.	dev
Sid	string	The system ID (SID) of the instance to which the database belongs.	test
OwnerIdList	array	The IDs of the owners of the database.
OwnerIds	string	The ID of the owner of the database.	1
Encoding	string	The encoding format of the database.	utf-8
DbType	string	The type of the database engine.	mysql
OwnerNameList	array	The nicknames of the database owners.
OwnerNames	string	The nickname of the database owner.	owner_name
SearchName	string	The name that is used for searching the database.	test@xxx.xxx.xxx.xxx:3306
ErrorCode	string	The error code returned if the request failed.	UnknownError
ErrorMessage	string	The error message returned if the request failed.	UnknownError
Success	boolean	Indicates whether the request is successful.	true

Examples

Sample success responses

JSONformat

{
  "TotalCount": 1,
  "RequestId": "5541CDA6-F674-435C-81BD-40C2FB926CE3",
  "DatabaseList": {
    "Database": [
      {
        "DatabaseId": "1",
        "Host": "xxx.xxx.xxx.xxx",
        "CatalogName": "1",
        "DbaName": "dba_user",
        "State": "NORMAL",
        "DbaId": "1",
        "SchemaName": "test",
        "InstanceId": "1",
        "Port": 3306,
        "EnvType": "dev",
        "Sid": "test",
        "OwnerIdList": {
          "OwnerIds": [
            "1"
          ]
        },
        "Encoding": "utf-8",
        "DbType": "mysql",
        "OwnerNameList": {
          "OwnerNames": [
            "owner_name"
          ]
        },
        "SearchName": "test@xxx.xxx.xxx.xxx:3306"
      }
    ]
  },
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history