doc-exports/docs/geminidb/api-ref/nosql_06_0219.html

Modifying Parameters of a Specified Instance

Function

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

This API will be unavailable. You are advised to switch workloads to the new API described in Modifying Parameters of a Specified Instance.

Constraints

This API can be used for GeminiDB Cassandra instances.

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.

URI

PUT https://{Endpoint}/v3/{project_id}/instances/{instance_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.

Request Parameters

Table 2 Request header parameters

Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token

Table 3 Request body parameters

Parameter	Mandatory	Type	Description
values	Yes	Map<String,String>	Parameter values defined by users based on a default parameter template.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter	Type	Description
job_id	String	ID of the asynchronous task for modifying instance parameters.
restart_required	Boolean	Whether the instance needs to be restarted. The value can be: true, indicating that the instance needs to be restarted. false, indicating that the instance does not need to be restarted.

Example Request

• URI example

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

• Modifying Parameters of a Specified Instance

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

Example Response

Status code: 200

Success

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

Status Codes

See Status Codes.

Error Codes

See Error Codes.

Parent topic: Parameter Templates