Amazon Managed Streaming for Apache Kafka
Amazon MSK API Reference

Nodes

The broker nodes in the cluster.

URI

/v1/clusters/clusterArn/nodes

HTTP Methods

GET

Operation ID: ListNodes

Returns a list of the broker nodes in the cluster.

Path Parameters

Name Type Required Description
clusterArn String True

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

Query Parameters

Name Type Required Description
nextToken String False

The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. To get the next batch, provide this token in your next request.

maxResults String False

The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.

Responses

Status Code Response Model Description
200 ListNodesResponse

Successful response.

400 Error

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

403 Error

Access forbidden. Check your credentials and then retry your request.

404 Error

The resource could not be found due to incorrect input. Correct the input, then retry the request.

500 Error

There was an unexpected internal server error. Retrying your request might resolve the issue.

Schemas

Response Bodies

Example ListNodesResponse

{ "nextToken": "string", "nodeInfoList": [ { "zookeeperNodeInfo": { "zookeeperId": number, "clientVpcIpAddress": "string", "attachedENIId": "string", "endpoints": [ "string" ], "zookeeperVersion": "string" }, "instanceType": "string", "nodeType": enum, "nodeARN": "string", "brokerNodeInfo": { "clientVpcIpAddress": "string", "attachedENIId": "string", "brokerId": number, "endpoints": [ "string" ], "clientSubnet": "string", "currentBrokerSoftwareInfo": { "configurationRevision": integer, "kafkaVersion": "string", "configurationArn": "string" } }, "addedToClusterTime": "string" } ] }

Example Error

{ "message": "string", "invalidParameter": "string" }

Properties

BrokerNodeInfo

BrokerNodeInfo

Property Type Required Description
clientVpcIpAddress

string

False

The virtual private cloud (VPC) of the client.

attachedENIId

string

False

The attached elastic network interface of the broker.

brokerId

number

False

The ID of the broker.

endpoints

Array of type string

False

Endpoints for accessing the broker.

clientSubnet

string

False

The client subnet to which this broker node belongs.

currentBrokerSoftwareInfo

BrokerSoftwareInfo

False

Information about the version of software currently deployed on the Kafka brokers in the cluster.

BrokerSoftwareInfo

Information about the current software installed on the cluster.

Property Type Required Description
configurationRevision

integer

Format: int64

False

The revision of the configuration to use. This field isn't visible in this preview release.

kafkaVersion

string

False

The version of Apache Kafka.

configurationArn

string

False

The Amazon Resource Name (ARN) of the configuration used for the cluster. This field isn't visible in this preview release.

Error

Returns information about an error.

Property Type Required Description
message

string

False

The description of the error.

invalidParameter

string

False

The parameter that caused the error.

ListNodesResponse

Information about nodes in the cluster.

Property Type Required Description
nextToken

string

False

The paginated results marker. When the result of a ListNodes operation is truncated, the call returns NextToken in the response. To get another batch of nodes, provide this token in your next request.

nodeInfoList

Array of type NodeInfo

False

List containing a NodeInfo object.

NodeInfo

The node information object.

Property Type Required Description
zookeeperNodeInfo

ZookeeperNodeInfo

False

The ZookeeperNodeInfo.

instanceType

string

False

The instance type.

nodeType

NodeType

False

The node type.

nodeARN

string

False

The Amazon Resource Name (ARN) of the node.

brokerNodeInfo

BrokerNodeInfo

False

The broker node info.

addedToClusterTime

string

False

The start time.

NodeType

The broker or Zookeeper node.

  • BROKER

ZookeeperNodeInfo

Zookeeper node information.

Property Type Required Description
zookeeperId

number

False

The role-specific ID for Zookeeper.

clientVpcIpAddress

string

False

The virtual private cloud (VPC) IP address of the client.

attachedENIId

string

False

The attached elastic network interface of the broker.

endpoints

Array of type string

False

Endpoints for accessing the ZooKeeper.

zookeeperVersion

string

False

The version of Zookeeper.

See Also

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

ListNodes