获取参数模板详细信息
更新时间 2025-09-16 11:39:11
最近更新时间: 2025-09-16 11:39:11
接口功能介绍
获取参数模板详细信息
接口约束
无
URI
GET /RDS2/v1/open-api/parameter/parameter-templates
路径参数 无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
pageNow | 否 | Integer | 当前页 | 1 | |
pageSize | 否 | Integer | 页大小 | 10 | |
id | 是 | Integer | 模版ID | 1 | |
parameterName | 否 | String | 参数名 | back_log |
请求参数
请求头header参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
project-id | 否 | String | 项目id | b829cb71308746a094853c21d5aac0a1 | |
regionId | 是 | String | 资源区regionId,比如实例在资源区A,则需要填写A资源区的regionId | 81f7728662dd11ec810800155d307d5b |
请求体body参数 无
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回码 取值范围:0 成功; 2001 参数异常;3001 业务异常;5001 请求响应失败 | 0 | |
returnObj | Object | 返回对象 | returnObj | |
message | String | 结果信息 | success | |
error | String | 错误码。当接口失败时才返回具体错误编码,成功不返回或者为空 | MYSQL_10001 | |
表 returnObj |
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
endRow | Integer | 终行 | 2 | |
firstPage | Integer | 第一页 | 1 | |
hasNextPage | Boolean | 是否有后一页 | false | |
hasPreviousPage | Boolean | 是否有前一页 | false | |
isFirstPage | Boolean | 是否第一页 | true | |
isLastPage | Boolean | 是否最后一页 | true | |
lastPage | Integer | 最后一页 | 1 | |
navigatepageNums | Array of Integers | 页码 | [1] | 1 |
nextPage | Integer | 下一页 | 0 | |
pageNum | Integer | 页数 | 1 | |
pageSize | Integer | 页大小 | 10 | |
pages | Integer | 页 | 1 | |
prePage | Integer | 前一页 | 0 | |
size | Integer | 大小 | 2 | |
startRow | Integer | 开始行 | 1 | |
total | Integer | 总条数 | 2 | |
list | Array of Objects | 对象数组 | Object | |
表 Object |
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
parameterGroupName | String | 参数模版名字 | test | |
valuetype | String | 类型 | int | |
restart | String | 是否需要重启 | 1 | |
description | String | 描述 | MySQL能拥有的有效连接请求数,MySQL主线程在很短时间内收到大量连接请求时发挥生效。然后主线程花很短的一些时间检查连接并且启动一个新线程。该back_log值表示在MySQL暂时停止回答新要求之前的很短时间内,有多少请求可以堆叠。默认值大小根据系统配置决定 | |
descriptionEn | String | 英文描述 | The number of valid connection requests that MySQL can have. It takes effect when the MySQL main thread receives a large number of connection requests in a short period of time. The main thread then spends a short period of time checking the connection and starting a new thread. The back_log value indicates how many requests can stack up in a short period of time before MySQL temporarily stops answering new requests. The default size is determined by system configuration. | |
id | Integer | 编号 | 309 | |
parameterName | String | 参数名 | back_log | |
parameterValue | String | 参数值 | 650 | |
permitValue | String | 参数取值范围 | 1~100,000 | |
userId | Integer | 用户id | 1 | |
oldValue | String | 模板旧值(可忽略) | null |
枚举参数
无
请求示例
请求url
/RDS2/v1/open-api/parameter/parameter-templates?outerProdInstId=b829cb71308746a094853c21d5aac0a1
请求头header
无
请求体body
无
响应示例
{
"statusCode": 0,
"message": "success",
"returnObj": {
"endRow":2,
"firstPage":1,
"hasNextPage": false,
"hasPreviousPage": false,
"isFirstPage": true,
"isLastPage": true,
"lastPage": 1,
"list": [{
"parameterGroupName": "testych",
"valuetype": "int",
"restart": "1",
"description": "MySQL能拥有的有效连接请求数,MySQL主线程在很短时间内收到大量连接请求时发挥生效。然后主线程花很短的一些时间检查连接并且启动一个新线程。该back_log值表示在MySQL暂时停止回答新要求之前的很短时间内,有多少请求可以堆叠。默认值大小根据系统配置决定。",
"descriptionEn":"The number of valid connection requests that MySQL can have. It takes effect when the MySQL main thread receives a large number of connection requests in a short period of time. The main thread then spends a short period of time checking the connection and starting a new thread. The back_log value indicates how many requests can stack up in a short period of time before MySQL temporarily stops answering new requests. The default size is determined by system configuration.",
"id": 309,
"parameterName": "back_log",
"parameterValue": "650",
"permitValue": "1~100,000",
"userId": 1,
"oldValue": null
}],
"navigatepageNums": [1],
"nextPage": 0,
"pageNum": 1,
"pageSize":10,
"pages":1,
"prePage": 0,
"size": 2,
"startRow":1,
"total": 2
}
}
状态码
请参考 状态码
错误码
请参考 错误码