文档首页/ 云数据库 GaussDB/ API参考/ API（推荐）/ 参数配置/ 查询参数模板详情
更新时间：2025-08-11 GMT+08:00
查看PDF
分享

查询参数模板详情

功能介绍

查询参数模板详情，根据参数模板ID获取指定参数模板详情。

URI

GET /v3.1/{project_id}/configurations/{config_id}

表1 参数说明

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

租户在某一Region下的项目ID。

获取方法请参见获取项目ID。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，且长度为32个字符。

默认取值：

不涉及。

config_id

是

String

参数解释：

参数模板ID。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，且长度为36个字符。

默认取值：

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。

通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

X-Language

否

String

参数解释：

语言。

约束限制：

不涉及。

取值范围：

  • zh-cn
  • en-us

默认取值：

en-us

响应参数

表3 参数说明

参数

参数类型

描述

id

String

参数解释：

参数模板ID。

取值范围：

不涉及。

name

String

参数解释：

参数模板名称。

取值范围：

不涉及。

description

String

参数解释：

参数模板描述。

取值范围：

不涉及。

engine_version

String

参数解释：

引擎版本。

取值范围：

不涉及。

instance_mode

String

参数解释：

部署形态。

取值范围：

  • ha：集中式版
  • independent：独立部署

created_at

String

参数解释：

创建时间，格式为“yyyy-mm-ddThh:mm:ssZ”。

其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。

取值范围：

不涉及。

updated_at

String

参数解释：

修改时间，格式为“yyyy-mm-ddThh:mm:ssZ”。

其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。

取值范围：

不涉及。

configuration_parameters

Array of objects

参数解释：

参数详情，具体请参考 表configuration_parameters字段数据结构说明。
表4 configuration_parameters字段数据结构说明

参数

参数类型

描述

name

String

参数解释：

特定参数名称。

取值范围：

不涉及。

value

String

参数解释：

特定参数值。

取值范围：

不涉及。

need_restart

Boolean

参数解释：

参数是否需要重启。

取值范围：

  • true：需要重启。
  • false：不需要重启。

readonly

Boolean

参数解释：

该参数是否只读。

取值范围：

  • true：只读
  • false：可编辑

value_range

String

参数解释：

参数取值范围。

取值范围：

不涉及。

data_type

String

参数解释：

参数类型。

取值范围：

取值为“string”、“integer”、“boolean”、“list”、"all"或“float”之一。

description

String

参数解释：

参数描述。

取值范围：

不涉及。

请求示例

查询参数模板详情。

GET https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3.1/619d3e78f61b4be68bc5aa0b59edcf7b/configurations/3ca44134a16d4bbab8eb701e025b19f7pr14

响应示例

查询参数模板详情成功。

{
         "id": "3ca44134a16d4bbab8eb701e025b19f7pr14",
         "name": "GaussDB_2b87a799-515",
         "description": "ParamGroup for instance.",
          "engine_version": "V2.0-2.3",
          "instance_mode": "ha",
          "created_at": "2022-08-05T08:15:07+0800",
          "updated_at": "2022-08-09T03:06:52+0800",
          "configuration_parameters": [
                {
                     "name": "audit_system_object",
                     "value": "12294",
                     "need_restart": false,
                     "readonly": false,
                     "value_range": "1-65536",
                     "data_type": "integer",
                     "description": "该参数决定是否对GaussDB Kernel数据库对象的CREATE、DROP、ALTER操作进行审计。GaussDB Kernel数据库对象包括DATABASE、USER、schema、TABLE等。通过修改该配置参数的值，可以只审计需要的数据库对象的操作，在主备强制选主场景建议audit_system_object取最大值，所有DDL对象全部审计，不当修改该参数会导致丢失DDL审计日志，请在客服人员指导下进行修改。"
                  }
           ]
}

状态码

错误码

请参见错误码。

父主题： 参数配置