Modifying Parameters of a Specified Instance¶

Function¶

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

This API supports 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.

PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/configurations

**Table 1** Path 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.

**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.

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.

URI example

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

Modifying Parameters of a Specified Instance

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

Status code: 200

Success

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

For details, see Status Codes.

For details, see Error Codes.

last updated: 2024-12-10 15:07 UTC - commit: cf50b08f82e58871085516460cdd259d578714fa