文档首页/ 数据安全中心 DSC/ API参考/ API/ API数据安全网关/ 查询模式 - ShowSchemas
更新时间：2026-10-09 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询模式 - ShowSchemas

功能介绍

功能介绍：查询schema

接口约束

  • 无特殊约束。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，当前API调用无需身份策略权限。

URI

POST /v1/{project_id}/sdg/server/schemas

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目ID。可参考获取项目ID获取。

约束限制：

不涉及

取值范围：

以IAM服务接口返回值为准，字符长度32-32，满足正则匹配"^[a-z0-9]{32}$"

默认取值：

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。通过调用IAM服务查询用户Token接口获取（响应消息头中X-Subject-Token的值）。

约束限制：

不涉及

取值范围：

IAM服务查询用户Token接口为准

默认取值：

不涉及
表3 请求Body参数

参数

是否必选

参数类型

描述

db_type

否

String

参数解释：

数据库类型

约束限制：

不涉及

取值范围：

  • "OBS" 对象存储服务

  • "MSSQL" SQLServer数据库

  • "MYSQL" MySQL数据库

  • "ES" Elasticsearch搜索引擎

  • "PG" PostgreSQL数据库

  • "GREENPLUM" Greenplum数据库

  • "ORACLE" Oracle数据库

  • "MRS_HIVE" MRS Hive数据仓库

  • "HBASE" HBase数据库

  • "DWS" 数据仓库服务

  • "KINGBASE" 人大金仓数据库

  • "OPENGAUSS" 高斯数据库

  • "DMDBMS" 达梦数据库

  • "Hive" Hive数据仓库

  • "MARIADB" MariaDB数据库

  • "TAURUS_DB" TaurusDB数据库

  • "TDSQL" TDSQL数据库

  • "HIVE_ONLY" 仅自建Hive

  • "DLI" 数据湖探索

  • "MONGODB" MongoDB数据库

  • "LTS" 日志服务

默认取值：

不涉及

db_version

否

String

参数解释：

数据库版本号

约束限制：

最大长度256字符

取值范围：

不涉及

默认取值：

不涉及

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

schemas

Array of strings

参数解释：

数据库Schema列表

取值范围：

不涉及

请求示例

查询模式请求体

{
  "db_type" : "MYSQL",
  "db_version" : "8.0"
}

响应示例

状态码：200

{
  "schemas" : [ "customer_schema" ]
}

状态码

状态码

描述

200

查询成功

错误码

请参见错误码。

父主题： API数据安全网关

相关文档