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 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
maxResults | String | False | 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 |
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 |
OPTIONS
Enable CORS by returning the correct headers.
Path parameters | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Name | Type | Required | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
clusterArn | String | True | The Amazon Resource Name (ARN) that uniquely identifies the cluster. |
Responses | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Status code | Response model | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
200 | None | Default response for CORS method |
Schemas
Response bodies
{ "nextToken": "string", "clusterOperationInfoList": [ { "clusterArn": "string", "creationTime": "string", "clientRequestId": "string", "operationState": "string", "sourceClusterInfo": { "encryptionInfo": { "encryptionInTransit": { "inCluster": boolean, "clientBroker": enum }, "encryptionAtRest": { "dataVolumeKMSKeyId": "string" } }, "numberOfBrokerNodes": integer, "configurationInfo": { "arn": "string", "revision": integer }, "enhancedMonitoring": enum, "storageMode": enum, "kafkaVersion": "string", "instanceType": "string", "connectivityInfo": { "vpcConnectivity": { "clientAuthentication": { "sasl": { "iam": { "enabled": boolean }, "scram": { "enabled": boolean } }, "tls": { "enabled": boolean } } }, "publicAccess": { "type": "string" } }, "clientAuthentication": { "sasl": { "iam": { "enabled": boolean }, "scram": { "enabled": boolean } }, "unauthenticated": { "enabled": boolean }, "tls": { "certificateAuthorityArnList": [ "string" ], "enabled": boolean } }, "loggingInfo": { "brokerLogs": { "s3": { "bucket": "string", "prefix": "string", "enabled": boolean }, "firehose": { "deliveryStream": "string", "enabled": boolean }, "cloudWatchLogs": { "logGroup": "string", "enabled": boolean } } }, "brokerEBSVolumeInfo": [ { "volumeSizeGB": integer, "provisionedThroughput": { "volumeThroughput": integer, "enabled": boolean }, "kafkaBrokerNodeId": "string" } ], "openMonitoring": { "prometheus": { "nodeExporter": { "enabledInBroker": boolean }, "jmxExporter": { "enabledInBroker": boolean } } } }, "errorInfo": { "errorString": "string", "errorCode": "string" }, "vpcConnectionInfo": { "owner": "string", "vpcConnectionArn": "string", "creationTime": "string", "userIdentity": { "principalId": "string", "type": enum } }, "operationType": "string", "endTime": "string", "operationSteps": [ { "stepName": "string", "stepInfo": { "stepStatus": "string" } } ], "operationArn": "string", "targetClusterInfo": { "encryptionInfo": { "encryptionInTransit": { "inCluster": boolean, "clientBroker": enum }, "encryptionAtRest": { "dataVolumeKMSKeyId": "string" } }, "numberOfBrokerNodes": integer, "configurationInfo": { "arn": "string", "revision": integer }, "enhancedMonitoring": enum, "storageMode": enum, "kafkaVersion": "string", "instanceType": "string", "connectivityInfo": { "vpcConnectivity": { "clientAuthentication": { "sasl": { "iam": { "enabled": boolean }, "scram": { "enabled": boolean } }, "tls": { "enabled": boolean } } }, "publicAccess": { "type": "string" } }, "clientAuthentication": { "sasl": { "iam": { "enabled": boolean }, "scram": { "enabled": boolean } }, "unauthenticated": { "enabled": boolean }, "tls": { "certificateAuthorityArnList": [ "string" ], "enabled": boolean } }, "loggingInfo": { "brokerLogs": { "s3": { "bucket": "string", "prefix": "string", "enabled": boolean }, "firehose": { "deliveryStream": "string", "enabled": boolean }, "cloudWatchLogs": { "logGroup": "string", "enabled": boolean } } }, "brokerEBSVolumeInfo": [ { "volumeSizeGB": integer, "provisionedThroughput": { "volumeThroughput": integer, "enabled": boolean }, "kafkaBrokerNodeId": "string" } ], "openMonitoring": { "prometheus": { "nodeExporter": { "enabledInBroker": boolean }, "jmxExporter": { "enabledInBroker": boolean } } } } } ] }
{ "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.
BrokerLogs
The broker logs configuration for this MSK cluster.
ClientAuthentication
Includes all client authentication information.
ClientBroker
Client-broker encryption in transit setting.
TLS
TLS_PLAINTEXT
PLAINTEXT
CloudWatchLogs
Details of the CloudWatch Logs destination for broker logs.
ClusterOperationInfo
Returns information about a cluster operation.
ClusterOperationStep
Step taken during a cluster operation.
ClusterOperationStepInfo
Information about a step in an operation.
ConfigurationInfo
Specifies the configuration to use for the brokers.
ConnectivityInfo
Broker access controls.
EncryptionAtRest
The data-volume encryption details. You can't update encryption at rest settings for existing clusters.
EncryptionInTransit
The settings for encrypting data in transit.
EncryptionInfo
Includes encryption-related information, such as the Amazon KMS key used for encrypting data at rest and whether you want MSK to encrypt your data in transit.
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
PER_TOPIC_PER_PARTITION
Error
Returns information about an error.
ErrorInfo
Returns information about an error state of the cluster.
Firehose
Firehose details for BrokerLogs.
IAM
Details for SASL/IAM client authentication.
JmxExporter
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.
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.
MutableClusterInfo
Information about cluster attributes that can be updated via update APIs.
NodeExporter
Indicates whether you want to enable or disable the Node Exporter.
OpenMonitoring
JMX and Node monitoring for the MSK cluster.
Prometheus
Prometheus settings for open monitoring.
ProvisionedThroughput
Contains information about provisioned throughput for EBS storage volumes attached to kafka broker nodes.
PublicAccess
Broker access controls
S3
The details of the Amazon S3 destination for broker logs.
Sasl
Details for client authentication using SASL. To turn on SASL, you must also turn on EncryptionInTransit
by setting inCluster
to true. You must set clientBroker
to either TLS
or TLS_PLAINTEXT
. If you choose TLS_PLAINTEXT
, then you must also set unauthenticated
to true.
Scram
Details for SASL/SCRAM client authentication.
StorageMode
Controls storage mode for various supported storage tiers.
LOCAL
TIERED
Tls
Details for client authentication using TLS.
Unauthenticated
Details for allowing no client authentication.
UserIdentity
Description of the requester that calls the API operation.
UserIdentityType
The identity type of the requester that calls the API operation.
AWSAccount
AWSService
VpcConnectionInfo
Description of the VPC connection.
VpcConnectivity
VPC connection control settings for brokers.
VpcConnectivityClientAuthentication
Includes all client authentication information for VpcConnectivity.
VpcConnectivityIAM
Details for SASL/IAM client authentication for VpcConnectivity.
VpcConnectivitySasl
Details for client authentication using SASL for VpcConnectivity.
VpcConnectivityScram
Details for SASL/SCRAM client authentication for vpcConnectivity.
VpcConnectivityTls
Details for client authentication using TLS for vpcConnectivity.
See also
For more information about using this API in one of the language-specific AWS SDKs and references, see the following: