接口功能介绍
查询实例当前参数配置。
接口约束
无
URI
GET /v1/open-api/parameter/describe-parameters
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
outerProdInstId | 是 | String | 实例Id | 1 | |
pageNow | 否 | Integer | 当前页 | 1 | |
pageSize | 否 | Integer | 页大小 | 10 |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
statusCode | 是 | String | 返回码取 | 0 | |
returnObj | 否 | Object | 返回对象 | returnObj | |
message | 否 | 返回信息 | 结果信息 | success |
表 returnObj
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
endRow | 是 | Integer | 终行 | 2 | |
firstPage | 是 | Integer | 第一页 | true | |
hasNextPage | 是 | Boolean | 是否有后一页 | false | |
hasPreviousPage | 是 | Boolean | 是否有前一页 | false | |
isFirstPage | 是 | Boolean | 是否第一页 | true | |
isLastPage | 是 | Boolean | 是否最后一页 | true | |
lastPage | 是 | Integer | 最后一页 | 1 | |
navigatepageNums | 是 | Array of Integers | 页码 | [1] | |
navigateFirstPage | 是 | Integer | 导航条上的第一页 | 1 | |
navigateLastPage | 是 | Integer | 导航条上的最后一页 | 8 | |
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 | 对象数组 | T |
表T
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
parameterGroupName | 是 | String | 参数模版名字 | test | |
valuetype | 是 | String | 类型 | int | |
restart | 是 | String | 是否需要重启 | 1 | |
description | 是 | String | 描述 | auto_increment_increment和auto_increment_offset 用于master-to-master的复制,并可以用来控制AUTO_INCREMENT列的操作。 | |
prodInstId | 是 | Integer | Integer | 1 | |
id | 是 | Integer | Integer | 309 | |
parameterName | 是 | String | 参数名 | back_log | |
parameterValue | 是 | String | 参数值 | 650 | |
permitValue | 是 | String | 参数取值范围 | 1~100,000 | |
userId | 是 | Integer | 用户id | 1 |
请求示例
请求头header
无
请求体body
无
响应示例
{
"statusCode": 0,
"message": "success",
"returnObj": {
"navigatepageNums": [1, 2, 3, 4, 5, 6, 7, 8],
"startRow": 1,
"hasNextPage": true,
"prePage": 0,
"nextPage": 2,
"endRow": 10,
"pageSize": 10,
"list": [{
"parameterGroupName": "Default-MySQL-5.7",
"valuetype": "int",
"restart": "0",
"description": "auto_increment_increment和auto_increment_offset 用于master-to-master的复制,并可以用来控制AUTO_INCREMENT列的操作。",
"prodInstId": 433,
"id": 22362,
"parameterName": "auto_increment_increment",
"parameterValue": "1",
"permitValue": "1~65,535",
"userId": 3304
}, {
"parameterGroupName": "Default-MySQL-5.7",
"valuetype": "int",
"restart": "0",
"description": "auto_increment_increment和auto_increment_offse用于master-to-master的复制,并可以用来控制AUTO_INCREMENT列的操作。",
"prodInstId": 433,
"id": 22363,
"parameterName": "auto_increment_offset",
"parameterValue": "1",
"permitValue": "1~65,535",
"userId": 3304
}, {
"parameterGroupName": "Default-MySQL-5.7",
"valuetype": "string",
"restart": "0",
"description": "当此变量为ON(默认值)时,如果存储例程的创建者无法执行、修改或删除该例程,服务器自动为该创建者赋予EXECUTE和ALTER ROUTINE权限。",
"prodInstId": 433,
"id": 22364,
"parameterName": "automatic_sp_privileges",
"parameterValue": "ON",
"permitValue": "ON,OFF",
"userId": 3304
}, {
"parameterGroupName": "Default-MySQL-5.7",
"valuetype": "int",
"restart": "1",
"description": "MySQL能拥有的有效连接请求数,MySQL主线程在很短时间内收到大量连接请求时发挥生效。然后主线程花很短的一些时间检查连接并且启动一个新线程。该back_log值表示在MySQL暂时停止回答新要求之前的很短时间内,有多少请求可以堆叠。默认值大小根据系统配置决定。",
"prodInstId": 433,
"id": 22365,
"parameterName": "back_log",
"parameterValue": "650",
"permitValue": "1~65,535",
"userId": 3304
}, {
"parameterGroupName": "Default-MySQL-5.7",
"valuetype": "int",
"restart": "0",
"description": "在事务中,为二进制日志存储SQL语句的缓存容量。该参数必须设置为2的幂次方。",
"prodInstId": 433,
"id": 22366,
"parameterName": "binlog_cache_size",
"parameterValue": "32768",
"permitValue": "4,096~18,446,744,073,709,547,520",
"userId": 3304
}, {
"parameterGroupName": "Default-MySQL-5.7",
"valuetype": "string",
"restart": "1",
"description": "启动变量时,引起主服务器在二进制日志中写入的每个事件的校验和。",
"prodInstId": 433,
"id": 22367,
"parameterName": "binlog_checksum",
"parameterValue": "CRC32",
"permitValue": "NONE,CRC32",
"userId": 3304
}, {
"parameterGroupName": "Default-MySQL-5.7",
"valuetype": "string",
"restart": "0",
"description": "如果开启此变量(默认),按照事务被写入二进制日志的顺序提交事务。变量如果没有开启,事务以并行顺序提交。",
"prodInstId": 433,
"id": 22368,
"parameterName": "binlog_order_commits",
"parameterValue": "ON",
"permitValue": "ON,OFF",
"userId": 3304
}, {
"parameterGroupName": "Default-MySQL-5.7",
"valuetype": "string",
"restart": "0",
"description": "指定服务器日志在行级复制时对所有行还是最少行进行日志记录。",
"prodInstId": 433,
"id": 22369,
"parameterName": "binlog_row_image",
"parameterValue": "FULL",
"permitValue": "FULL,MINIMAL,NOBLOB",
"userId": 3304
}, {
"parameterGroupName": "Default-MySQL-5.7",
"valuetype": "string",
"restart": "0",
"description": "参数一旦启动,MySQL 5.6.2或以上版本服务器将信息写入日志事件,比如,将行日志查询写入其二进制日志。",
"prodInstId": 433,
"id": 22370,
"parameterName": "binlog_rows_query_log_events",
"parameterValue": "OFF",
"permitValue": "ON,OFF",
"userId": 3304
}, {
"parameterGroupName": "Default-MySQL-5.7",
"valuetype": "int",
"restart": "0",
"description": "此变量决定在事务中,二进制日志存储下发的非事务语句的缓存空间。该参数必须设置为2的幂次方。",
"prodInstId": 433,
"id": 22371,
"parameterName": "binlog_stmt_cache_size",
"parameterValue": "32768",
"permitValue": "4,096~18,446,744,073,709,547,520",
"userId": 3304
}],
"pageNum": 1,
"navigatePages": 8,
"navigateFirstPage": 1,
"total": 181,
"pages": 19,
"size": 10,
"isLastPage": false,
"hasPreviousPage": false,
"navigateLastPage": 8,
"isFirstPage": true
}
状态码
状态码 | 描述 |
---|---|
0 | 表示请求成功。 |
错误码
错误码 | 描述 |
---|---|
2001 | 参数异常,失败原因见message |
3001 | 业务异常,失败原因见message |
5001 | 请求响应失败, 失败原因见message |