# 查询实例参数配置 - QueryingInstanceParameterSettings #### 功能介绍 查询实例参数配置信息。 #### 接口约束 该接口支持如下数据库实例： - GeminiDB Cassandra - GeminiDB Mongo - GeminiDB Influx经典部署模式实例 - GeminiDB Redis经典部署模式实例 #### 调试 您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=GaussDBforNoSQL&api=ShowInstanceConfiguration)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-nosql/nosql_05_0023.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | gaussdbfornosql:instance:getConfiguration | Read | instance \* | - g:ResourceTag/\ - g:EnterpriseProjectId | nosql:param:list | - | #### URI GET /v3/{project_id}/instances/{instance_id}/configurations 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 租户在某一region下的project ID。获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-nosql/nosql_projectid.html)。 **约束限制：** 不涉及。 **取值范围：** 长度为32个字符，仅由英文字母和数字组成。 **默认取值：** 不涉及。 | | instance_id | 是 | String | **参数解释：** 实例ID。可以调用[查询实例列表和详情 - QueryingInstancesandDetails](https://support.huaweicloud.com/api-nosql/nosql_05_0016.html)接口获取。如果未申请实例，可以调用[创建实例 - CreatinganInstance](https://support.huaweicloud.com/api-nosql/nosql_05_0014.html)接口创建。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | #### 响应参数 **状态码： 200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | datastore_version_name | String | **参数解释：** 数据库版本名称。 **取值范围：** 不涉及。 | | datastore_name | String | **参数解释：** 数据库名称。 **取值范围：** 不涉及。 | | created | String | **参数解释：** 创建时间。格式为"yyyy-MM-ddTHH:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 **取值范围：** 不涉及。 | | updated | String | **参数解释：** 更新时间。格式为"yyyy-MM-ddTHH:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 **取值范围：** 不涉及。 | | id | String | **参数解释：** 参数模板ID。 **取值范围：** 不涉及。 | | mode | String | **参数解释：** 数据库实例类型。 **取值范围：** - GeminiDB Cassandra集群类型为"Cluster"。 - GeminiDB Cassandra经典部署模式实例为"Cluster"。 - GeminiDB Cassandra云原生部署模式实例为"CloudNativeCluster"。 - GeminiDB Mongo副本集类型为"ReplicaSet"。 - GeminiDB Mongo集群类型为"Sharding"。 - GeminiDB Influx经典部署模式实例为"Cluster"。 - GeminiDB Influx经典部署模式单节点类型为"InfluxdbSingle"。 - GeminiDB Redis经典部署模式实例为"Cluster"。 - GeminiDB Redis经典部署模式主备类型为"Replication"。 | | configuration_parameters | Array of [ConfigurationParameterResult] objects | **参数解释：** 参数对象，用户基于默认参数模板自定义的参数配置。 | 表4ConfigurationParameterResult | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | **参数解释：** 参数名称。 **取值范围：** 不涉及。 | | value | String | **参数解释：** 参数值。 **取值范围：** 不涉及。 | | restart_required | Boolean | **参数解释：** 是否需要重启。 **取值范围：** - false：不需要重启。 - true：需要重启。 | | readonly | Boolean | **参数解释：** 是否只读。 **取值范围：** - false：非只读参数。 - true：只读参数。 | | value_range | String | **参数解释：** 参数值范围。示例：Integer类型取值范围为0\~1、Boolean类型取值为"true"或"false"。 **取值范围：** 不涉及。 | | type | String | **参数解释：** 参数类型。 **取值范围：** - string：字符串类型。 - integer：整数类型。 - boolean：布尔类型。 - list：列表类型。 - float：浮点类型。 | | description | String | **参数解释：** 参数描述。 **取值范围：** 不涉及。 | #### 请求示例 URI样例 ``` GET https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in02/configurations ``` #### 响应示例 **状态码： 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." } ] } ``` #### 状态码 请参见[状态码](https://support.huaweicloud.com/api-nosql/nosql_status_code.html)。 #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-nosql/nosql_error_code.html)。