调用ListDatabases获取实例的数据库详情列表_数据管理（兼容数据库备份）(DMS)-阿里云帮助中心

调用ListDatabases获取一个实例下的数据库列表详情信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
dms:ListDatabases	list	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
Tid	long	否	租户 ID。说明取自系统右上角头像处悬停展示的租户 ID 信息，详情请参见查看租户信息。	3***
InstanceId	string	是	实例 ID，取值来自 ListInstances 接口返回的实例信息中的实例 ID，注意不是 RDS 的实例 ID。	12***
PageNumber	integer	是	第几页。	1
PageSize	integer	否	每页记录数。	10

返回参数

名称	类型	描述	示例值
	object
TotalCount	long	实例下面库的个数。	1
RequestId	string	请求 ID。	5541CDA6-F674-435C-81BD-40C2FB926CE3
DatabaseList	array<object>	数据库详情列表。
Database	object
DatabaseId	string	库 ID	1
Host	string	库所属实例的连接地址。	xxx.xxx.xxx.xxx
CatalogName	string	数据库目录名。	1
DbaName	string	库所属 DBA 昵称。	dba_user
State	string	库状态，取值和说明如下： NORMAL：正常 DISABLE：禁用 OFFLINE：下线 NOT_EXIST：不存在	NORMAL
DbaId	string	DBA 的 ID。	1
SchemaName	string	库名。	test
InstanceId	string	库所属实例的 ID。	1
Port	integer	库所属实例连接端口。	3306
EnvType	string	库所属环境类型。	dev
Sid	string	库所属实例的 Sid。	test
OwnerIdList	array	库 Owner ID 列表。
OwnerIds	string	库 Owner ID。	1
Encoding	string	库编码。	utf-8
DbType	string	数据库类型。	mysql
OwnerNameList	array	库 Owner 昵称列表。
OwnerNames	string	库 Owner 昵称。	owner_name
SearchName	string	搜索数据库的名称。	test@xxx.xxx.xxx.xxx:3306
ErrorCode	string	错误码。	UnknownError
ErrorMessage	string	错误信息。	UnknownError
Success	boolean	请求是否成功。	true

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作

暂无变更历史