查询数据库信息。
接口说明
- 地域的公网接入地址：
adb.<region-id>.aliyuncs.com。示例：adb.cn-hangzhou.aliyuncs.com。 - 地域的 VPC 接入地址：
adb-vpc.<region-id>.aliyuncs.com。示例：adb-vpc.cn-hangzhou.aliyuncs.com。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| adb:getDatabaseObjectsByFilter | get |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| OrderBy | string | 否 | 排序字段。 类型取值：
域取值： -DatabseName； -CreateTime; -UpdateTime; 默认值：{"Type": "Desc","Field": "DatabaseName"}； | { "Type": "Desc", "Field": "DatabaseName" } |
| FilterSchemaName | string | 否 | 数据库名。 | test_db |
| PageNumber | long | 否 | 页码，取值为大于 0 且不超过 Integer 数据类型的最大值。默认值为 1。 | 1 |
| PageSize | long | 否 | 每页记录数，取值：
默认值：30。 | 30 |
| DBClusterId | string | 否 | 集群 ID。 | am-bp1565u55p32**** |
| FilterOwner | string | 否 | 所有者。 | admin |
| RegionId | string | 是 | 地域 ID。 | cn-hangzhou |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "863D51B7-5321-41D8-A0B6-A088B0******",
"PageNumber": 1,
"PageSize": 30,
"TotalCount": 1,
"Data": {
"DatabaseSummaryModels": [
{
"Owner": "abc",
"SchemaName": "testSchema",
"Description": "description",
"CreateTime": "2023-01-05 13:17:55",
"UpdateTime": "2023-01-05 13:17:55"
}
],
"PageNumber": 1,
"PageSize": 30,
"TotalCount": 1
}
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | MDS.IllegalArgument | Invalid argument. | 用户使用了非法参数 |
| 400 | MDS.InvalidPrivilege | No permissions. | 用户无权限进行操作 |
| 400 | MDS.MetaSchemaAlreadyExist | The database already exists. | 数据库已存在 |
| 400 | MDS.MetaSchemaNotExist | The database does not exist. | 操作的数据库不存在 |
| 400 | MDS.MetaTableAlreadyExist | The table already exists. | 操作的表已经存在 |
| 400 | MDS.MetaTableNotExist | The table is not found. | 操作的表不存在 |
| 500 | MDS.InternalError | An internal MDS error occurred. | MDS服务内部错误 |
| 500 | MDS.MetaVisitError | Failed to access metadata. | 访问元数据失败 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2023-10-25 | OpenAPI 错误码发生变更 | 查看变更详情 |
| 2023-03-22 | OpenAPI 错误码发生变更 | 查看变更详情 |