获取指定实例的参数（v3）
功能介绍
获取指定实例的参数模板。
调试
您可以在API Explorer中调试该接口。
URI
GET https://{
Endpoint
}/v3/{project_id}/instances/{instance_id}/configurations
表1 参数说明
参数
是否必选
参数类型
描述
project_id
是
String
参数解释：
租户在某一Region下的项目ID。
获取方法请参见获取项目ID。
约束限制：
不涉及。
取值范围：
只能由英文字母、数字组成，且长度为32个字符。
默认取值：
不涉及。
instance_id
是
String
参数解释：
实例ID。
约束限制：
不涉及。
取值范围：
只能由英文字母、数字组成，且长度为32个字符。
默认取值：
不涉及。
请求参数
无。
响应参数
表2 响应参数
参数
参数类型
描述
datastore_version
String
参数解释**：**
引擎版本。
取值范围**：**
不涉及。
datastore_name
String
参数解释**：**
引擎名称。
取值范围**：**
不涉及。
created
String
参数解释**：**
创建时间，格式为"yyyy-MM-dd HH:mm:ss"。例如：2024-05-14 07:31:11。
取值范围**：**
不涉及。
updated
String
参数解释**：**
更新时间，格式为"yyyy-MM-ddHH:mm:ss"。例如：2024-05-14 07:31:11。
取值范围**：**
不涉及。
configuration_parameters
Array of objects
参数解释**：**
参数对象，用户基于默认参数模板自定义的参数配置，具体请参考表3。
表3 configuration_parameters字段数据结构说明
参数
参数类型
描述
name
String
参数解释**：**
参数名称。
取值范围**：**
不涉及。
value
String
参数解释**：**
参数值。
取值范围**：**
不涉及。
restart_required
Boolean
参数解释**：**
修改该参数是否需要重启实例。
取值范围**：**
- true，需要重启。
- false，不需要重启。
value_range
String
参数解释**：**
参数取值范围。
取值范围**：**
不涉及。
type
String
参数解释**：**
参数类型。
取值范围**：**
- string
- integer
- boolean
- list
- float
description
String
参数解释**：**
参数描述。
取值范围**：**
不涉及。
请求示例
https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3/054b61972980d4552f0bc00ac8d3f5cd/instances/dsfae23fsfdsae3435in14/configurations
响应示例
{
"created": "2022-04-11 10:46:59",
"updated": "2022-04-11 10:46:59",
"datastore_version": "2.0",
"datastore_name": "GaussDB",
"configuration_parameters": [
{
"name": "audit_system_object",
"value": "12295",
"type": "integer",
"description": "该参数决定是否对数据库对象的CREATE、DROP、ALTER操作进行审计。",
"restart_required": false,
"value_range": "0-2097151"
}
]
}
状态码
-
正常
200
-
异常
请参见状态码。
错误码
请参见错误码。
