Obtaining a Parameter List¶

Function¶

This API is used to obtain all the parameters that can be modified of the current database version.

URI¶

URI format
PATH: /v1.0/{project_id}/datastores/versions/{datastore_version_id}/parameters
Method: GET

Parameter description

**Table 1** Parameter description¶
Name	Mandatory	Description
project_id	Yes	Specifies the project ID of a tenant in a region.
datastore_version_id	Yes	Specifies the database version ID (dataStores.id in the response message in Database Version Queries).

Restrictions
Currently, only the DB engines MySQL and PostgreSQL are supported by the API.

Request¶

None

Normal Response¶

Parameter description

**Table 2** Parameter description¶
Name	Type	Description
configuration-parameters	List data structure. For details, see Table 3.	Indicates all the parameters that can be modified of the database version.

**Table 3** configuration-parameters field data structure description¶
Name	Type	Description
name	String	Indicates the parameter name.
min	String	Indicates the minimum value. Returned only when type is integer or float.
max	String	Indicates the maximum value. Returned only when type is integer or float.
type	String	Indicates the parameter type, which can be integer, string, boolean, list, or float.
restart_required	Boolean	Indicates whether the instance needs to reboot for the parameter to take effect. The value is true or false.
datastore_version_id	String	Indicates the database version ID.

Response example

{
  "configuration-parameters" : [ {
    "name" : "autocommit",
    "type" : "boolean",
    "restart_required" : false,
    "datastore_version_id" : "e8a8b8cc-63f8-4fb5-8d4a-24c502317a61"
  }, {
    "name" : "auto_increment_increment",
    "min" : "1",
    "max" : "65535",
    "type" : "integer",
    "restart_required" : false,
    "datastore_version_id" : "e8a8b8cc-63f8-4fb5-8d4a-24c502317a61"
  }, {
    "name" : "auto_increment_offset",
    "min" : "1",
    "max" : "65535",
    "type" : "integer",
    "restart_required" : false,
    "datastore_version_id" : "e8a8b8cc-63f8-4fb5-8d4a-24c502317a61"
  }, {
    "name" : "back_log",
    "min" : "1",
    "max" : "65535",
    "type" : "integer",
    "restart_required" : true,
    "datastore_version_id" : "e8a8b8cc-63f8-4fb5-8d4a-24c502317a61"
    } ]
}

Abnormal Response¶

For details, see Abnormal Request Results.

last updated: 2024-07-26 00:04