ListDatabases - Data Management - Alibaba Cloud Documentation Center

Invoke ListDatabases to retrieve the list of databases for an instance.

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

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Tid	integer	No	The tenant ID. Note Hover over the profile picture in the upper-right corner to view the tenant ID. For more information, see View tenant information.	3***
InstanceId	string	Yes	The instance ID. Obtain this from the instance ID in the instance information returned by the ListInstances API. This is not the RDS instance ID.	12***
PageNumber	integer	No	The page number.	1
PageSize	integer	No	The number of records per page.	10

Response elements

Element	Type	Description	Example
	object
TotalCount	integer	The number of databases under the instance.	1
RequestId	string	The request ID.	5541CDA6-F674-435C-81BD-40C2FB926CE3
DatabaseList	object
Database	array<object>	The list of database details.
	array<object>
DatabaseId	string	The database ID.	1
Host	string	The endpoint of the instance to which the database belongs.	xxx.xxx.xxx.xxx
CatalogName	string	The database catalog name.	1
DbaName	string	The nickname of the DBA to whom the database belongs.	dba_user
State	string	The database status. Values and descriptions are as follows: NORMAL: Normal DISABLE: Disabled OFFLINE: Offline NOT_EXIST: Does not exist	NORMAL
DbaId	string	The DBA ID.	1
SchemaName	string	The database name.	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 environment type to which the database belongs.	dev
Sid	string	The SID of the instance to which the database belongs.	test
OwnerIdList	object
OwnerIds	array	The list of database owner IDs.
	string	The database owner ID.	1
Encoding	string	The database encoding.	utf-8
DbType	string	The database type.	mysql
OwnerNameList	object
OwnerNames	array	The list of database owner nicknames.
	string	The database owner nickname.	owner_name
SearchName	string	The name used to search for the database.	test@xxx.xxx.xxx.xxx:3306
ErrorCode	string	The error code.	UnknownError
ErrorMessage	string	The error message.	UnknownError
Success	boolean	Indicates whether the request was successful.	true

Examples

Success response

JSON format

{
  "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.