Querying Instance Parameter Settings
Function
This API is used to query instance parameter settings.
Constraints
- GeminiDB Cassandra
- GeminiDB Mongo
- GeminiDB Influx instances with classic storage
- GeminiDB Redis instances 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:instance:getConfiguration
Read
instance *
- g:ResourceTag/<tag-key>
- g:EnterpriseProjectId
nosql:param:list
-
URI
GET /v3/{project_id}/instances/{instance_id}/configurations
| 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 |
| instance_id | Yes | String | Definition Instance ID. To obtain the value, call the Querying Instances and Details API. If no instance is available, call the Creating an Instance API to create one. Constraints N/A Range N/A Default Value N/A |
Request 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
| Parameter | Type | Description |
|---|---|---|
| datastore_version_name | String | Definition Database version name. Range N/A |
| datastore_name | String | Definition Database name. Range N/A |
| 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 |
| id | String | Definition Parameter template ID. Range N/A |
| mode | String | Definition Instance type Range
|
| configuration_parameters | Array of ConfigurationParameterResult objects | Definition Parameters defined by users based on a default parameter template. |
| Parameter | Type | Description |
|---|---|---|
| name | String | Definition Parameter name. Range N/A |
| value | String | Definition Parameter value. Range N/A |
| restart_required | Boolean | Definition Whether a reboot is required. Range
|
| readonly | Boolean | Definition Whether the parameter is read-only. Range
|
| value_range | String | Definition Value range. For example, the value of the Integer type ranges from 0 to 1, and the value of the Boolean type is true or false. Range N/A |
| type | String | Definition Parameter type. Range
|
| description | String | Definition Parameter description. Range N/A |
Example Requests
GET https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in02/configurations Example Responses
Status code: 200
Success
{
"datastore_version_name" : "3.11",
"datastore_name" : "cassandra",
"created" : "2020-03-21 11:40:44",
"updated" : "2020-03-21 11:40:44",
"id": "9ad6bc82146e4043a50c963ab3bf09adpr06",
"mode": "Cluster",
"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.
What is your overall rating for this page?
Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot