Jump to

• Request
• Response
• Examples

Stop All Nodes

get

/nodeManagers/{id}/stopAllNodes

Stops all the nodes in a Node Manager.

Request

Path Parameters

• id(required): string

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

All the nodes have been stopped successfully.

404 Response

The requested resource cannot be found.

Body ()

Root Schema : Error

Type: object

Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Show Source

• @type: string
  Defines the sub-class entity when sub-classing.
• cause: string
  Cause of the exception
• code(required): string
  Application relevant details defined in the API or a common list.
• message: string
  Details and corrective actions related to the error which is shown to a client user.
• reason(required): string
  The reason for the error, shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• status: string
  HTTP Error Code describiing the error.

{
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "@type":{
            "description":"Defines the sub-class entity when sub-classing.",
            "type":"string"
        },
        "cause":{
            "description":"Cause of the exception",
            "type":"string"
        },
        "code":{
            "description":"Application relevant details defined in the API or a common list.",
            "nullable":false,
            "type":"string"
        },
        "message":{
            "description":"Details and corrective actions related to the error which is shown to a client user.",
            "type":"string"
        },
        "reason":{
            "description":"The reason for the error, shown to a client user.",
            "nullable":false,
            "type":"string"
        },
        "referenceError":{
            "description":"URI of documentation describing the error.",
            "format":"uri",
            "type":"string"
        },
        "status":{
            "description":"HTTP Error Code describiing the error.",
            "type":"string"
        }
    },
    "description":"Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).",
    "type":"object"
}

422 Response

The entity cannot be processed due to semantic-errors.

Body ()

Root Schema : Error

Type: object

Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Show Source

• @type: string
  Defines the sub-class entity when sub-classing.
• cause: string
  Cause of the exception
• code(required): string
  Application relevant details defined in the API or a common list.
• message: string
  Details and corrective actions related to the error which is shown to a client user.
• reason(required): string
  The reason for the error, shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• status: string
  HTTP Error Code describiing the error.

{
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "@type":{
            "description":"Defines the sub-class entity when sub-classing.",
            "type":"string"
        },
        "cause":{
            "description":"Cause of the exception",
            "type":"string"
        },
        "code":{
            "description":"Application relevant details defined in the API or a common list.",
            "nullable":false,
            "type":"string"
        },
        "message":{
            "description":"Details and corrective actions related to the error which is shown to a client user.",
            "type":"string"
        },
        "reason":{
            "description":"The reason for the error, shown to a client user.",
            "nullable":false,
            "type":"string"
        },
        "referenceError":{
            "description":"URI of documentation describing the error.",
            "format":"uri",
            "type":"string"
        },
        "status":{
            "description":"HTTP Error Code describiing the error.",
            "type":"string"
        }
    },
    "description":"Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).",
    "type":"object"
}

500 Response

The system has encountered an internal server error.

Body ()

Root Schema : Error

Type: object

Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Show Source

• @type: string
  Defines the sub-class entity when sub-classing.
• cause: string
  Cause of the exception
• code(required): string
  Application relevant details defined in the API or a common list.
• message: string
  Details and corrective actions related to the error which is shown to a client user.
• reason(required): string
  The reason for the error, shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• status: string
  HTTP Error Code describiing the error.

{
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "@type":{
            "description":"Defines the sub-class entity when sub-classing.",
            "type":"string"
        },
        "cause":{
            "description":"Cause of the exception",
            "type":"string"
        },
        "code":{
            "description":"Application relevant details defined in the API or a common list.",
            "nullable":false,
            "type":"string"
        },
        "message":{
            "description":"Details and corrective actions related to the error which is shown to a client user.",
            "type":"string"
        },
        "reason":{
            "description":"The reason for the error, shown to a client user.",
            "nullable":false,
            "type":"string"
        },
        "referenceError":{
            "description":"URI of documentation describing the error.",
            "format":"uri",
            "type":"string"
        },
        "status":{
            "description":"HTTP Error Code describiing the error.",
            "type":"string"
        }
    },
    "description":"Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).",
    "type":"object"
}

Back to Top

Examples

The following example shows how to start all the nodes in a node manager by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.

curl -X GET 'http://host:port/nodeManagers/NMGR-31eoeh-otm-ln3hrqc9/stopAllNodes'

Example of the Response Body

If successful, the response code 200 is displayed.

Back to Top