查询租户下的数据库列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
TenantId | string | 是 | 租户 ID。 | t4pnum**** |
PageNumber | integer | 否 | 分页查询的页码。
| 1 |
PageSize | integer | 否 | 分页查询时设置的每页行数。
| 10 |
DatabaseName | string | 否 | 数据库名称。 不能使用某些预留关键字,如 test、mysql。 | sms_pre |
SearchKey | string | 否 | 查询列表的删选关键字。 | pay |
WithTables | boolean | 否 | 是否返回数据库中的表信息。 说明
如果表的数量过大则可能导致接口超时。
| true |
InstanceId | string | 否 | 集群 ID。 | ob****n0abo9uo |
返回参数
示例
正常返回示例
JSON
格式
{
"TotalCount": 1,
"Databases": [
{
"Status": "ONLINE",
"Description": "test db",
"Encoding": "utf8mb4",
"DbType": "mysql",
"DatabaseName": "sms_pre",
"CreateTime": "2022-02-21 15:41:06",
"Users": [
{
"UserType": "Normal",
"Role": "ReadOnly",
"UserName": "user_pay_ro",
"Privileges": "select,delete,update"
}
],
"TenantId": "t4pnum****",
"Tables": [
{
"TableName": "testTables"
}
],
"RequiredSize": 0,
"DataSize": 0,
"Collation": "utf8mb4_general_ci",
"InstanceId": "obsdh2f****",
"TenantName": "tenantABC"
}
],
"RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C"
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2023-10-30 | OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
2023-07-04 | OpenAPI 返回结构发生变更 | 查看变更详情 |
2022-09-28 | OpenAPI 返回结构发生变更 | 查看变更详情 |
2022-01-17 | OpenAPI 返回结构发生变更 | 查看变更详情 |