ListNodes

Returns information about the nodes within a network.

Request Syntax


GET /networks/networkId/members/memberId/nodes?maxResults=MaxResults&nextToken=NextToken&status=Status HTTP/1.1

URI Request Parameters

The request requires the following URI parameters.

MaxResults

The maximum number of nodes to list.

Valid Range: Minimum value of 1. Maximum value of 20.

MemberId

The unique identifier of the member who owns the nodes to list.

Length Constraints: Minimum length of 1. Maximum length of 32.

NetworkId

The unique identifier of the network for which to list nodes.

Length Constraints: Minimum length of 1. Maximum length of 32.

NextToken

The pagination token that indicates the next set of results to retrieve.

Length Constraints: Maximum length of 128.

Status

Optional. Specifies a status for the nodes to list. If provided, only nodes with this status are listed.

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "Nodes": [ 
      { 
         "AvailabilityZone": "string",
         "CreationDate": number,
         "Endpoint": "string",
         "Id": "string",
         "InstanceType": "string",
         "MemberId": "string",
         "NetworkId": "string",
         "Status": "string"
      }
   ]
}

Response Elements

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

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

NextToken

The pagination token that indicates the next set of results to retrieve.

Type: String

Length Constraints: Maximum length of 128.

Nodes

An array of NodeSummary objects that contain configuration properties for each node.

Type: Array of NodeSummary objects

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException: HTTP Status Code: 403
InternalServiceErrorException: HTTP Status Code: 500
InvalidRequestException: HTTP Status Code: 400
ThrottlingException: HTTP Status Code: 429