Amazon Managed Streaming for Apache Kafka
Amazon MSK API Reference

Cluster Operation

Represents an operation that was performed on an MSK cluster.

URI

/v1/operations/clusterOperationArn

HTTP Methods

GET

Operation ID: DescribeClusterOperation

Returns a description of the cluster operation specified by the ARN.

Path Parameters

Name Type Required Description
clusterOperationArn String True

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

Responses

Status Code Response Model Description
200 DescribeClusterOperationResponse

200 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.

500 Error

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

Schemas

Response Bodies

Example DescribeClusterOperationResponse

{ "clusterOperationInfo": { "clusterArn": "string", "creationTime": "string", "clientRequestId": "string", "operationState": "string", "sourceClusterInfo": { "numberOfBrokerNodes": integer, "configurationInfo": { "arn": "string", "revision": integer }, "brokerEBSVolumeInfo": [ { "volumeSizeGB": integer, "kafkaBrokerNodeId": "string" } ] }, "errorInfo": { "errorString": "string", "errorCode": "string" }, "operationType": "string", "endTime": "string", "targetClusterInfo": { "numberOfBrokerNodes": integer, "configurationInfo": { "arn": "string", "revision": integer }, "brokerEBSVolumeInfo": [ { "volumeSizeGB": integer, "kafkaBrokerNodeId": "string" } ] }, "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.

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.

targetClusterInfo

MutableClusterInfo

False

Information about cluster attributes after a cluster is updated.

operationArn

string

False

ARN of the cluster operation.

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.

DescribeClusterOperationResponse

Information about a cluster operation.

Property Type Required Description
clusterOperationInfo

ClusterOperationInfo

False

Cluster operation information

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.

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.

brokerEBSVolumeInfo

Array of type BrokerEBSVolumeInfo

False

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

See Also

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

DescribeClusterOperation