文档

ListDatabases - 获取实例的数据库详情列表

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

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
Tidlong

租户 ID。

说明 取自系统右上角头像处悬停展示的租户 ID 信息,详情请参见查看租户信息
3***
InstanceIdstring

实例 ID,取值来自 ListInstances 接口返回的实例信息中的实例 ID,注意不是 RDS 的实例 ID。

12***
PageNumberinteger

第几页。

1
PageSizeinteger

每页记录数。

10

返回参数

名称类型描述示例值
object
TotalCountlong

实例下面库的个数。

1
RequestIdstring

请求 ID。

5541CDA6-F674-435C-81BD-40C2FB926CE3
DatabaseListobject []

数据库详情列表。

DatabaseIdstring

库 ID

1
Hoststring

库所属实例的连接地址。

xxx.xxx.xxx.xxx
CatalogNamestring

数据库目录名。

1
DbaNamestring

库所属 DBA 昵称。

dba_user
Statestring

库状态,取值和说明如下:

  • NORMAL: 正常
  • DISABLE:禁用
  • OFFLINE:下线
  • NOT_EXIST:不存在
NORMAL
DbaIdstring

DBA 的 ID。

1
SchemaNamestring

库名。

test
InstanceIdstring

库所属实例的 ID。

1
Portinteger

库所属实例连接端口。

3306
EnvTypestring

库所属环境类型。

dev
Sidstring

库所属实例的 Sid。

test
OwnerIdListarray

库 Owner ID 列表。

string

库 Owner ID。

1
Encodingstring

库编码。

utf-8
DbTypestring

数据库类型。

mysql
OwnerNameListarray

库 Owner 昵称列表。

string

库 Owner 昵称。

owner_name
SearchNamestring

搜索数据库的名称。

test@xxx.xxx.xxx.xxx:3306
ErrorCodestring

错误码。

UnknownError
ErrorMessagestring

错误信息。

UnknownError
Successboolean

请求是否成功。

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
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)
文档反馈