文档首页/ 云数据库 GeminiDB/ API参考/ API v3（推荐）/ 参数模板管理/ 查询实例参数配置
更新时间：2023-11-21 GMT+08:00
查看PDF
分享

查询实例参数配置

功能介绍

查询实例参数配置信息。

接口约束

该接口支持如下数据库实例：
  • GeminiDB Cassandra
  • GeminiDB Mongo
  • GeminiDB Influx

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/configurations

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一region下的project ID。获取方法请参见获取项目ID。

instance_id

是

String

实例ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

响应参数

状态码： 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 Mongo副本集类型为"ReplicaSet"。

GeminiDB Mongo集群类型为"Sharding"。

GeminiDB Influx集群类型为"Cluster"。

GeminiDB Influx单节点类型为"InfluxdbSingle"。

configuration_parameters

Array of ConfigurationParameterResult objects

参数对象，用户基于默认参数模板自定义的参数配置。
表4 ConfigurationParameterResult

参数

参数类型

描述

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://gaussdb-nosql.cn-north-4.myhuaweicloud.com/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."
  } ]
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 参数模板管理

相关文档