Files

Reviewed-by: Gladkov, Maksim <mgladkov@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-authored-by: wangdengke2 <wangdengke2@huawei.com>
Co-committed-by: wangdengke2 <wangdengke2@huawei.com>

2025-09-04 07:22:35 +00:00

11 KiB

Raw Blame History

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 can be used for GeminiDB Cassandra instances.

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	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 parameter
Parameter	Mandatory	Type	Description
Content-Type	Yes	String	MIME type of the request body. application/json is recommended.
X-Auth-Token	Yes	String	User token.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
name	No	String	Parameter template name. It can include a maximum of 64 characters and can contain only uppercase letters, lowercase letters, digits, hyphens (-), underscores (_), and periods (.).
description	No	String	Parameter template description. It can include a maximum of 256 characters and cannot contain the following special characters: >!<"&'= The value is left blank by default.
values	No	Map<String,String>	Parameter values defined by users based on a default parameter template. If this parameter is not specified, no parameter values are to be changed.

Response Parameters

Status code: 200

None

Example Request

URI example

PUT https://{Endpoint}/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"
  }
}
```