Updated on 2026-09-22 GMT+08:00

Obtaining Parameters of a Specified Parameter Template

Function

This API is used to obtain information about parameters of a specified 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

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:get

Read

-

-

nosql:param:list

-

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
gaussdbfornosql:configuration:get	Read	-	-	nosql:param:list	-

URI

GET /v3/{project_id}/configurations/{config_id}

**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 The value contains 32 characters. Only letters and digits are allowed. Default Value N/A
config_id	Yes	String	Definition Parameter template ID. To obtain the value, see Obtaining Parameter Templates. 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 You can obtain the token by calling the IAM API by following Obtaining a User Token Through Password Authentication. Constraints N/A Range N/A Default Value N/A

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
id	String	Definition Parameter template ID Range N/A
name	String	Definition Parameter template name Range N/A
description	String	Definition Parameter template description Range N/A
datastore_version_name	String	Definition Database version name. Range N/A
datastore_name	String	Definition Database name. Range N/A
mode	String	Definition DB instance type Range Cluster: GeminiDB Cassandra instance with classic storage CloudNativeCluster: GeminiDB Cassandra instance with cloud native storage ReplicaSet: GeminiDB Mongo instance in a replica set Sharding: sharded GeminiDB Mongo instance in a cluster Cluster: GeminiDB Influx instance with classic storage Cluster: GeminiDB Redis instance with classic storage
created	String	Definition Creation time. The format is yyyy-MM-ddTHH:mm:ssZ. T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. Range N/A
updated	String	Definition Update time. The format is yyyy-MM-ddTHH:mm:ssZ. T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. Range N/A
configuration_parameters	Array of ConfigurationParameterResult objects	Definition Parameters defined by users based on a default parameter template.

**Table 4** ConfigurationParameterResult
Parameter	Type	Description
name	String	Definition Parameter name Range N/A
value	String	Definition Parameter value Range N/A
restart_required	Boolean	Definition Whether an instance needs to be restarted Range false, indicating that the instance does not need to be restarted. true, indicating that the instance needs to be restarted.
readonly	Boolean	Definition Whether the parameter is read-only Range false, indicating that the parameter is not read-only. true, indicating that the parameter is read-only.
value_range	String	Definition Value range Range Example: Integer: 0 and 1 Boolean: true or false
type	String	Definition Parameter type Range string integer boolean list float: a floating-point number
description	String	Definition Parameter description Range N/A

Example Requests

URI example

GET https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/configurations/e02e76567ae04662a2753492b77f965bpr06

Example Responses

Status code: 200

Success

{
  "id" : "07fc12a8e0e94df7a3fcf53d0b5e1605pr06",
  "name" : "default-cassandra-3.11",
  "datastore_version_name" : "3.11",
  "datastore_name" : "cassandra",
  "mode": "Cluster",
  "description" : "Default parameter group for cassandra 3.11",
  "created" : "2020-03-21T04:40:51+0800",
  "updated" : "2020-03-21T04:40:51+0800",
  "configuration_parameters" : [ {
    "name" : "concurrent_reads",
    "value" : "64",
    "restart_required" : true,
    "readonly" : true,
    "value_range" : "4-512",
    "type" : "integer",
    "description" : "Number of concurrent read threads."
  } ]
}

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.

Parent topic: Parameter Configuration