59e615eb3c
The Resources document lists all currently known resources and will be converted to a list of separate resource documents once the individual resource documents are done. The Headers and Response Codes document contains a list of request and response headers and the HTTP return codes. This is a work in progress and will be expanded upon. Added initial versions of the filter, monitor, session and user resource documents. These provide information about various parts of MaxScale and allow interaction. All PATCH operations expect a JSON Patch type document in the request body. Examples modified accordingly. Add MaxScale resource document which describes the resources that give the global configuration options and show statistics. The resources that link to other resources provide values as a list of relative links. This reduces the amount of sent data when the client doesn't require all parts of the resource. Since the updating is not yet implement, it should be stated that the update API will most likely be modified at some point. The module resource is similar to `maxadmin show modules` and the log resource contains status information about logs. The log resource also has an "action" resource at `/maxscale/logs/flush` which flushes logs to disk and rotates them. Added start and stop entry points for services and monitors. Also added missing service parameters to the list of parameters that can be updated. The documentation lists listeners as a sub-resource of the service. This allows the listeners of a particular service to be queried.
217 lines
3.6 KiB
Markdown
217 lines
3.6 KiB
Markdown
# MaxScale Resource
|
|
|
|
The MaxScale resource represents a MaxScale instance and it is the core on top
|
|
of which the modules build upon.
|
|
|
|
## Resource Operations
|
|
|
|
## Get global information
|
|
|
|
Retrieve global information about a MaxScale instance. This includes various
|
|
file locations, configuration options and version information.
|
|
|
|
```
|
|
GET /maxscale
|
|
```
|
|
|
|
#### Response
|
|
|
|
```
|
|
Status: 200 OK
|
|
|
|
{
|
|
"config": "/etc/maxscale.cnf",
|
|
"cachedir": "/var/cache/maxscale/",
|
|
"datadir": "/var/lib/maxscale/"
|
|
"libdir": "/usr/lib64/maxscale/",
|
|
"piddir": "/var/run/maxscale/",
|
|
"execdir": "/usr/bin/",
|
|
"languagedir": "/var/lib/maxscale/",
|
|
"user": "maxscale",
|
|
"threads": 4,
|
|
"version": "2.1.0",
|
|
"commit": "12e7f17eb361e353f7ac413b8b4274badb41b559"
|
|
"started": "Wed, 31 Aug 2016 23:29:26 +0300"
|
|
}
|
|
```
|
|
|
|
#### Supported Request Parameter
|
|
|
|
- `fields`
|
|
|
|
## Get thread information
|
|
|
|
Get detailed information and statistics about the threads.
|
|
|
|
```
|
|
GET /maxscale/threads
|
|
```
|
|
|
|
#### Response
|
|
|
|
```
|
|
Status: 200 OK
|
|
|
|
{
|
|
"load_average": {
|
|
"historic": 1.05,
|
|
"current": 1.00,
|
|
"1min": 0.00,
|
|
"5min": 0.00,
|
|
"15min": 0.00
|
|
},
|
|
"threads": [
|
|
{
|
|
"id": 0,
|
|
"state": "processing",
|
|
"file_descriptors": 1,
|
|
"event": [
|
|
"in",
|
|
"out"
|
|
],
|
|
"run_time": 300
|
|
},
|
|
{
|
|
"id": 1,
|
|
"state": "polling",
|
|
"file_descriptors": 0,
|
|
"event": [],
|
|
"run_time": 0
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
#### Supported Request Parameter
|
|
|
|
- `fields`
|
|
|
|
## Get logging information
|
|
|
|
Get information about the current state of logging, enabled log files and the
|
|
location where the log files are stored.
|
|
|
|
```
|
|
GET /maxscale/logs
|
|
```
|
|
|
|
#### Response
|
|
|
|
```
|
|
Status: 200 OK
|
|
|
|
{
|
|
"logdir": "/var/log/maxscale/",
|
|
"maxlog": true,
|
|
"syslog": false,
|
|
"log_levels": {
|
|
"error": true,
|
|
"warning": true,
|
|
"notice": true,
|
|
"info": false,
|
|
"debug": false
|
|
},
|
|
"log_augmentation": {
|
|
"function": true
|
|
},
|
|
"log_throttling": {
|
|
"limit": 8,
|
|
"window": 2000,
|
|
"suppression": 10000
|
|
},
|
|
"last_flushed": "Wed, 31 Aug 2016 23:29:26 +0300"
|
|
}
|
|
```
|
|
|
|
#### Supported Request Parameter
|
|
|
|
- `fields`
|
|
|
|
## Flush and rotate log files
|
|
|
|
Flushes any pending messages to disk and reopens the log files. The body of the
|
|
message is ignored.
|
|
|
|
```
|
|
POST /maxscale/logs/flush
|
|
```
|
|
|
|
#### Response
|
|
|
|
```
|
|
Status: 204 No Content
|
|
```
|
|
|
|
## Get task schedule
|
|
|
|
Retrieve all pending tasks that are queued for execution.
|
|
|
|
```
|
|
GET /maxscale/tasks
|
|
```
|
|
|
|
#### Response
|
|
|
|
```
|
|
Status: 200 OK
|
|
|
|
[
|
|
{
|
|
"name": "Load Average",
|
|
"type": "repeated",
|
|
"frequency": 10,
|
|
"next_due": "Fri Sep 9 14:12:37 2016"
|
|
}
|
|
}
|
|
```
|
|
|
|
#### Supported Request Parameter
|
|
|
|
- `fields`
|
|
|
|
## Get loaded modules
|
|
|
|
Retrieve information about all loaded modules. This includes version, API and
|
|
maturity information.
|
|
|
|
```
|
|
GET /maxscale/modules
|
|
```
|
|
|
|
#### Response
|
|
|
|
```
|
|
Status: 200 OK
|
|
|
|
[
|
|
{
|
|
"name": "MySQLBackend",
|
|
"type": "Protocol",
|
|
"version": "V2.0.0",
|
|
"api_version": "1.1.0",
|
|
"maturity": "GA"
|
|
},
|
|
{
|
|
"name": "qlafilter",
|
|
"type": "Filter",
|
|
"version": "V1.1.1",
|
|
"api_version": "1.1.0",
|
|
"maturity": "GA"
|
|
},
|
|
{
|
|
"name": "readwritesplit",
|
|
"type": "Router",
|
|
"version": "V1.1.0",
|
|
"api_version": "1.0.0",
|
|
"maturity": "GA"
|
|
}
|
|
}
|
|
```
|
|
|
|
#### Supported Request Parameter
|
|
|
|
- `fields`
|
|
- `range`
|
|
|
|
TODO: Add epoll statistics and rest of the supported methods.
|