更新时间:2024-09-11 GMT+08:00

查询数据库代理内核参数

功能介绍

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户在某一Region下的project ID。

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

instance_id

String

实例ID。

proxy_id

String

数据库代理ID。

表2 Query参数

参数

是否必选

参数类型

描述

limit

Integer

查询记录数。默认为10,不能为负数,最小值为1,最大值为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。

X-Language

String

请求语言类型。默认en-us。

取值范围:

  • en-us
  • zh-cn

响应参数

状态码: 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.

错误码

请参见错误码