Method listOperations
Retrieves the list of operations for the specified Apache Kafka® cluster.
HTTP request
GET https://mdb.api.cloud.yandex.net/managed-kafka/v1/clusters/{clusterId}/operations
Path parameters
| Parameter | Description |
|---|---|
| clusterId | Required. ID of the Apache Kafka® cluster to list operations for. The maximum string length in characters is 50. |
Query parameters
| Parameter | Description |
|---|---|
| pageSize | The maximum number of results per page to return. If the number of available results is larger than pageSize, the service returns a nextPageToken that can be used to get the next page of results in subsequent list requests. The maximum value is 1000. |
| pageToken | Page token. To get the next page of results, set pageToken to the nextPageToken returned by a previous list request. The maximum string length in characters is 100. |
Response
HTTP Code: 200 - OK
{
"operations": [
{
"id": "string",
"description": "string",
"createdAt": "string",
"createdBy": "string",
"modifiedAt": "string",
"done": true,
"metadata": "object",
// `operations[]` includes only one of the fields `error`, `response`
"error": {
"code": "integer",
"message": "string",
"details": [
"object"
]
},
"response": "object",
// end of the list of possible fields`operations[]`
}
],
"nextPageToken": "string"
}
| Field | Description |
|---|---|
| operations[] | object An Operation resource. For more information, see Operation. |
| operations[]. id |
string ID of the operation. |
| operations[]. description |
string Description of the operation. 0-256 characters long. |
| operations[]. createdAt |
string (date-time) Creation timestamp. String in RFC3339 text format. |
| operations[]. createdBy |
string ID of the user or service account who initiated the operation. |
| operations[]. modifiedAt |
string (date-time) The time when the Operation resource was last modified. String in RFC3339 text format. |
| operations[]. done |
boolean (boolean) If the value is |
| operations[]. metadata |
object Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
| operations[]. error |
object The error result of the operation in case of failure or cancellation. operations[] includes only one of the fields error, responseThe error result of the operation in case of failure or cancellation. |
| operations[]. error. code |
integer (int32) Error code. An enum value of google.rpc.Code. |
| operations[]. error. message |
string An error message. |
| operations[]. error. details[] |
object A list of messages that carry the error details. |
| operations[]. response |
object operations[] includes only one of the fields error, responseThe normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any. |
| nextPageToken | string Token that allows you to get the next page of results for list requests. If the number of results is larger than pageSize, use nextPageToken as the value for the pageToken query parameter in the next list request. Each subsequent list request will have its own nextPageToken to continue paging through the results. |