Help Center/ GeminiDB/ API Reference/ APIs v3.1 (Recommended)/ Parameter Configuration/ Applying a Parameter Template
Updated on 2025-09-16 GMT+08:00
View PDF
Share

Applying a Parameter Template

Function

This API is used to apply a parameter template to one or more instances.

Constraints

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

This API is an asynchronous API. A successful response does not indicate that the parameter template is successfully applied.

URI

PUT /v3.1/{project_id}/configurations/{config_id}/apply

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

To obtain this value, call the IAM API for obtaining a user token.

Constraints:

N/A

Values:

N/A

Default value:

N/A
Table 3 Request body parameter

Parameter

Mandatory

Type

Description

instance_ids

Yes

Array of strings

Explanation:

Instance IDs

Constraints:

N/A

Values:

N/A

Default value:

N/A

Response Parameters

Status code: 202

Table 4 Response body parameters

Parameter

Type

Description

job_id

String

Explanation:

ID of an asynchronous task for applying a parameter template

Values:

N/A

success

Boolean

Explanation:

Whether the task for applying the parameter template is successfully submitted

Values:

  • true: The task is submitted successfully.
  • false: The task fails to be submitted.

Example Request

  • URI example 
    PUT https://gaussdb-nosql.ap-southeast-1.myhuaweicloud.com/v3.1/375d8d8fad1f43039e23d3b6c0f60a19/configurations/e02e76567ae04662a2753492b77f965bpr06/apply
  • Applying a Parameter Template 
    {
  "instance_ids" : [ "73ea2bf70c73497f89ee0ad4ee008aa2in06" ]
}

Example Response

Status code: 202

Successful request

{
  "job_id" : "463b4b58-d0e8-4e2b-9560-5dea4552fde9",
  "success" : true
}

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.

Parent topic: Parameter Configuration