Web Server and Web Services Administration

Contents

Overview
Web Server
Web Service

Overview

This page describes how to use epadmin to administer the node's built-in web server, as well as any web services running on the node.

Note that if a node configuration is present, running epadmin commands on the web server or services may be affected.

Web Server

The node web server is enabled by default. To disable the web server, run a command like the following:

epadmin servicename=nodename.cluster stop web

Disabling the web server also disables any running services on the specified node.

To restart the web server, run a command like the following:

epadmin servicename=nodename.cluster start web

The following web server information is displayed when you run a command like the following:

epadmin servicename=nodename.cluster display web

  • Service Name — web service name.

  • Network Address — URL to access the web server.

  • Web Help UI Address — URL to access a help UI for all REST APIs exposed by installed web services.

  • Status — current web server status.

  • Web Services — list of all hosted web services running on the node.

[nodename.cluster] Service Name = http.nodename.cluster
[nodename.cluster] Network Address = http://example:8008
[nodename.cluster] Web Help UI Address = http://example:8008/helpui
[nodename.cluster] Status = STARTED
[nodename.cluster] Web Services = healthcheck,admin,metrics

Web Service

Run a command like the following to display all web services running on the node:

epadmin servicename=nodename.cluster display web type=webservice

  • Web Service Name — web service name.

  • Engine — engine hosting the web service.

  • Base URL — base URL to the REST endpoint exposed by the web service.

  • Authentication Realm — authentication realm being used.

  • Documentation Endpoint — URL to REST endpoint documentation.

  • Status — current web service status.

[nodename.cluster] Web Service Name = admin
[nodename.cluster] Engine = System::administration
[nodename.cluster] Base URL = http://example:8008/admin/v1
[nodename.cluster] Authentication Realm = default-realm
[nodename.cluster] Documentation Endpoint = http://example:8008/apidoc/admin.json
[nodename.cluster] Status = STARTED

[nodename.cluster] Web Service Name = metrics
[nodename.cluster] Engine = System::administration
[nodename.cluster] Base URL = http://example:8008/metrics/v1
[nodename.cluster] Authentication Realm = default-realm
[nodename.cluster] Documentation Endpoint = http://example:8008/apidoc/metrics.json
[nodename.cluster] Status = STARTED

[nodename.cluster] Web Service Name = healthcheck
[nodename.cluster] Engine = System::administration
[nodename.cluster] Base URL = http://example:8008/healthcheck/v1
[nodename.cluster] Authentication Realm = default-realm
[nodename.cluster] Documentation Endpoint = http://example:8008/apidoc/healthcheck.json
[nodename.cluster] Status = STARTED

Specify the detailed parameter to display additional web service information (such as failed requests, if any, to identify possible denial-of-service attacks on endpoints). 

epadmin servicename=nodename.cluster display web type=webservice detailed=true
[nodename.cluster] Web Service Name = healthcheck
[nodename.cluster] Engine = System::administration
[nodename.cluster] Base URL = http://example:8008/admin/v1
[nodename.cluster] Authentication Realm = default-realm
[nodename.cluster] Documentation Endpoint = http://example:8008/admin/v1/apidoc/healthcheck.json
[nodename.cluster] Status = STARTED
[nodename.cluster] Number of Requests with 1xx Response Status = 0
[nodename.cluster] Number of Requests with 2xx Response Status = 0
[nodename.cluster] Number of Requests with 3xx Response Status = 0
[nodename.cluster] Number of Requests with 4xx Response Status = 0
[nodename.cluster] Number of Requests with 5xx Response Status = 0

[nodename.cluster] Web Service Name = admin
[nodename.cluster] Engine = System::administration
[nodename.cluster] Base URL = http://example:8008/admin/v1
[nodename.cluster] Authentication Realm = default-realm
[nodename.cluster] Documentation Endpoint = http://example:8008/admin/v1/apidoc/admin.json
[nodename.cluster] Status = STARTED
[nodename.cluster] Number of Requests with 1xx Response Status = 0
[nodename.cluster] Number of Requests with 2xx Response Status = 0
[nodename.cluster] Number of Requests with 3xx Response Status = 0
[nodename.cluster] Number of Requests with 4xx Response Status = 0
[nodename.cluster] Number of Requests with 5xx Response Status = 0

[nodename.cluster] Web Service Name = metrics
[nodename.cluster] Engine = System::administration
[nodename.cluster] Base URL = http://example:8008/admin/v1/metrics/v1
[nodename.cluster] Authentication Realm = default-realm
[nodename.cluster] Documentation Endpoint = http://example:8008/admin/v1/apidoc/metrics.json
[nodename.cluster] Status = STARTED
[nodename.cluster] Number of Requests with 1xx Response Status = 0
[nodename.cluster] Number of Requests with 2xx Response Status = 0
[nodename.cluster] Number of Requests with 3xx Response Status = 0
[nodename.cluster] Number of Requests with 4xx Response Status = 0
[nodename.cluster] Number of Requests with 5xx Response Status = 0

  • Number of Requests with 1xx Response Status — total number of requests that received a 1xx informational response.

  • Number of Requests with 2xx Response Status — total number of requests that received a 2xx success response.

  • Number of Requests with 3xx Response Status — total number of requests that received a 3xx redirection response.

  • Number of Requests with 4xx Response Status — total number of requests that received a 4xx client error response.

  • Number of Requests with 5xx Response Status — total number of requests that received a 5xx server error response.