Cluster Operations - Amazon Managed Streaming for Apache Kafka

Cluster Operations

Represents the operations that have been performed on an MSK cluster.

URI

/v1/clusters/clusterArn/operations

HTTP Methods

GET

Operation ID: ListClusterOperations

Returns a list of all the operations that have been performed on the specified MSK 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 ListClusterOperationsResponse

Successful response.

400 Error

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

401 Error

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

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.

429 Error

429 response

500 Error

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

503 Error

503 response

Schemas

Response Bodies

Example ListClusterOperationsResponse

{ "nextToken": "string", "clusterOperationInfoList": [ { "clusterArn": "string", "creationTime": "string", "clientRequestId": "string", "operationState": "string", "sourceClusterInfo": { "numberOfBrokerNodes": integer, "configurationInfo": { "arn": "string", "revision": integer }, "enhancedMonitoring": enum, "kafkaVersion": "string", "loggingInfo": { "brokerLogs": { "s3": { "bucket": "string", "prefix": "string", "enabled": boolean }, "firehose": { "deliveryStream": "string", "enabled": boolean }, "cloudWatchLogs": { "logGroup": "string", "enabled": boolean } } }, "brokerEBSVolumeInfo": [ { "volumeSizeGB": integer, "kafkaBrokerNodeId": "string" } ], "openMonitoring": { "prometheus": { "nodeExporter": { "enabledInBroker": boolean }, "jmxExporter": { "enabledInBroker": boolean } } } }, "errorInfo": { "errorString": "string", "errorCode": "string" }, "operationType": "string", "endTime": "string", "operationSteps": [ { "stepName": "string", "stepInfo": { "stepStatus": "string" } } ], "targetClusterInfo": { "numberOfBrokerNodes": integer, "configurationInfo": { "arn": "string", "revision": integer }, "enhancedMonitoring": enum, "kafkaVersion": "string", "loggingInfo": { "brokerLogs": { "s3": { "bucket": "string", "prefix": "string", "enabled": boolean }, "firehose": { "deliveryStream": "string", "enabled": boolean }, "cloudWatchLogs": { "logGroup": "string", "enabled": boolean } } }, "brokerEBSVolumeInfo": [ { "volumeSizeGB": integer, "kafkaBrokerNodeId": "string" } ], "openMonitoring": { "prometheus": { "nodeExporter": { "enabledInBroker": boolean }, "jmxExporter": { "enabledInBroker": boolean } } } }, "operationArn": "string" } ] }

Example Error

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

Properties

BrokerEBSVolumeInfo

Specifies the EBS volume upgrade information. The broker identifier must be set to the keyword ALL. This means the changes apply to all the brokers in the cluster.

Property Type Required Description
volumeSizeGB

integer

True

Size of the EBS volume to update.

kafkaBrokerNodeId

string

True

The ID of the broker to update. The only allowed value is ALL. This means that Amazon MSK applies the same storage update to all broker nodes.

BrokerLogs

The broker logs configuration for this MSK cluster.

Property Type Required Description
s3

S3

False

Details of the Amazon S3 destination for broker logs.

firehose

Firehose

False

Details of the Kinesis Data Firehose delivery stream that is the destination for broker logs.

cloudWatchLogs

CloudWatchLogs

False

Details of the CloudWatch Logs destination for broker logs.

CloudWatchLogs

Details of the CloudWatch Logs destination for broker logs.

Property Type Required Description
logGroup

string

False

The CloudWatch log group that is the destination for broker logs.

enabled

boolean

True

Specifies whether broker logs get sent to the specified CloudWatch Logs destination.

ClusterOperationInfo

Returns information about a cluster operation.

Property Type Required Description
clusterArn

string

False

ARN of the cluster.

creationTime

string

False

The time that the operation was created.

clientRequestId

string

False

The ID of the API request that triggered this operation.

operationState

string

False

State of the cluster operation.

sourceClusterInfo

MutableClusterInfo

False

Information about cluster attributes before a cluster is updated.

errorInfo

ErrorInfo

False

Describes the error if the operation fails.

operationType

string

False

Type of the cluster operation.

endTime

string

False

The time at which the operation finished.

operationSteps

Array of type ClusterOperationStep

False

Steps completed during the operation.

targetClusterInfo

MutableClusterInfo

False

Information about cluster attributes after a cluster is updated.

operationArn

string

False

ARN of the cluster operation.

ClusterOperationStep

Step taken during a cluster operation.

Property Type Required Description
stepName

string

False

The name of the step.

stepInfo

ClusterOperationStepInfo

False

Information about the step and its status.

ClusterOperationStepInfo

Information about a step in an operation.

Property Type Required Description
stepStatus

string

False

The step's current status.

ConfigurationInfo

Specifies the configuration to use for the brokers.

Property Type Required Description
arn

string

True

ARN of the configuration to use.

revision

integer

Format: int64

Minimum: 1

True

The revision of the configuration to use.

EnhancedMonitoring

Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster. This property has three possible values: DEFAULT, PER_BROKER, and PER_TOPIC_PER_BROKER. For a list of the metrics associated with each of these three levels of monitoring, see Monitoring.

  • DEFAULT

  • PER_BROKER

  • PER_TOPIC_PER_BROKER

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.

ErrorInfo

Returns information about an error state of the cluster.

Property Type Required Description
errorString

string

False

An optional field to provide more details about the error.

errorCode

string

False

A number describing the error programmatically.

Firehose

Firehose details for BrokerLogs.

Property Type Required Description
deliveryStream

string

False

The Kinesis Data Firehose delivery stream that is the destination for broker logs.

enabled

boolean

True

Specifies whether broker logs get send to the specified Kinesis Data Firehose delivery stream.

JmxExporter

Indicates whether you want to enable or disable the JMX Exporter.

Property Type Required Description
enabledInBroker

boolean

True

Indicates whether you want to enable or disable the JMX Exporter.

ListClusterOperationsResponse

The response contains an array containing cluster operation information and a next token if the response is truncated.

Property Type Required Description
nextToken

string

False

If the response of ListClusterOperations is truncated, Amazon MSK returns a NextToken in the response. Send this NextToken in your subsequent request to ListClusterOperations.

clusterOperationInfoList

Array of type ClusterOperationInfo

False

An array of cluster operation information objects.

LoggingInfo

You can configure your MSK cluster to send broker logs to different destination types. This is a container for the configuration details related to broker logs.

Property Type Required Description
brokerLogs

BrokerLogs

True

You can configure your MSK cluster to send broker logs to different destination types. This configuration specifies the details of these destinations.

MutableClusterInfo

Information about cluster attributes that can be updated via update APIs.

Property Type Required Description
numberOfBrokerNodes

integer

False

The number of broker nodes in the cluster.

configurationInfo

ConfigurationInfo

False

Information about the changes in the configuration of the brokers.

enhancedMonitoring

EnhancedMonitoring

False

This knob controls level of metrics pushed customer's cloudwatch account.

kafkaVersion

string

False

The Apache Kafka version.

loggingInfo

LoggingInfo

False

LoggingInfo details.

brokerEBSVolumeInfo

Array of type BrokerEBSVolumeInfo

False

Specifies the size of the EBS volume and the ID of the associated broker.

openMonitoring

OpenMonitoring

False

Open monitoring details.

NodeExporter

Indicates whether you want to enable or disable the Node Exporter.

Property Type Required Description
enabledInBroker

boolean

True

Indicates whether you want to enable or disable the Node Exporter.

OpenMonitoring

JMX and Node monitoring for the MSK cluster.

Property Type Required Description
prometheus

Prometheus

True

Prometheus exporter settings.

Prometheus

Prometheus settings for open monitoring.

Property Type Required Description
nodeExporter

NodeExporter

False

Indicates whether you want to enable or disable the Node Exporter.

jmxExporter

JmxExporter

False

Indicates whether you want to enable or disable the JMX Exporter.

S3

The details of the Amazon S3 destination for broker logs.

Property Type Required Description
bucket

string

False

The name of the S3 bucket that is the destination for broker logs.

prefix

string

False

The S3 prefix that is the destination for broker logs.

enabled

boolean

True

Specifies whether broker logs get sent to the specified Amazon S3 destination.

See Also

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

ListClusterOperations