更新时间:2024-06-18 GMT+08:00
分享

获取schemas

功能介绍

获取schemas,目前只有DWS和采用postgresql驱动的RDS数据源支持schema,请在调用前确认该数据源是否支持schema字段

调用方法

请参见如何调用API

URI

GET /v2/{project_id}/{connection_id}/schemas

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方法请参见项目ID和账号ID

connection_id

String

数据连接id,可通过数据连接列表中获取。

表2 Query参数

参数

是否必选

参数类型

描述

database_name

String

数据库名称

limit

String

数据条数限制

offset

String

偏移量

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token,使用Token认证时必选。通过调用ManageOne平台的IAM服务的“获取用户Token”接口获取响应消息头中X-Subject-Token的值。

workspace

String

数据所在空间的id值

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

total_count

Integer

当前数据连接schema记录数

dw_id

String

数据连接id。

database

String

数据库名称

schemas

Array of SchemasList objects

schema列表

表5 SchemasList

参数

参数类型

描述

schema_name

String

schema名称

description

String

schema描述

状态码: 400

表6 响应Body参数

参数

参数类型

描述

error_msg

String

返回的错误信息。

error_code

String

返回的错误码。

状态码: 500

表7 响应Body参数

参数

参数类型

描述

error_msg

String

返回的错误信息。

error_code

String

返回的错误码。

请求示例

响应示例

状态码: 200

Success,返回schemas列表

{
  "dw_id" : "9b18c0ad6ef5404caef4e6cbaccdae6f",
  "database" : "postgres",
  "schemas" : [ {
    "schema_name" : "dm_autotest",
    "description" : ""
  }, {
    "schema_name" : "dbadmin",
    "description" : ""
  }, {
    "schema_name" : "public",
    "description" : "gs_roach_stop_backup"
  }, {
    "schema_name" : "schame",
    "description" : ""
  }, {
    "schema_name" : "utl_file",
    "description" : ""
  }, {
    "schema_name" : "utl_raw",
    "description" : ""
  } ],
  "total_count" : 6
}

状态码: 400

{
  "error_code" : "DAYU.4402",
  "error_msg" : "The operation failed, detail msg {0}."
}

状态码: 500

{
  "error_code" : "DAYU.3531",
  "error_msg" : "Internal server error: {0}"
}

状态码

状态码

描述

200

Success,返回schemas列表

400

BadRequest

500

Internal Server Error

分享:

    相关文档

    相关产品