Help Center/ GeminiDB/ API Reference/ APIs v3 (Recommended)/ Parameter Templates/ Modifying Parameters in a Parameter Template
Updated on 2024-10-31 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 types of instances:
  • GeminiDB Cassandra
  • GeminiDB Mongo
  • GeminiDB Influx

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

config_id

Yes

String

Parameter template 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

name

No

String

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

description

No

String

Parameter template description. The value is left blank by default. It contains a maximum of 256 characters except the following special characters: !<>=&"'

values

No

Map<String,String>

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

Response Parameters

Status code: 200

No response parameters

Example Requests

  • 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 Responses

None

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.

Parent topic: Parameter Templates