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

Replicating a Parameter Template

Function

This API is used to replicate a parameter template.

Constraints

This API supports the following instances:

  • GeminiDB Cassandra
  • GeminiDB Mongo
  • GeminiDB Influx instance with classic storage
  • GeminiDB Redis instance with classic storage

The parameter template generated after replication cannot have the same name as the default parameter template or an existing template.

Only custom parameter templates can be replicated.

Authorization Information

Each account has permissions to call all APIs, but IAM users must have the required permissions specifically assigned.

  • If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    gaussdbfornosql:configuration:copy

    Write

    -

    -

    nosql:param:create

    -

URI

POST /v3/{project_id}/configurations/{config_id}/copy

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

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

Constraints

N/A

Range

N/A

Default Value

N/A

config_id

Yes

String

Definition

Parameter template ID.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token

Constraints

N/A

Range

N/A

Default Value

N/A
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

name

Yes

String

Definition

Name of a parameter template generated after replication

Constraints

N/A

Range

The name can contain a maximum of 64 characters and can contain only uppercase letters, lowercase letters, digits, hyphens (-), underscores (_), and periods (.).

Default Value

N/A

description

No

String

Definition

Parameter template description

Constraints

N/A

Range

The description can contain a maximum of 256 characters except special characters >!<"&'= The value is left blank by default.

Default Value

N/A

Response Parameters

Status code: 202

Table 4 Response body parameters

Parameter

Type

Description

config_id

String

Definition

ID of the replicated parameter template.

Range

N/A

Example Requests

  • URI example 
    POST https://gaussdb-nosql.ap-southeast-1.myhuaweicloud.com/v3/375d8d8fad1f43039e23d3b6c0f60a19/configurations/e02e76567ae04662a2753492b77f965bpr06/copy
  • Replicating a Parameter Template 
    {  
  "name" : "paramsGroup-2434",  
  "description" : "Replicating a parameter template"
}

Example Responses

Status code: 202

Accepted

{ 
  "config_id" : "7b4e07852bd54016906e89461b3182cdpr06" 
}

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.

Parent topic: Parameter Configuration