Developer Guide

2.3.2
- 2.5.0
- 2.4.0
- 2.3.1
- 2.3.0

Back Next

Retrieve Node Groups

Use the GET method to retrieve node groups based on ID in VDS.

GET Request in JSON Format

Generate a GET request. For example, the following GET request retrieves a node group based on the ID:

GET /api/nodegroups/{nodegroup-id}

Content-Type: application/json
Accept: application/json

GET Response in JSON Format

The following are sample responses for the 200 OK code:

{
  "id": 322,
  "name": "NodeGroup2",
  "success": true,
  "type": "STATIC",
  "nodes": [
    {
      "id": 253,
      "name": "nd1"
    }
  ]
}

The following are sample responses for the 404 Not Found code:

{
    "success": false,
    "errors": 
        [
            {
            "code": NODEGROUP_NOT_FOUND,
            "parameters": [{nodegroup-id}],
            "errorMessage": "Nodegroup with Id: {nodegroup-id} not found"
            }
        ]
}

The following is a sample response for the 500 Internal Server Error code:

{
    "success": false,
    "errors": 
        [
            {
            "code": INTERNAL_SERVER_ERROR,
            "parameters": [{error-message}],
            "errorMessage": "Failed to get node group. Exception : {error-message}."
            }
        ]
}

Rename Saved Search

Table of Contents

Developer Guide

Developer Guide

Retrieve Node Groups

Retrieve Node Groups

GET Request in JSON Format

GET Response in JSON Format