查询参数模板列表

更新时间：2023-09-22

查询参数模板列表

接口描述

本接口用于查询相应的参数模板列表

请求结构

GET /v{version}/gaiadb/paramTemplate/listParaTemplate?detail={detail}&type={type}&pageNo={pageNo}&pageSize={pageSize} HTTP/1.1
HOST: gaiadb.bj.baidubce.com
Authorization: authorization string

请求头域

除公共头域外，无其它特殊头域。

请求参数

参数名称	类型	是否必选	参数位置	描述
version	String	是	URL参数	API 版本号
detail	Integer	否	URL参数	一共两种取值0，1。为1返回模板下的参数列表，默认0
type	String	否	URL参数	过滤参数模板类型，取值为mysql或dbproxy
pageNo	Integer	否	URL参数	当前分页页码，默认1
pageSize	Integer	否	URL参数	当前分页每页条目数量，默认10

返回头域

除公共头域，无其它特殊头域。

返回参数

参数名称	类型	描述
paramAmount	Integer	模板包含的参数数量
type	String	模板类型，mysql或dbproxy
userId	String	用户ID
isReboot	Boolean	是否包含需要重启的参数，true表示包含，false表示不包含
createTime	String	模板创建时间
updateTime	String	模板最近一次更新的时间
description	String	模板描述
userName	String	用户名
status	String	模板状态，available为可用，deleted为已删除
isSystem	Boolean	是否为系统默认模板，true表示系统默认参数，false表示用户自定义参数
version	String	模板适用版本，mysql当前仅支持8.0，dbproxy仅支持1.0
uuid	String	模板唯一索引ID
name	String	模板名称
params	List<ParamsDetails>	模板参数详情

ParamsDetails

参数名称	类型	描述
status	String	模板状态，available为可用，deleted为已删除
updateTime	String	模板最近一次更新时间
modifiable	Boolean	是否允许修改，1表示可修改，0表示不可修改
bestValue	String	参数最优值
allowedValues	String	参数值允许范围
type	String	数值类型
name	String	参数名
value	String	参数默认值
isCluster	Boolean	是否为cluster级参数，true表示cluster级，false表示node级
createTime	String	参数创建时间
caseSensitive	Boolean	参数名是否大小写敏感，true表示敏感，false表示不敏感
solidifiedName	String	写入文件时参数名
description	String	参数描述
precision	Integer	参数值在为浮点型时的精确度
paramTemplateId	String	所属参数模板ID
attention	String	提示信息
dynamic	Boolean	是否可以热生效，true表示可热生效，false表示重启生效
id	Integer	参数唯一索引ID
allowEmpty	Boolean	是否允许值为空，true表示可为空，false表示不能为空

请求示例

PUT /v1/gaiadb/paramTemplate/listParaTemplate?detail=0&type=mysql HTTP/1.1
HOST: gaiadb.bj.baidubce.com
Content-Type: application/json
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2017-11-21T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

返回示例

HTTP/1.1 200 OK
x-bce-request-id: 7869616F-7A68-6977-656E-406261696475
Content-Type: application/json
{  
   "paramTemplates": [
    {
        "uuid": "xxxxxxx-fc2a-e562-89b0-xxxxxxx",
        "name": "导出集群模板",
        "type": "mysql",
        "version": "8.0",
        "description": "create cmp param template",
        "isReboot": true,
        "paramAmount": 57,
        "status": "available",
        "isSystem": false,
        "userId": "",
        "userName": "",
        "createTime": "2022-11-09 11:03:18",
        "updateTime": "2022-11-09 20:38:47"
    },
    {
        "uuid": "xxxxx-7743-c5f2-xxxx-xxxxxxxxx",
        "name": "导出集群模板",
        "type": "mysql",
        "version": "8.0",
        "description": "create cmp param template",
        "isReboot": true,
        "paramAmount": 59,
        "status": "available",
        "isSystem": false,
        "userId": "",
        "userName": "",
        "createTime": "2022-11-04 17:56:49",
        "updateTime": "2022-11-04 17:56:49"
    }
],
"pageNo": 1,
"pageSize": 10,
"totalCount": 2
}

参数管理

保存为参数模板

云原生数据库 GaiaDB

云原生数据库 GaiaDB

查询参数模板列表

查询参数模板列表