查询GaussDB实例参数 - GetGaussDBInstanceConfigurations

功能介绍

查询GaussDB实例参数。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
das:clouddba:read
read
instance
-
-
-

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
das:clouddba:read	read	instance	-	-	-

URI

GET /v3/{project_id}/get-gauss-db-instance-configurations

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	参数解释：租户在某一Region下的项目ID。获取方法请参见获取项目ID。约束限制：不涉及。取值范围：只能由英文字母、数字组成，且长度为32个字符。默认取值：不涉及。

请求参数

表2 请求Body参数
参数	是否必选	参数类型	描述
instance_id	是	String	参数解释：实例ID。标识实例的唯一标识。约束限制：不涉及。取值范围：只能由英文字母、数字组成，且长度为32个字符。默认取值：不涉及。

响应参数

状态码： 200

表3 响应Body参数
参数	参数类型	描述
List	Array of 表4 objects	参数解释： GaussDB实例参数列表。取值范围：数组长度：0 - 200

表4 ParameterValuesInfo
参数	参数类型	描述
name	String	参数解释：参数名称。取值范围：不涉及。
value	String	参数解释：参数值。取值范围：不涉及。
restart_required	Boolean	参数解释：是否需要重启。取值范围：不涉及。
readonly	Boolean	参数解释：是否只读。取值范围：不涉及。
type	String	参数解释：字段类型。取值范围：不涉及。
description	String	参数解释：字段描述。取值范围：不涉及。

请求示例

GET https://das.cn-north-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/get-gauss-db-instance-configurations?instance_id=833c8967d3d04d5ca611994f18d3ebc9in07

响应示例

状态码： 200

Success.

[
    {
        "name": "character_set_server",
        "value": "utf8",
        "restartRequired": true,
        "readonly": false,
        "type": "string",
        "description": "The server's default character set."
    },
    {
        "name": "collation_server",
        "value": "utf8_general_ci",
        "restartRequired": true,
        "readonly": false,
        "type": "string",
        "description": "Specifies the collation for the character set of the server. The collation must match the character set specified by character_set_server. Otherwise, the database cannot be started or restarted."
    }
]