Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListNodes

Returns information about the nodes within a network.

Applies to Hyperledger Fabric and Ethereum.

Request Syntax


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

URI Request Parameters

The request uses 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.

Applies only to Hyperledger Fabric and is required for Hyperledger Fabric.

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.

Required: Yes

NextToken

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

Length Constraints: Maximum length of 128.

Status

An optional status specifier. If provided, only nodes currently in 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": [ 
      { 
         "Arn": "string",
         "AvailabilityZone": "string",
         "CreationDate": number,
         "Id": "string",
         "InstanceType": "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

You do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServiceErrorException

The request processing has failed because of an unknown error, exception or failure.

HTTP Status Code: 500

InvalidRequestException

The action or operation requested is invalid. Verify that the action is typed correctly.

HTTP Status Code: 400

ThrottlingException

The request or operation could not be performed because a service is throttling requests. The most common source of throttling errors is launching EC2 instances such that your service limit for EC2 instances is exceeded. Request a limit increase or delete unused resources if possible.

HTTP Status Code: 429