Updated on 2026-09-22 GMT+08:00

Modifying Parameters of a Specified Instance

Function

This API is used to modify parameters of a specified instance.

Constraints

This API supports the following instances:

GeminiDB Cassandra
GeminiDB Mongo
GeminiDB Influx
GeminiDB Redis

For configuration item values, you can enter system-defined parameters that allow for modification.

This API is an asynchronous API. A successful response does not indicate that the parameters are successfully modified.

Authorization Information

Each account has permissions to call all APIs, but IAM users must have the required permissions specifically assigned.

If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
gaussdbfornosql:instance:updateConfiguration	Write	instance *	g:ResourceTag/<tag-key> g:EnterpriseProjectId	nosql:instance:modifyParameter	-

URI

PUT /v3.1/{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. To obtain the value, call the Querying Instances and Details API. If no instance is available, call the Creating an Instance API to create one. Constraints N/A Range N/A Default Value N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token You can obtain the token by calling the IAM API by following Obtaining a User Token Through Password Authentication. Constraints N/A Range N/A Default Value N/A

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
values	Yes	Map<String,String>	Definition Parameter values defined by users based on a default parameter template. For details about how to obtain the values, see configuration_parameters in "Response Parameters" in Querying Instance Parameter Settings. Constraints N/A

Response Parameters

Status code: 202

**Table 4** Response body parameters
Parameter	Type	Description
job_id	String	Definition ID of an asynchronous task for modifying instance parameters Range N/A
restart_required	Boolean	Definition Whether an instance needs to be restarted Range true: An instance needs to be restarted. false: An instance does not need to be restarted.

Example Requests

Modifying parameters of a specified instance

PUT https://{Endpoint}/v3.1/054e292c9880d4992f02c0196d3ea468/instances/392850e624504e1490901d50b585a60din06/configurations

{
  "values" : {
    "request_timeout_in_ms" : "10000"
  }
}

Example Responses

Status code: 202

Success

{
  "job_id" : "463b4b58-d0e8-4e2b-9560-5dea4552fde9",
  "restart_required" : false
}

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.

Parent topic: Parameter Configuration