Description
You can call this operation to query parameters of an OBProxy cluster.
Call description
Prerequisite
You have passed the authentication for the OCP application service.
Request path
GET /api/v2/obproxy/clusters/{id}/parameters
Request parameters
| Parameter | Type | Required | Example value | Description |
|---|---|---|---|---|
| id | Long | Yes | 1 | The ID of the OBProxy cluster. |
Response parameters
Basic data structure
| Parameter | Type | Description |
|---|---|---|
| data | Array | The ObproxyClusterParameter 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 ObproxyClusterParameter
| Parameter | Type | Description |
|---|---|---|
| name | String | The name of the parameter. |
| description | String | The description of the parameter. |
| needReboot | Bool | Indicates whether a cluster restart was required. |
| values | Array | The ObproxyParameterValue array. |
Data structure of ObproxyParameterValue
| Parameter | Type | Description |
|---|---|---|
| value | String | The value of the parameter. |
| obproxies | Array | The list of OBProxies. |
Examples
Sample request
GET /api/v2/obproxy/clusters/3/parameters
Sample response
{
"data": {
"contents": [{
"description": "proxy info check task interval, [1s, 1h]",
"name": "proxy_info_check_interval",
"needReboot": false,
"valueString": "60s",
"values": [{
"obproxies": ["xxx.xxx.xxx.xxx"],
"value": "60s"
}]
}, {
"description": "specifies the current level of logging: DEBUG, TRACE, INFO, WARN, USER_ERR, ERROR",
"name": "monitor_log_level",
"needReboot": false,
"valueString": "INFO",
"values": [{
"obproxies": ["xxx.xxx.xxx.xxx"],
"value": "INFO"
}]
}, {
"description": "sock param, packet mark out, [0, 1]",
"name": "sock_packet_mark_out",
"needReboot": false,
"valueString": "0",
"values": [{
"obproxies": ["xxx.xxx.xxx.xxx"],
"value": "0"
}]
}, {
"description": "enable net and route prometheus merics or not",
"name": "enable_extra_prometheus_metric",
"needReboot": false,
"valueString": "False",
"values": [{
"obproxies": ["xxx.xxx.xxx.xxx"],
"value": "False"
}]
}, {
"description": "epoll_wait timeout for net events, [0, +∞], if set a value <= 0, proxy treat it as 0",
"name": "net_config_poll_timeout",
"needReboot": false,
"valueString": "1ms",
"values": [{
"obproxies": ["xxx.xxx.xxx.xxx"],
"value": "1ms"
}]
}, {
"description": "meta table username, format'user@tenant#cluster'",
"name": "json_config_meta_table_user",
"needReboot": true,
"valueString": "",
"values": [{
"obproxies": ["xxx.xxx.xxx.xxx"],
"value": ""
}]
}, {
"description": "net accept threads num, [0, 8]",
"name": "net_accept_threads",
"needReboot": true,
"valueString": "2",
"values": [{
"obproxies": ["xxx.xxx.xxx.xxx"],
"value": "2"
}]
}, {
"description": "default hot upgrade failure retries, proxy will stop handle hot_upgrade command after such retries, [1, 20]",
"name": "hot_upgrade_failure_retries",
"needReboot": false,
"valueString": "5",
"values": [{
"obproxies": ["xxx.xxx.xxx.xxx"],
"value": "5"
}]
}, {
"description": "if client connections reach throttle, true is that new connection will be accepted, and eliminate lru client connection, false is that new connection will disconnect, and err packet will be returned",
"name": "enable_client_connection_lru_disconnect",
"needReboot": false,
"valueString": "False",
"values": [{
"obproxies": ["xxx.xxx.xxx.xxx"],
"value": "False"
}]
}, {
"description": "tcp keepalive idle time, unit is second, 0 means use default value by kernel",
"name": "server_tcp_keepidle",
"needReboot": false,
"valueString": "0",
"values": [{
"obproxies": ["xxx.xxx.xxx.xxx"],
"value": "0"
}]
}]
},
"duration": 21,
"server": "a83ad33525",
"status": 200,
"successful": true,
"timestamp": "2021-09-03T17:45:34.409+08:00",
"traceId": "1e538d4c421a4483"
}
