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 instance types:

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

URI

GET https://{Endpoint}/v3/{project_id}/configurations/{config_id}

**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 Constraints: N/A Values: N/A Default value: N/A

Response Parameters

Status code: 200

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

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

Example Request

URI example

GET https://gaussdb-nosql.ap-southeast-1.myhuaweicloud.com/v3/375d8d8fad1f43039e23d3b6c0f60a19/configurations/e02e76567ae04662a2753492b77f965bpr06

Example Response

Status code: 200

Success

{
  "id" : "07fc12a8e0e94df7a3fcf53d0b5e1605pr06",
  "name" : "default-cassandra-3.11",
  "datastore_version_name" : "3.11",
  "datastore_name" : "cassandra",
  "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."
  } ]
}