Shutdown the Nexfs or Nex3s Server

Action: ShutdownServer

Shuts down the Nexfs or Nex3s Server.

Permissions

To shut down the server, the requesting session must have the nexfs/shutdownserver role enabled.

Request Parameters

A request must be made against the Nexfs management console API with the ShutdownServer action.

The request must be signed with a valid AWS V4-style signature using an active temporary session security token.

Action

ShutdownServer

Request Body

The request does not have a request body.

Response Syntax

If the action is successful, the service sends an HTTP 200 response with the following XML format

<?xml version="1.0" encoding="UTF-8"?>

<RequestCompleted>

<Code>string</Code>

<Message>string</Message>

<Resource>string</Resource>

<RequestId>integer</RequestId>

</RequestCompleted>

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in XML format by the service.

RequestCompleted

Root Level tag for the successful shutdown response

Code

OK

Message

Request Completed

Resource

/nexfsconsoleapi

RequestId

A uniqueu requestid number that identifies the request made to the management API

Errors

Also See Rest Error Responses

400 BadRequest The request action is unknown

401 Unauthorized The request cannot be authenticated

403 Forbidden Session does not have the rights to perform the requested action

500 InternalServerError An Internal Error was encountered

Example Request

GET http://nexfs.example.com:9200/nexfsconsoleapi?Action=ShutdownServer

Authorization: AWS4-HMAC-SHA256 Credential=2ad3303c3cd94923b7724f8c9f61706c/20220829/nexfs/nexfsconsoleapi/aws4_request, SignedHeaders=host;x-amz-content-sha256;x-amz-date, Signature=1a9cea56f140f792b56a5b9a973ca1f4ef620b107f423c1cada348e6f97bf550

host: nexfs.example.com

x-amz-date: 20220829T101209Z

Example Response

<?xml version="1.0" encoding="UTF-8"?>

<RequestCompleted>

<Code>Ok</Code>

<Message>Request Completed</Message>

<Resource>/nexfsconsoleapi</Resource>

<RequestId>26</RequestId>

</RequestCompleted>