You need to enable JavaScript to run this app.
文档中心
云数据库 veDB MySQL 版

云数据库 veDB MySQL 版

复制全文
下载 pdf
数据库管理
DescribeDatabases - 获取数据库列表
复制全文
下载 pdf
DescribeDatabases - 获取数据库列表
调用 DescribeDatabases 接口查询数据库列表。​
请求类型​
同步请求。​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
​
参数​
类型​
是否必选​
示例值​
描述​
InstanceId​
String​
是​
vedbm-r3xq0zdl****​
实例 ID。​
说明​
您可以调用 DescribeDBInstances 接口查询实例 ID。​
PageNumber​
Integer​
否​
1​
页码,取值大于等于 1,且不超过 Integer 的最大值,默认值为 1。​
PageSize​
Integer​
否​
10​
每页记录数。取值范围 1~1000,默认值为 10。​
DBName​
String​
否​
testdb1​
数据库名称。​
说明​
在进行模糊搜索时,下划线(_)不作为通配符使用,而是直接匹配下划线(_)本身。​
​
返回参数​
​
参数​
类型​
示例值​
描述​
Total​
Integer​
2​
数据库总数。​
Databases​
Array of DatabaseObject​
请参见返回示例。​
数据库列表。​
​
DatabaseObject​
​
参数​
类型​
示例值​
描述​
DBName​
String​
testdb​
数据库名称。​
CharacterSetName​
String​
utf8​
数据库字符集:​
  • utf8mb4​
  • utf8​
  • latin1​
  • ascii​
DBDesc​
String​
这是一段数据库的描述信息​
数据库的描述信息。​
DatabasesPrivileges​
请参见返回示例。​
数据库的权限信息。​
​
DatabasesPrivilegeObject​
​
参数​
类型​
示例值​
描述​
AccountName​
String​
user1​
需授权的账号名称。​
AccountPrivilege​
String​
ReadWrite​
授权数据库权限类型:​
  • ReadWrite:读写权限。​
  • ReadOnly:只读权限。​
  • DDLOnly:仅 DDL 权限。​
  • DMLOnly:仅 DML 权限。​
  • Custom:自定义权限。​
AccountPrivilegeDetail​
String​
INSERT,UPDATE,DELETE,CREATE​
权限类型所包含的具体 SQL 操作权限,多个字符串之间使用英文逗号(,)分隔。​
  • 在 CreateDatabase 接口中作为请求参数时,当 AccountPrivilege 取值为 Custom 时,该参数必填。取值范围(可多选):SELECT、INSERT、UPDATE、DELETE、CREATE、DROP、REFERENCES、INDEX、ALTER、CREATE TEMPORARY TABLES、LOCK TABLES、EXECUTE、CREATE VIEW、SHOW VIEW、CREATE ROUTINE、ALTER ROUTINE、EVENT、TRIGGER。​
  • 在 DescribeDatabases 接口中作为返回参数时,无论 AccountPrivilege 取什么值,都返回该权限类型所包含的 SQL 操作权限详情。关于各权限类型包含的具体 SQL 操作权限请参见账号权限列表。​
​
示例​
请求示例​
​
POST /?Action=DescribeDatabases&Version=2022-01-01 HTTP/1.1​
Content-Type: application/json​
Host:vedbm.cn-beijing.volcengineapi.com​
X-Date: 20220101T101010Z​
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20220101/cn-beijing/vedbm/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c645****​
{​
"InstanceId": "vedbm-ca12cbqv****",​
"PageNumber": 1,​
"PageSize": 10​
}​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "20240626181457AE8FEFE71A65F50CF16C-44a261",​
"Action": "DescribeDatabases",​
"Version": "2022-01-01",​
"Service": "vedbm",​
"Region": "cn-beijing"​
},​
"Result": {​
"Databases": [​
{​
"CharacterSetName": "utf8mb4",​
"DBDesc": "这是一段数据库的描述信息",​
"DBName": "db1",​
"DatabasesPrivileges": [​
{​
"AccountName": "test1",​
"AccountPrivilege": "DDLOnly",​
"AccountPrivilegeDetail": "CREATE,DROP,INDEX,ALTER,CREATE TEMPORARY TABLES,LOCK TABLES,CREATE VIEW,SHOW VIEW,CREATE ROUTINE,ALTER ROUTINE"​
},​
{​
"AccountName": "test2",​
"AccountPrivilege": "Custom",​
"AccountPrivilegeDetail": "INSERT,UPDATE,DELETE,CREATE"​
},​
{​
"AccountName": "test3",​
"AccountPrivilege": "ReadWrite",​
"AccountPrivilegeDetail": "SELECT,INSERT,UPDATE,DELETE,CREATE,DROP,REFERENCES,INDEX,ALTER,CREATE TEMPORARY TABLES,LOCK TABLES,CREATE VIEW,SHOW VIEW,CREATE ROUTINE,ALTER ROUTINE,EXECUTE,EVENT,TRIGGER"​
}​
]​
}​
],​
"Total": 1​
}​
}​
​
错误码​
更多详情,请参见错误码。​
最近更新时间:2026.02.25 13:20:54
这个页面对您有帮助吗?
有用
有用
无用
无用