Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ Parameter Template Management/ Obtaining Parameter Information of a Specified DB Instance
Updated on 2025-09-04 GMT+08:00

Obtaining Parameter Information of a Specified DB Instance

Function

This API is used to obtain parameter information of a specified DB instance. Before calling this API:

URI

GET /v3/{project_id}/instances/{instance_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

Table 2 Query parameters

Parameter

Mandatory

Type

Description

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

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

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

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

configurations

ParameterConfigurationInfo object

Definition

Instance parameter template information.

total_count

Long

Definition

Total number of instance parameters.

Range

≥ 0

parameter_values

Array of ParameterValuesInfo objects

Definition

Instance parameter information.

Table 5 ParameterConfigurationInfo

Parameter

Type

Description

datastore_version_name

String

Definition

DB version name.

Range

2.0

datastore_name

String

Definition

DB engine name in the parameter template.

Range

taurus

created

String

Definition

Time when the parameter template was created. The format is "yyyy-mm-ddThh:mm:ssZ".

T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, if the time zone offset is one hour, the value of Z is +0100.

Range

N/A

updated

String

Definition

Time when the parameter template was updated. The format is "yyyy-mm-ddThh:mm:ssZ".

T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, if the time zone offset is one hour, the value of Z is +0100.

Range

N/A

Table 6 ParameterValuesInfo

Parameter

Type

Description

name

String

Definition

Parameter name.

Range

N/A

value

String

Definition

Parameter value.

Range

N/A

restart_required

Boolean

Definition

Whether a reboot is required.

Range

  • false: No
  • true: Yes

readonly

Boolean

Definition

Whether the parameter is read-only.

Range

  • false: No
  • true: Yes

value_range

String

Definition

Value range.

Range

N/A

type

String

Definition

Parameter type.

Range

  • string
  • integer
  • boolean
  • list
  • float

description

String

Definition

Parameter description.

Range

N/A

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

Obtaining parameter information of a specified DB instance

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

Example Response

Status code: 200

Success.

{
  "configurations" : {
    "datastore_version_name" : 2.0,
    "datastore_name" : "taurus",
    "created" : "2022-10-29T09:38:36+0000",
    "updated" : "2022-10-29T09:38:36+0000"
  },
  "total_count" : 125,
  "parameter_values" : [ {
    "name" : "auto_increment_increment",
    "value" : 1,
    "restart_required" : false,
    "readonly" : false,
    "value_range" : "1-65535",
    "type" : "integer",
...."description": auto_increment_increment and auto_increment_offset are used for master-to-master replication and to control the operations of the AUTO_INCREMENT column.
  }, {
    "name" : "auto_increment_offset",
    "value" : 1,
    "restart_required" : false,
    "readonly" : false,
    "value_range" : "1-65535",
    "type" : "integer",
...."description": auto_increment_increment and auto_increment_offset are used for master-to-master replication and to control the operations of the AUTO_INCREMENT column.
  } ]
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.