Description
You can call this operation to query the description information of the OBProxy parameters.
Call description
Prerequisite
You have passed the authentication for the OCP application service.
Request path
GET /api/v2/obproxy/parameterInfo
Request parameters
Parameter |
Type |
Required |
Example value |
Description |
|---|---|---|---|---|
| name | String | No | rootservice_list | The name of the parameter. |
| version | String | No | 1.9.1 | The version of the OBProxy. |
Response parameters
Basic data structure
Parameter |
Type |
Description |
|---|---|---|
| data | Array | The ParameterInfo array. |
| successful | Boolean | Indicates whether the request was successful. |
| timestamp | Datetime | The timestamp when the server completed the request. |
| duration | Integer | The time taken by the server to process the request, in milliseconds. |
| status | Integer | An HTTP status code. |
| traceId | String | The trace ID of the request. This trace ID is used for troubleshooting. |
| server | String | The address of the application server that responded to the request. |
Data structure of ParameterInfo
Parameter |
Type |
Description |
|---|---|---|
| id | Long | The ID of the parameter. |
| name | String | The name of the parameter. |
| version | String | The version information. |
| type | String | The type of the parameter. Valid values: * BOOL * CAPACITY * DOUBLE * INT * MOMENT * STRING * STRING_LIST * TIME |
| allowedStringValues | String | The allowed values of the parameter. |
| maxValue | String | The maximum value of the parameter. |
| minValue | String | The minimum value of the parameter. |
| defaultValue | String | The default value of the parameter. |
| needRestart | Bool | Indicates whether a restart was required. |
| readonly | Bool | Indicates whether the parameter was read-only. |
| description | String | The description of the parameter. |
| explanation | String | The explanation of the parameter. |
Examples
Sample request
GET /api/v2/obproxy/parameterInfo
Sample response
{
"data": {
"contents": [{
"allowedStringValues": "[0,100]",
"defaultValue": "10",
"description": "the num of create conn cont, [0, 1000]",
"explanation": null,
"id": 196,
"maxValue": "100",
"minValue": "0",
"name": "create_conn_cont_num",
"needRestart": false,
"readonly": false,
"type": "INT",
"version": "2.1.0"
}, {
"allowedStringValues": "[0,1000000]",
"defaultValue": "100000",
"description": "the num of conn in pending list, [0, 100000]",
"explanation": null,
"id": 197,
"maxValue": "1000000",
"minValue": "0",
"name": "max_pending_num",
"needRestart": false,
"readonly": false,
"type": "INT",
"version": "2.1.0"
}, {
"allowedStringValues": "[0s,1d]",
"defaultValue": "5ms",
"description": "session_pool_cont_delay_interval, [0s, 1d]",
"explanation": null,
"id": 198,
"maxValue": "1d",
"minValue": "0s",
"name": "session_pool_cont_delay_interval",
"needRestart": false,
"readonly": false,
"type": "TIME",
"version": "2.1.0"
}, {
"allowedStringValues": "[]",
"defaultValue": "false",
"description": "if enabled means use_local_session prop",
"explanation": null,
"id": 199,
"maxValue": "true",
"minValue": "false",
"name": "use_local_session_prop",
"needRestart": false,
"readonly": false,
"type": "BOOL",
"version": "2.1.0"
}, {
"allowedStringValues": "[0,10000]",
"defaultValue": "0",
"description": "the num of min conn , [0, 100000]",
"explanation": null,
"id": 200,
"maxValue": "10000",
"minValue": "0",
"name": "session_pool_default_min_conn",
"needRestart": false,
"readonly": false,
"type": "INT",
"version": "2.1.0"
}, {
"allowedStringValues": "[0,100000]",
"defaultValue": "20",
"description": "the num of max conn , [0, 100000]",
"explanation": null,
"id": 201,
"maxValue": "100000",
"minValue": "0",
"name": "session_pool_default_max_conn",
"needRestart": false,
"readonly": false,
"type": "INT",
"version": "2.1.0"
}, {
"allowedStringValues": "[0s,1d]",
"defaultValue": "1800s",
"description": "session_pool_default_idle_timeout, [0s, 1d]",
"explanation": null,
"id": 202,
"maxValue": "1d",
"minValue": "0s",
"name": "session_pool_default_idle_timeout",
"needRestart": false,
"readonly": false,
"type": "TIME",
"version": "2.1.0"
}, {
"allowedStringValues": "[0ms,2s]",
"defaultValue": "500ms",
"description": "session_pool_default_blocking_timeout, [0ms, 2s]",
"explanation": null,
"id": 203,
"maxValue": "2s",
"minValue": "0ms",
"name": "session_pool_default_blocking_timeout",
"needRestart": false,
"readonly": false,
"type": "TIME",
"version": "2.1.0"
}, {
"allowedStringValues": "[]",
"defaultValue": "false",
"description": "session_pool_default_prefill",
"explanation": null,
"id": 204,
"maxValue": "true",
"minValue": "false",
"name": "session_pool_default_prefill",
"needRestart": false,
"readonly": false,
"type": "BOOL",
"version": "2.1.0"
}, {
"allowedStringValues": "[]",
"defaultValue": "true",
"description": "if enabled means use beyond trust",
"explanation": null,
"id": 205,
"maxValue": "true",
"minValue": "false",
"name": "enable_beyond_trust",
"needRestart": false,
"readonly": false,
"type": "BOOL",
"version": "2.1.0"
}]
},
"duration": 9,
"server": "a83ad33525",
"status": 200,
"successful": true,
"timestamp": "2021-09-03T17:11:46.53+08:00",
"traceId": "ad3d6adcb291445f"
}