Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ Database Proxy/ Querying Kernel Parameters of a Proxy Instance

Updated on 2025-07-29 GMT+08:00

Online Debugging

CLI Examples

View PDF

Querying Kernel Parameters of a Proxy Instance

Function

This API is used to query kernel parameters of a proxy instance. Before calling this API:

Learn how to authorize and authenticate it.
Obtain the required region and endpoint.

URI

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

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. Constraints N/A Range The value contains 32 characters. Only letters and digits are allowed. Default Value N/A
instance_id	Yes	String	Definition Instance ID, which uniquely identifies an instance. Constraints N/A Range The value contains 36 characters with a suffix of in07. Only letters and digits are allowed. Default Value N/A
proxy_id	Yes	String	Definition Proxy instance ID, which is compliant with the UUID format. Constraints N/A Range The value contains 36 characters with a suffix of po01. Only letters and digits are allowed. Default Value N/A

**Table 2** Query parameter
Parameter	Mandatory	Type	Description
limit	No	Integer	Definition Number of records to be queried. Constraints The value must be an integer and cannot be a negative number. Range 1–100 Default Value 100
offset	No	Integer	Definition Index offset. The query starts from the next piece of data indexed by this parameter. Constraints The value must be an integer and cannot be a negative number. Range ≥ 0 Default Value 0
name	No	String	Definition Parameter name. If this parameter is left empty, all parameters are queried. Constraints N/A Range N/A Default Value N/A

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. To obtain this value, call the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the token value. Constraints N/A Range N/A Default Value N/A
Content-Type	Yes	String	Definition Content type. Constraints N/A Range application/json Default Value application/json
X-Language	No	String	Definition Request language type. Constraints N/A Range en-us zh-cn Default Value en-us

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total_count	String	Definition Total number of records. Range N/A
configurations	Array of ProxyConfiguration objects	Definition Parameters that can be configured for the kernel.

**Table 5** ProxyConfiguration
Parameter	Type	Description
name	String	Definition Parameter name. Range N/A
data_type	String	Definition Data type of the parameter. Range N/A
elem_type	String	Definition Parent tag type of the parameter. Range N/A
value_range	String	Definition Parameter value range. Range N/A
value	String	Definition Default parameter value. Range N/A
description	String	Definition Parameter description. Range N/A

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Request

Querying kernel parameters of a proxy instance

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

Example Response

Status code: 200

Success.

{
  "total_count" : 1,
  "configurations" : [ {
    "name" : "slowLogQueryTime",
    "data_type" : "integer",
    "elem_type" : "system",
    "value_range" : "200-50000",
    "value" : 500,
    "description" : "The default threshold for proxy slowLogQueryTime is 500 ms."
  } ]
}