云数据库 PostgreSQL 版
云数据库 PostgreSQL 版
云数据库 PostgreSQL 版
文档指南
请输入
产品动态
用户指南
实例管理
连接管理
服务可用性
Schema 管理
备份恢复
日志管理
数据安全
插件
API 参考
V2（2022-01-01）
实例管理
账号管理
连接管理
参数管理
备份与恢复
数据安全
SDK 参考
V2（2022-01-01）
相关协议
- 文档首页
云数据库 PostgreSQL 版API 参考V2（2022-01-01）Schema 管理DescribeSchemas
复制全文
下载 pdfDescribeSchemas
文档反馈
问问助手调用 DescribeSchemas 接口查询 Schema 列表。
请求类型
同步请求。
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
参数 | 类型 | 是否必选 | 示例值 | 描述 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
InstanceId | String | 是 | postgres-21a3333b**** | 实例 ID。 |
DBName | String | 否 | testdb | 数据库名称。 说明 不传值或传空值时，会查询指定实例下的所有 Schema。 |
PageNumber | Integer | 否 | 1 | 当前页查询偏移量，默认值为 1。 |
PageSize | Integer | 否 | 10 | 每页记录数，取值应大于 0 且不超过 1000，默认值为 10。 |
返回参数
参数 | 类型 | 示例值 | 描述 |
参数 | 类型 | 示例值 | 描述 |
Total | Integer | 1 | Schema 总数。 |
Schemas | 请参见返回示例。 | Schema 列表。 |
SchemaObject
参数 | 类型 | 示例值 | 描述 |
参数 | 类型 | 示例值 | 描述 |
DBName | String | testdb | 数据库名。 |
SchemaName | String | testschema | 数据库下的 Schema 名称。 |
Owner | String | testuser | Schema 的 owner。 说明 实例只读账号、被禁用了 DDL 权限的高权限账号或被禁用了 DDL 权限的普通账号不能作为数据库的 Owner。 |
示例
请求示例
POST /?Action=DescribeSchemas&Version=2022-01-01 HTTP/1.1
Content-Type: application/json
Host: rds-postgresql.cn-beijing.volcengineapi.com
X-Date: 20231002T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_postgresql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****
{
"DBName": "testdb1",
"InstanceId": "postgres-ca7b7019****",
"PageSize": 10,
"PageNumber": 1
}
返回示例
{
"ResponseMetadata": {
"RequestId": "202308041039157B21482F51ABF9041021",
"Action": "DescribeSchemas",
"Version": "2022-01-01",
"Service": "rds_postgresql",
"Region": "cn-beijing"
},
"Result": {
"Schemas": [
{
"DBName": "testdb1",
"Owner": "postgres",
"SchemaName": "pg_catalog"
},
{
"DBName": "testdb1",
"Owner": "postgres",
"SchemaName": "information_schema"
},
{
"DBName": "testdb1",
"Owner": "pg_rds_superuser",
"SchemaName": "public"
},
{
"DBName": "testdb1",
"Owner": "yy_123",
"SchemaName": "testschema"
}
],
"Total": 4
}
}
最近更新时间：2026.03.31 10:39:10
这个页面对您有帮助吗？
有用
有用
无用
无用