文档首页/ 云数据库 TaurusDB/ API参考/ API（推荐）/ 数据库代理/ 查询数据库代理内核参数- ShowProxyConfigurations
更新时间：2025-10-21 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询数据库代理内核参数 - ShowProxyConfigurations

功能介绍

查询数据库代理内核参数。

调用方法

请参见如何调用API。

授权信息

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

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    gaussdbformysql:proxy:queryConfigurations

    Read

    instance *

    • g:EnterpriseProjectId

    • g:ResourceTag/<tag-key>

    gaussdb:proxy:queryConfigurations

    -

URI

GET /v3/{project_id}/instances/{instance_id}/proxy/{proxy_id}/configurations

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

租户在某一Region下的project ID。

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

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，且长度为32个字符。

默认取值：

不涉及。

instance_id

是

String

参数解释：

实例ID，此参数是实例的唯一标识。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，后缀为in07，长度为36个字符。

默认取值：

不涉及。

proxy_id

是

String

参数解释：

数据库代理ID，严格匹配UUID规则。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，后缀为po01，长度为36个字符。

默认取值：

不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

limit

否

Integer

参数解释：

查询记录数。

约束限制：

必须为整数，不能为负数。

取值范围：

1-100。

默认取值：

100。

offset

否

Integer

参数解释：

索引位置，偏移量。从第一条数据偏移offset条数据后开始查询。

约束限制：

必须为整数，不能为负数。

取值范围：

≥0。

默认取值：

0。

name

否

String

参数解释：

参数名称，为空则全量查询。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。 通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

Content-Type

是

String

参数解释：

内容类型。

约束限制：

不涉及。

取值范围：

application/json。

默认取值：

application/json。

X-Language

否

String

参数解释：

请求语言类型。

约束限制：

不涉及。

取值范围：

  • en-us

  • zh-cn

默认取值：

en-us。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

total_count

String

参数解释：

数据总数。

取值范围：

不涉及。

configurations

Array of ProxyConfiguration objects

参数解释：

内核可配置的参数列表。
表5 ProxyConfiguration

参数

参数类型

描述

name

String

参数解释：

参数名称。

取值范围：

不涉及。

data_type

String

参数解释：

参数数据类型。

取值范围：

不涉及。

elem_type

String

参数解释：

参数父标签类型。

取值范围：

不涉及。

value_range

String

参数解释：

参数取值范围。

取值范围：

不涉及。

value

String

参数解释：

参数默认值。

取值范围：

不涉及。

description

String

参数解释：

参数描述。

取值范围：

不涉及。

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码： 500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

查询数据库代理内核参数。

GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/61a4ea66210545909d74a05c27a7179ein07/proxy/151c14381ac14ecfb9703a745b992677po01/configurations

响应示例

状态码： 200

Success.

{
  "total_count" : 1,
  "configurations" : [ {
    "name" : "slowLogQueryTime",
    "data_type" : "integer",
    "elem_type" : "system",
    "value_range" : "200-50000",
    "value" : 500,
    "description" : "proxy慢日志阈值，默认值为500，单位ms。"
  } ]
}

状态码

状态码

描述

200

Success.

400

Client error.

500

Server error.

错误码

请参见错误码。

父主题： 数据库代理