Brokers - Amazon Managed Streaming for Apache Kafka
URIHTTP methodsSchemasProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

Brokers

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. The following Python 3.6 example first lists one node of a cluster. Because the cluster has more nodes, the response contains a token that the script then uses to list the remaining nodes.

import boto3

client = boto3.client('kafka')

list_nodes_response = client.list_nodes(
    ClusterArn='arn:aws:kafka:us-east-1:0123456789019:cluster/SalesCluster/abcd1234-abcd-cafe-abab-9876543210ab-4',
    MaxResults=1
)

print('\n')
print('Here is the first node in the list:')
print('\n')
print(list_nodes_response['NodeInfoList'])

next_token = list_nodes_response['NextToken']

list_nodes_response = client.list_nodes(
    ClusterArn='arn:aws:kafka:us-east-1:0123456789019:cluster/SalesCluster/abcd1234-abcd-cafe-abab-9876543210ab-4',
    NextToken=next_token
)

print('\n')
print('Here are the remaining nodes in the list:')
print('\n')
print(list_nodes_response['NodeInfoList'])
Path parameters
NameTypeRequiredDescription
clusterArnStringTrue

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

Query parameters
NameTypeRequiredDescription
nextTokenStringFalse

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.

maxResultsStringFalse

The maximum number of results to return in the response (default maximum 100 results per API call). If there are more results, the response includes a NextToken parameter.

Responses
Status codeResponse modelDescription
200 ListNodesResponse

Successful response.

400Error

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

401Error

The request is not authorized. The provided credentials couldn't be validated.

403Error

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

404Error

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

429Error

429 response

500Error

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

503Error

503 response

OPTIONS

Enable CORS by returning the correct headers.

Path parameters
NameTypeRequiredDescription
clusterArnStringTrue

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

Responses
Status codeResponse modelDescription
200None

Default response for CORS method

Schemas

Response bodies

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

Properties

BrokerNodeInfo

BrokerNodeInfo

PropertyTypeRequiredDescription
attachedENIId

string

False

The attached elastic network interface of the broker.

brokerId

number

False

The ID of the broker.

clientSubnet

string

False

The client subnet to which this broker node belongs.

clientVpcIpAddress

string

False

The virtual private cloud (VPC) of the client.

currentBrokerSoftwareInfo

BrokerSoftwareInfo

False

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

endpoints

Array of type string

False

Endpoints for accessing the broker.

BrokerSoftwareInfo

Information about the current software installed on the cluster.

PropertyTypeRequiredDescription
configurationArn

string

False

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

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. You can use Amazon MSK to create clusters that use Apache Kafka versions 1.1.1 and 2.2.1. See Apache Kafka Versions.

Error

Returns information about an error.

PropertyTypeRequiredDescription
invalidParameter

string

False

The parameter that caused the error.

message

string

False

The description of the error.

ListNodesResponse

Information about nodes in the cluster.

PropertyTypeRequiredDescription
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. Doesn't contain entries for brokers that have been deleted.

NodeInfo

The node information object.

PropertyTypeRequiredDescription
addedToClusterTime

string

False

The start time.

brokerNodeInfo

BrokerNodeInfo

False

The broker node info.

instanceType

string

False

The instance type.

nodeARN

string

False

The Amazon Resource Name (ARN) of the node.

nodeType

NodeType

False

The node type.

zookeeperNodeInfo

ZookeeperNodeInfo

False

The ZookeeperNodeInfo.

NodeType

The broker or Apache ZooKeeper node.

  • BROKER

ZookeeperNodeInfo

Apache ZooKeeper node information.

PropertyTypeRequiredDescription
attachedENIId

string

False

The attached elastic network interface of the broker.

clientVpcIpAddress

string

False

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

endpoints

Array of type string

False

Endpoints for accessing the Apache ZooKeeper nodes.

zookeeperId

number

False

The role-specific ID for Apache ZooKeeper.

zookeeperVersion

string

False

The version of Apache ZooKeeper.