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

Updated on 2024-09-11 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	Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.
instance_id	Yes	String	Instance ID.
proxy_id	Yes	String	Proxy instance ID.

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Number of records to be queried. The default value is 10. The value must be a positive integer. The minimum value is 1 and the maximum value is 100.
offset	No	Integer	Index offset. If offset is set to N, the query starts from the N+1 piece of data. The value is 0 by default, indicating that the query starts from the first piece of data. The value must be a number but cannot be a negative number.
name	No	String	Parameter name. If this parameter is left empty, all parameters are queried.

Request Parameters

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

Response Parameters

Status code: 200

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

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

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."
  } ]
}