更新时间:2025-12-10 GMT+08:00

查询集群模式空间信息

功能介绍

查询集群模式空间信息。

调用方法

请参见如何调用API。

URI

GET /v2/{project_id}/clusters/{cluster_id}/databases/{database_name}/schemas

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID。获取方法请参见获取项目ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

cluster_id

是

String

参数解释:

集群ID。获取方法请参见获取集群ID。

约束限制:

必须是有效的dws集群ID。

取值范围:

36位UUID。

默认取值:

不涉及。

database_name

是

String

参数解释:

数据库名称。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

sort_key

否

String

参数解释:

排序字段。

约束限制:

不涉及。

取值范围:

schemaName:模式名称排序。

默认取值:

不涉及。

sort_dir

否

String

参数解释:

排序字段。

约束限制:

不涉及。

取值范围:

ASC:表示按升序排序。

DESC:表示按降序排序。

默认取值:

不涉及。

keywords

否

String

参数解释:

查询关键词。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

limit

否

Integer

参数解释:

分页单页大小。

约束限制:

不涉及。

取值范围:

大于0。

默认取值:

10

offset

否

Integer

参数解释:

分页偏移量,从0开始,页数减1。

约束限制:

不涉及。

取值范围:

大于等于0。

默认取值:

0

请求参数

无

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

schemas

Array of SchemaInfo objects

参数解释:

集群模式空间信息列表。

取值范围:

不涉及。

count

Integer

参数解释:

总数量。

取值范围:

不涉及。

表4 SchemaInfo

参数

参数类型

描述

schema_name

String

参数解释:

集群模式名称。

取值范围:

不涉及。

database_name

String

参数解释:

数据库名称。

取值范围:

不涉及。

total_value

Integer

参数解释:

集群模式使用空间总值。

取值范围:

不涉及。

perm_space

Integer

参数解释:

集群模式空间阈值。

取值范围:

不涉及。

skew_percent

Double

参数解释:

倾斜率。

取值范围:

不涉及。

min_value

Integer

参数解释:

最小值。

取值范围:

不涉及。

max_value

Integer

参数解释:

最大值。

取值范围:

不涉及。

min_dn

String

参数解释:

最小dn节点。

取值范围:

不涉及。

max_dn

String

参数解释:

最大cn节点。

取值范围:

不涉及。

dn_num

Integer

参数解释:

dn节点数量。

取值范围:

不涉及。

请求示例

GET https://{Endpoint}/v2/89cd04f168b84af6be287f71730fdb4b/clusters/e59d6b86-9072-46eb-a996-13f8b44994c1/databases/gaussdb/schemas

响应示例

状态码:200

查询集群模式空间信息列表成功。

{
  "schemas" : [ {
    "schema_name" : "gs_logical_cluster",
    "database_name" : "gaussdb",
    "total_value" : 0,
    "perm_space" : -1,
    "skew_percent" : 0.0,
    "min_value" : 0,
    "max_value" : 0,
    "min_dn" : "dn_6001_6002",
    "max_dn" : "",
    "dn_num" : 3
  } ],
  "count" : 2
}

状态码

状态码

描述

200

查询集群模式空间信息列表成功。

400

请求错误。

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

500

服务内部错误。

503

服务不可用。