URI HTTP methods Schemas Properties See also

V2 Clusters clusterArn Operations

URI

/api/v2/clusters/clusterArn/operations

HTTP methods

GET

Operation ID: ListClusterOperationsV2

Returns a list of all the operations that have been performed on the specified MSK cluster. Displays operations of the type DECREASE_BROKER_COUNT in the results list (after a successful broker removal operation).

Path parameters
Name	Type	Required	Description
`clusterArn`	String	True	ARN of the cluster to be described.

Query parameters
Name	Type	Required	Description
`nextToken`	String	False	If the response of ListClusters is truncated, it returns a nextToken in the response. This nextToken should be sent in the subsequent request to ListClusters.
`maxResults`	String	False	Maximum number of clusters to fetch in one get request.

Responses
Status code	Response model	Description
`200`	`ListClusterOperationsV2Response`	HTTP Status Code 200: OK.
`400`	None	HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
`401`	None	HTTP Status Code 401: Unauthorized request. The provided credentials couldn't be validated.
`403`	None	HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
`404`	None	HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
`429`	None	HTTP Status Code 429: Limit exceeded. Resource limit reached.
`500`	None	HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
`503`	None	HTTP Status Code 503: Service Unavailable. Retrying your request in some time might resolve the issue.

OPTIONS

Enable CORS by returning correct headers.

Path parameters
Name	Type	Required	Description
`clusterArn`	String	True	ARN of the cluster to be described.

Responses
Status code	Response model	Description
`200`	None	200 response

Schemas

Response bodies


{
  "nextToken": "string",
  "clusterOperationInfoList": [
    {
      "clusterType": enum,
      "clusterArn": "string",
      "operationState": "string",
      "startTime": "string",
      "operationType": "string",
      "endTime": "string",
      "operationArn": "string"
    }
  ]
}

Properties

ClusterOperationV2Summary

Returns information about a cluster operation.

Property	Type	Required	Description
`clusterArn`	string	False	ARN of the cluster.
`clusterType`	ClusterType	False	Type of the backend cluster.
`endTime`	string	False	The time at which the operation finished.
`operationArn`	string	False	ARN of the cluster operation.
`operationState`	string	False	State of the cluster operation.
`operationType`	string	False	Type of the cluster operation.
`startTime`	string	False	The time at which operation was created.

ClusterType

The type of backend cluster.

PROVISIONED
SERVERLESS

ListClusterOperationsV2Response

The response contains an array containing cluster operation information and a nextToken if the response is truncated. Displays operations of the type DECREASE_BROKER_COUNT in results list after a successful broker removal operation.

Property	Type	Required	Description
`clusterOperationInfoList`	Array of type ClusterOperationV2Summary	False	An array of cluster operation information objects.
`nextToken`	string	False	If the response of ListClusterOperationsV2 is truncated, it returns a nextToken in the response. This nextToken should be sent in the subsequent request to ListClusterOperationsV2.