circle-info
Webinar | The Great Database Exodus: Navigating Strategic Risk in the Post-Oracle MySQL Era
Watch Nowarrow-up-right
search
Download MariaDBContact Us

MaxScale Service Resource

Configure routing services. This resource manages the core services that define how MaxScale routes and balances traffic between clients and backend servers.

hashtag
Overview

A service resource represents a service inside MaxScale. A service is a collection of network listeners, filters, a router and a set of backend servers.

hashtag
Resource Operations

The :name in all of the URIs must be the name of a service in MaxScale.

hashtag
Get a service

GET /v1/services/:name

Get a single service.

hashtag
Response

Status: 200 OK

{
    "data": {
        "attributes": {
            "connections": 0,
            "listeners": [
                {
                    "attributes": {
                        "module": "MariaDBProtocol",
                        "parameters": {
                            "MariaDBProtocol": {
                                "allow_replication": true,
                                "compression": "zlib,zstd",
                                "compression_threshold": 50
                            },
                            "address": "::",
                            "authenticator": null,
                            "authenticator_options": null,
                            "connection_init_sql_file": null,
                            "connection_metadata": [
                                "character_set_client=auto",
                                "character_set_connection=auto",
                                "character_set_results=auto",
                                "max_allowed_packet=auto",
                                "system_time_zone=auto",
                                "time_zone=auto",
                                "tx_isolation=auto",
                                "maxscale=auto"
                            ],
                            "port": 4008,
                            "protocol": "MariaDBProtocol",
                            "proxy_protocol_networks": null,
                            "redirect_url": null,
                            "service": "Read-Connection-Router",
                            "socket": null,
                            "sql_mode": "default",
                            "ssl": false,
                            "ssl_ca": null,
                            "ssl_cert": null,
                            "ssl_cert_verify_depth": 9,
                            "ssl_cipher": null,
                            "ssl_crl": null,
                            "ssl_key": null,
                            "ssl_passphrase": "",
                            "ssl_verify_peer_certificate": false,
                            "ssl_verify_peer_host": false,
                            "ssl_version": "MAX",
                            "type": "listener",
                            "user_mapping_file": null
                        },
                        "source": {
                            "file": "/etc/maxscale.cnf",
                            "type": "static"
                        },
                        "state": "Running"
                    },
                    "id": "Read-Connection-Listener",
                    "relationships": {
                        "services": {
                            "data": [
                                {
                                    "id": "Read-Connection-Router",
                                    "type": "services"
                                }
                            ],
                            "links": {
                                "related": "http://localhost:8989/v1/services/",
                                "self": "http://localhost:8989/v1/listeners/Read-Connection-Listener/relationships/services/"
                            }
                        }
                    },
                    "type": "listeners"
                }
            ],
            "module": "readconnroute",
            "parameters": {
                "auth_all_servers": false,
                "connection_keepalive": "300000ms",
                "disable_sescmd_history": false,
                "enable_root_user": false,
                "force_connection_keepalive": false,
                "idle_session_pool_time": "-1ms",
                "localhost_match_wildcard_host": true,
                "log_auth_warnings": true,
                "log_debug": false,
                "log_info": false,
                "log_notice": false,
                "log_warning": false,
                "master_accept_reads": true,
                "max_connections": 0,
                "max_replication_lag": "0ms",
                "max_sescmd_history": 50,
                "multiplex_timeout": "60000ms",
                "net_write_timeout": "0ms",
                "password": "*****",
                "prune_sescmd_history": true,
                "rank": "primary",
                "retain_last_statements": -1,
                "role": null,
                "router": "readconnroute",
                "router_options": "master",
                "strip_db_esc": true,
                "type": "service",
                "user": "maxuser",
                "user_accounts_file": null,
                "user_accounts_file_usage": "add_when_load_ok",
                "version_string": null,
                "wait_timeout": "28800000ms"
            },
            "router": "readconnroute",
            "source": {
                "file": "/etc/maxscale.cnf",
                "type": "static"
            },
            "started": "Fri, 25 Jul 2025 15:43:46 GMT",
            "state": "Started",
            "statistics": {
                "active_operations": 0,
                "avg_sescmd_history_length": 0.0,
                "avg_session_active_pct": 0.0,
                "avg_session_lifetime": 0.0,
                "avg_session_queries": 0.0,
                "connections": 0,
                "failed_auths": 0,
                "max_connections": 0,
                "max_sescmd_history_length": 0,
                "max_session_active_pct": 0.0,
                "max_session_lifetime": 0.0,
                "max_session_queries": 0,
                "routed_packets": 0,
                "routed_reads": 0,
                "routed_writes": 0,
                "total_connections": 0
            },
            "total_connections": 0,
            "users": [
                {
                    "default_role": "",
                    "global_priv": false,
                    "host": "127.0.0.1",
                    "plugins": [
                        {
                            "auth_string": "976B96FB3F7898CCFFCABC014300C311FB7607FD",
                            "plugin": "mysql_native_password"
                        }
                    ],
                    "proxy_priv": false,
                    "ssl": false,
                    "super_priv": false,
                    "user": "healthcheck"
                },
                {
                    "default_role": "",
                    "global_priv": false,
                    "host": "::1",
                    "plugins": [
                        {
                            "auth_string": "976B96FB3F7898CCFFCABC014300C311FB7607FD",
                            "plugin": "mysql_native_password"
                        }
                    ],
                    "proxy_priv": false,
                    "ssl": false,
                    "super_priv": false,
                    "user": "healthcheck"
                },
                {
                    "default_role": "",
                    "global_priv": false,
                    "host": "localhost",
                    "plugins": [
                        {
                            "auth_string": "976B96FB3F7898CCFFCABC014300C311FB7607FD",
                            "plugin": "mysql_native_password"
                        }
                    ],
                    "proxy_priv": false,
                    "ssl": false,
                    "super_priv": false,
                    "user": "healthcheck"
                },
                {
                    "default_role": "",
                    "global_priv": false,
                    "host": "localhost",
                    "plugins": [
                        {
                            "auth_string": "",
                            "plugin": "mysql_native_password"
                        }
                    ],
                    "proxy_priv": false,
                    "ssl": false,
                    "super_priv": false,
                    "user": "mariadb.sys"
                },
                {
                    "default_role": "",
                    "global_priv": true,
                    "host": "127.0.0.1",
                    "plugins": [
                        {
                            "auth_string": "5EDBD32E469DAE0CE10E6999C3899DEFCB9F12E0",
                            "plugin": "mysql_native_password"
                        }
                    ],
                    "proxy_priv": false,
                    "ssl": false,
                    "super_priv": true,
                    "user": "maxuser"
                },
                {
                    "default_role": "",
                    "global_priv": true,
                    "host": "%",
                    "plugins": [
                        {
                            "auth_string": "5EDBD32E469DAE0CE10E6999C3899DEFCB9F12E0",
                            "plugin": "mysql_native_password"
                        }
                    ],
                    "proxy_priv": false,
                    "ssl": false,
                    "super_priv": true,
                    "user": "maxuser"
                },
                {
                    "default_role": "",
                    "global_priv": true,
                    "host": "localhost",
                    "plugins": [
                        {
                            "auth_string": "",
                            "plugin": "mysql_native_password"
                        }
                    ],
                    "proxy_priv": false,
                    "ssl": false,
                    "super_priv": true,
                    "user": "root"
                },
                {
                    "default_role": "",
                    "global_priv": true,
                    "host": "%",
                    "plugins": [
                        {
                            "auth_string": "",
                            "plugin": "mysql_native_password"
                        }
                    ],
                    "proxy_priv": false,
                    "ssl": false,
                    "super_priv": true,
                    "user": "root"
                }
            ],
            "users_last_update": "Fri, 25 Jul 2025 15:43:49 GMT"
        },
        "id": "Read-Connection-Router",
        "links": {
            "self": "http://localhost:8989/v1/services/Read-Connection-Router/"
        },
        "relationships": {
            "filters": {
                "data": [
                    {
                        "id": "QLA",
                        "type": "filters"
                    },
                    {
                        "id": "Hint",
                        "type": "filters"
                    }
                ],
                "links": {
                    "related": "http://localhost:8989/v1/filters/",
                    "self": "http://localhost:8989/v1/services/Read-Connection-Router/relationships/filters/"
                }
            },
            "listeners": {
                "data": [
                    {
                        "id": "Read-Connection-Listener",
                        "type": "listeners"
                    }
                ],
                "links": {
                    "related": "http://localhost:8989/v1/listeners/",
                    "self": "http://localhost:8989/v1/services/Read-Connection-Router/relationships/listeners/"
                }
            },
            "servers": {
                "data": [
                    {
                        "id": "server1",
                        "type": "servers"
                    },
                    {
                        "id": "server2",
                        "type": "servers"
                    }
                ],
                "links": {
                    "related": "http://localhost:8989/v1/servers/",
                    "self": "http://localhost:8989/v1/services/Read-Connection-Router/relationships/servers/"
                }
            }
        },
        "type": "services"
    },
    "links": {
        "self": "http://localhost:8989/v1/services/Read-Connection-Router/"
    }
}

hashtag
Get all services

Get all services.

hashtag
Response

Status: 200 OK

hashtag
Get service relationships

The :type in the URI must be either servers, services or filters, depending on which relationship is being retrieved.

hashtag
Response

Status: 200 OK

hashtag
Create a service

Create a new service by defining the resource. The posted object must define at least the following fields.

  • data.id

    • Name of the service

  • data.type

    • Type of the object, must be services

  • data.attributes.router

    • The router module to use

  • data.attributes.parameters.user

  • data.attributes.parameters.password

The data.attributes.parameters object is used to define router and service parameters. All configuration parameters that can be defined in the configuration file can also be added to the parameters object. The exceptions to this are the type, router, servers and filters parameters which must not be defined.

As with other REST API resources, the data.relationships field defines the relationships of the service to other resources. Services can have two types of relationships: servers and filters relationships.

If the request body defines a valid relationships object, the service is linked to those resources. For servers, this is equivalent to adding the list of server names into the servers parameter. For filters, this is equivalent to adding the filters in the data.relationships.filters.data array to the filters parameter in the order they appear. For other services, this is equivalent to adding the list of server names into the targets parameter.

The following example defines a new service with both a server and a filter relationship.

hashtag
Response

Service is created:

Status: 204 No Content

hashtag
Destroy a service

A service can only be destroyed if the service uses no servers or filters and all the listeners pointing to the service have been destroyed. This means that the data.relationships must be an empty object and data.attributes.listeners must be an empty array in order for the service to qualify for destruction.

If there are open client connections that use the service when it is destroyed, they are allowed to gracefully close before the service is destroyed. This means that the destruction of a service can be acknowledged via the REST API before the destruction process has fully completed.

To find out whether a service is still in use after it has been destroyed, the sessions resource should be used. If a session for the service is still open, it has not yet been destroyed.

This endpoint also supports the force=yes parameter that will unconditionally delete the service by first unlinking it from all servers and filters that it uses.

hashtag
Response

Service is destroyed:

Status: 204 No Content

hashtag
Update a service

The request body must be a JSON object which represents a set of new definitions for the service.

All standard service parameters can be modified. Refer to the service documentation on the details of these parameters.

In addition to the standard service parameters, router parameters can be updated at runtime if the router module supports it. Refer to the individual router documentation for more details on whether the router supports it and which parameters can be updated at runtime.

The following example modifies a service by changing the user parameter to admin.

hashtag
Response

Service is modified:

Status: 204 No Content

hashtag
Update service relationships

The :type in the URI must be either servers, services or filters, depending on which relationship is being modified.

The request body must be a JSON object that defines only the data field. The value of the data field must be an array of relationship objects that define the id and type fields of the relationship. This object will replace the existing relationships of this type for the service.

Note: The order of the values in the filters relationship will define the order the filters are set up in. The order in which the filters appear in the array will be the order in which the filters are applied to each query. Refer to the filters parameter for more details.

The following is an example request and request body that defines a single server relationship for a service that is equivalent to a servers=my-server parameter.

All relationships for a service can be deleted by sending an empty array as the data field value. The following example removes all servers from a service.

hashtag
Response

Service relationships modified:

Status: 204 No Content

Invalid JSON body:

Status: 400 Bad Request

hashtag
Stop a service

Stops a started service.

hashtag
Parameters

This endpoint supports the following parameters:

  • force=yes

    • Close all existing connections that were created through this listener.

hashtag
Response

Service is stopped:

Status: 204 No Content

hashtag
Start a service

Starts a stopped service.

hashtag
Response

Service is started:

Status: 204 No Content

hashtag
Reload users of a service

Reloads the list of database users used for authentication.

hashtag
Response

Users are reloaded:

Status: 204 No Content

hashtag
Get service listeners

This endpoint is deprecated, use the this listeners endpoint instead.

hashtag
Get a single service listener

This endpoint is deprecated, use the this listeners endpoint instead.

hashtag
Create a new listener

This endpoint is deprecated, use the this listeners endpoint instead.

hashtag
Destroy a listener

This endpoint is deprecated, use the this listeners endpoint instead.

This page is licensed: CC BY-SA / Gnu FDL

spinner
PreviousMaxScale Server ResourceNextMaxScale Session Resource

Last updated

Was this helpful?