Help Center/ GeminiDB/ API Reference/ APIs v3 (Recommended)/ Parameter Configuration/ Modifying Parameters in a Parameter Template
Updated on 2025-09-04 GMT+08:00
View PDF
Share

Modifying Parameters in a Parameter Template

Function

This API is used to modify parameters in a specified parameter template, including parameter names, descriptions, and values.

Constraints

This API supports the following instance types:
  • GeminiDB Cassandra
  • GeminiDB Mongo
  • GeminiDB Influx instance with classic storage
  • GeminiDB Redis instance with classic storage

The modified parameter template name must be different from the name of any existing or default parameter template.

Default parameter templates cannot be modified.

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

URI

PUT https://{Endpoint}/v3/{project_id}/configurations/{config_id}

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Explanation:

Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.

Constraints:

N/A

Values:

N/A

Default value:

N/A

config_id

Yes

String

Explanation:

Parameter template ID.

Constraints:

N/A

Values:

N/A

Default value:

N/A

Request Parameters

Table 2 Request header parameter

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Explanation:

User token

Constraints:

N/A

Values:

N/A

Default value:

N/A
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

name

No

String

Explanation:

Parameter template name

Constraints:

It contains a maximum of 64 characters and can contain only letters, digits, hyphens (-), underscores (_), and periods (.).

Values:

N/A

Default value:

N/A

description

No

String

Explanation:

Parameter template description

Constraints:

It can contain a maximum of 256 characters except special characters >!<"&'=

Values:

N/A

Default value:

The value is left blank by default.

values

No

Map<String,String>

Explanation:

Parameter values defined by users based on a default parameter template. If this parameter is not specified, its value will not be changed.

Constraints:

N/A

Values:

N/A

Default value:

N/A

Response Parameters

Status code: 200

No response parameters

Example Request

  • URI example 
    PUT https://gaussdb-nosql.cn-north-4.myhuaweicloud.com/v3/375d8d8fad1f43039e23d3b6c0f60a19/configurations/e02e76567ae04662a2753492b77f965bpr06
  • URI example 
    PUT https://gaussdb-nosql.ap-southeast-1.myhuaweicloud.com/v3/375d8d8fad1f43039e23d3b6c0f60a19/configurations/e02e76567ae04662a2753492b77f965bpr06
  • Modifying Parameters in a Parameter Template

    At least one parameter in the request body must be specified. Otherwise, the request cannot be delivered.

    {
  "name" : "configuration_test",
  "description" : "configuration_test",
  "values" : {
    "concurrent_reads" : "64"
  }
}

Example Response

None

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.

Parent topic: Parameter Configuration