获取指定参数模板的参数 - ObtainingParametersofaSpecifiedParameterTemplate
功能介绍
获取指定参数模板的详细信息。
接口约束
- GeminiDB Cassandra
- GeminiDB Mongo
- GeminiDB Influx经典部署模式实例
- GeminiDB Redis经典部署模式实例
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
gaussdbfornosql:configuration:get
Read
-
-
nosql:param:list
-
URI
GET /v3/{project_id}/configurations/{config_id}
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
project_id | 是 | String | 参数解释: 租户在某一region下的project ID。获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
config_id | 是 | String | 参数解释: 参数模板ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
X-Auth-Token | 是 | String | 参数解释: 用户Token。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码: 200
参数 | 参数类型 | 描述 |
|---|---|---|
id | String | 参数解释: 参数模板ID。 取值范围: 不涉及。 |
name | String | 参数解释: 参数模板名称。 取值范围: 不涉及。 |
description | String | 参数解释: 参数模板描述。 取值范围: 不涉及。 |
datastore_version_name | String | 参数解释: 数据库版本名称。 取值范围: 不涉及。 |
datastore_name | String | 参数解释: 数据库名称。 取值范围: 不涉及。 |
mode | String | 参数解释: 数据库实例类型。 取值范围: GeminiDB Cassandra经典部署模式实例为"Cluster"。 GeminiDB Cassandra云原生部署模式实例为"CloudNativeCluster"。 GeminiDB Mongo副本集类型为"ReplicaSet"。 GeminiDB Mongo集群类型为"Sharding"。 GeminiDB Influx经典部署模式实例为"Cluster"。 GeminiDB Redis经典部署模式实例为“Cluster”。 |
created | String | 参数解释: 创建时间。 取值范围: 格式为"yyyy-MM-ddTHH:mm:ssZ"。 其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。 |
updated | String | 参数解释: 更新时间。 取值范围: 格式为"yyyy-MM-ddTHH:mm:ssZ"。 其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。 |
configuration_parameters | Array of ConfigurationParameterResult objects | 参数解释: 参数对象,用户基于默认参数模板自定义的参数配置。 取值范围: 不涉及。 |
参数 | 参数类型 | 描述 |
|---|---|---|
name | String | 参数解释: 参数名称。 取值范围: 不涉及。 |
value | String | 参数解释: 参数值。 取值范围: 不涉及。 |
restart_required | Boolean | 参数解释: 是否需要重启。 取值范围:
|
readonly | Boolean | 参数解释: 是否只读。 取值范围:
|
value_range | String | 参数解释: 参数值范围。 取值范围: 示例:
|
type | String | 参数解释: 参数类型。 取值范围: 取值为“string”、“integer”、“boolean”、“list”或“float”。 |
description | String | 参数解释: 参数描述。 取值范围: 不涉及。 |
请求示例
GET https://gaussdb-nosql.cn-north-4.myhuaweicloud.com/v3/375d8d8fad1f43039e23d3b6c0f60a19/configurations/e02e76567ae04662a2753492b77f965bpr06
响应示例
状态码: 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."
} ]
} 状态码
请参见状态码。
错误码
请参见错误码。

