Service doublecloud.kafka.v1.ClusterService

Get

Returns the specified Apache Kafka® cluster.

Request

Field	Description
`cluster_id`	string ID of the Apache Kafka® cluster resource to return.
`sensitive`	bool Whether to include sensitive data in the response. If unspecified, defaults to false.

Response

Field	Description
`id`	string ID of the Apache Kafka® cluster.
`project_id`	string ID of the project that the Apache Kafka® cluster belongs to.
`cloud_type`	string Type of the cloud where instances should be hosted.
`region_id`	string ID of the region to place instances.
`create_time`	google.protobuf.Timestamp Creation timestamp.
`name`	string Name of the Apache Kafka® cluster. The name is unique within the project.
`description`	string Description of the Apache Kafka® cluster.
`status`	doublecloud.v1.ClusterStatus Current state of the cluster.
`version`	string Version of Apache Kafka®.
`resources`	doublecloud.kafka.v1.ClusterResources Resources allocated to the Apache Kafka® cluster.
`connection_info`	doublecloud.kafka.v1.ConnectionInfo Connection information.
`access`	doublecloud.v1.Access Access settings
`encryption`	doublecloud.v1.DataEncryption DataEncryption settings
`network_id`	string ID of the network that the Apache Kafka® cluster belongs to.
`private_connection_info`	doublecloud.kafka.v1.PrivateConnectionInfo Private connection information.
`maintenance_window`	doublecloud.v1.MaintenanceWindow Window of maintenance operations.
`planned_operation`	doublecloud.v1.MaintenanceOperation Maintenance operation planned at nearest maintenance_window.
`kafka_config`	doublecloud.kafka.v1.KafkaConfig Configuration of the Apache Kafka cluster.
`metrics_exporter_connection_info`	doublecloud.kafka.v1.MetricsExporterConnectionInfo Prometheus metrics exporter endpoint HTTP basic auth information.
`schema_registry_config`	doublecloud.kafka.v1.SchemaRegistryConfig Configuration of Schema Registry.
`rest_api_config`	doublecloud.kafka.v1.RestAPIConfig Configuration of REST API.

List

Retrieves a list of Apache Kafka® clusters that belong to the specified
project.

Request

Field	Description
`project_id`	string ID of the project to list Apache Kafka® clusters in.
`paging`	doublecloud.v1.Paging Paging information of the request
`view`	doublecloud.kafka.v1.ClusterView The level of detail to be returned. If unspecified, defaults to CLUSTER_VIEW_BASIC.

Response

Field	Description
`clusters`	list List of Apache Kafka® cluster resources.
`clusters[]`	doublecloud.kafka.v1.Cluster
`next_page`	doublecloud.v1.NextPage Pagination information of the response

Create

Creates an Apache Kafka® cluster in the specified project.

Request

Field	Description
`project_id`	string ID of the project to create the Apache Kafka® cluster in.
`cloud_type`	string Type of the cloud where instances should be hosted.
`region_id`	string ID of the region to place instances.
`name`	string Name of the Apache Kafka® cluster. The name must be unique within the project.
`description`	string Description of the Apache Kafka® cluster.
`version`	string Version of Apache Kafka®.
`resources`	doublecloud.kafka.v1.ClusterResources Resources allocated to the Apache Kafka® cluster.
`access`	doublecloud.v1.Access Access settings
`encryption`	doublecloud.v1.DataEncryption DataEncryption settings
`network_id`	string ID of the network to create the Apache Kafka® cluster in.
`maintenance_window`	doublecloud.v1.MaintenanceWindow Window of maintenance operations.
`kafka_config`	doublecloud.kafka.v1.KafkaConfig Configuration and resources for hosts that should be created for the Apache Kafka® cluster.
`schema_registry_config`	doublecloud.kafka.v1.SchemaRegistryConfig Configuration of Schema Registry.
`rest_api_config`	doublecloud.kafka.v1.RestAPIConfig Configuration of REST API.

Response

Field	Description
`id`	string ID of the operation.
`project_id`	string ID of the project where operation performed.
`description`	string Description of the operation.
`created_by`	string ID of the user or service account who initiated the operation.
`metadata`	list Operation metadata (e.g. cluster_id for create cluster operation).
`metadata[]`	doublecloud.v1.Operation.MetadataEntry
`create_time`	google.protobuf.Timestamp The time when the operation was created.
`start_time`	google.protobuf.Timestamp The time when the operation was started.
`finish_time`	google.protobuf.Timestamp The time when the operation was finished.
`status`	doublecloud.v1.Operation.Status The status of the operation.
`error`	google.rpc.Status The error result of the operation in case of failure or cancellation.
`resource_id`	string ID of the resource operation performed on.

Update

Updates the specified Apache Kafka® cluster.

Request

Field	Description
`cluster_id`	string ID of the Apache Kafka Cluster resource to update. To get the Apache Kafka cluster ID, use a [ClusterService.List] request.
`name`	string New name of the Apache Kafka® cluster. The name must be unique within the project.
`description`	string New description of the Apache Kafka cluster.
`version`	string Version of Apache Kafka®.
`resources`	doublecloud.kafka.v1.ClusterResources New resources allocated to the Apache Kafka® cluster.
`access`	doublecloud.v1.Access Access settings
`maintenance_window`	doublecloud.v1.MaintenanceWindow Window of maintenance operations.
`kafka_config`	doublecloud.kafka.v1.KafkaConfig Configuration and resources for hosts that should be created for the Apache Kafka® cluster.
`schema_registry_config`	doublecloud.kafka.v1.SchemaRegistryConfig Configuration of Schema Registry.
`rest_api_config`	doublecloud.kafka.v1.RestAPIConfig Configuration of REST API.

Response

Field	Description
`id`	string ID of the operation.
`project_id`	string ID of the project where operation performed.
`description`	string Description of the operation.
`created_by`	string ID of the user or service account who initiated the operation.
`metadata`	list Operation metadata (e.g. cluster_id for create cluster operation).
`metadata[]`	doublecloud.v1.Operation.MetadataEntry
`create_time`	google.protobuf.Timestamp The time when the operation was created.
`start_time`	google.protobuf.Timestamp The time when the operation was started.
`finish_time`	google.protobuf.Timestamp The time when the operation was finished.
`status`	doublecloud.v1.Operation.Status The status of the operation.
`error`	google.rpc.Status The error result of the operation in case of failure or cancellation.
`resource_id`	string ID of the resource operation performed on.

Delete

Deletes the specified Apache Kafka® cluster.

Request

Field	Description
`cluster_id`	string ID of the Apache Kafka® cluster to delete. To get the Apache Kafka® cluster ID, use a [ClusterService.List] request.

Response

Field	Description
`id`	string ID of the operation.
`project_id`	string ID of the project where operation performed.
`description`	string Description of the operation.
`created_by`	string ID of the user or service account who initiated the operation.
`metadata`	list Operation metadata (e.g. cluster_id for create cluster operation).
`metadata[]`	doublecloud.v1.Operation.MetadataEntry
`create_time`	google.protobuf.Timestamp The time when the operation was created.
`start_time`	google.protobuf.Timestamp The time when the operation was started.
`finish_time`	google.protobuf.Timestamp The time when the operation was finished.
`status`	doublecloud.v1.Operation.Status The status of the operation.
`error`	google.rpc.Status The error result of the operation in case of failure or cancellation.
`resource_id`	string ID of the resource operation performed on.

ResetCredentials

Reset credentials for the specified cluster.

Request

Field	Description
`cluster_id`	string ID of the Apache Kafka® cluster to reset credentials. To get the Apache Kafka® cluster ID, use a [ClusterService.List] request.

Response

Field	Description
`id`	string ID of the operation.
`project_id`	string ID of the project where operation performed.
`description`	string Description of the operation.
`created_by`	string ID of the user or service account who initiated the operation.
`metadata`	list Operation metadata (e.g. cluster_id for create cluster operation).
`metadata[]`	doublecloud.v1.Operation.MetadataEntry
`create_time`	google.protobuf.Timestamp The time when the operation was created.
`start_time`	google.protobuf.Timestamp The time when the operation was started.
`finish_time`	google.protobuf.Timestamp The time when the operation was finished.
`status`	doublecloud.v1.Operation.Status The status of the operation.
`error`	google.rpc.Status The error result of the operation in case of failure or cancellation.
`resource_id`	string ID of the resource operation performed on.

ListHosts

Retrieves a list of hosts for the specified cluster.

Request

Field	Description
`cluster_id`	string ID of the Apache Kafka cluster. To get the Apache Kafka cluster ID use a [ClusterService.List] request.
`paging`	doublecloud.v1.Paging Paging information of the request

Response

Field	Description
`hosts`	list List of Host resources.
`hosts[]`	doublecloud.kafka.v1.Host
`next_page`	doublecloud.v1.NextPage Pagination information of the response

Start

Starts stopped Kafka cluster.

Request

Field	Description
`cluster_id`	string ID of the Kafka cluster to start.

Response

Field	Description
`id`	string ID of the operation.
`project_id`	string ID of the project where operation performed.
`description`	string Description of the operation.
`created_by`	string ID of the user or service account who initiated the operation.
`metadata`	list Operation metadata (e.g. cluster_id for create cluster operation).
`metadata[]`	doublecloud.v1.Operation.MetadataEntry
`create_time`	google.protobuf.Timestamp The time when the operation was created.
`start_time`	google.protobuf.Timestamp The time when the operation was started.
`finish_time`	google.protobuf.Timestamp The time when the operation was finished.
`status`	doublecloud.v1.Operation.Status The status of the operation.
`error`	google.rpc.Status The error result of the operation in case of failure or cancellation.
`resource_id`	string ID of the resource operation performed on.

Stop

Stops running Kafka cluster.

Request

Field	Description
`cluster_id`	string ID of the Kafka cluster to stop.

Response

Field	Description
`id`	string ID of the operation.
`project_id`	string ID of the project where operation performed.
`description`	string Description of the operation.
`created_by`	string ID of the user or service account who initiated the operation.
`metadata`	list Operation metadata (e.g. cluster_id for create cluster operation).
`metadata[]`	doublecloud.v1.Operation.MetadataEntry
`create_time`	google.protobuf.Timestamp The time when the operation was created.
`start_time`	google.protobuf.Timestamp The time when the operation was started.
`finish_time`	google.protobuf.Timestamp The time when the operation was finished.
`status`	doublecloud.v1.Operation.Status The status of the operation.
`error`	google.rpc.Status The error result of the operation in case of failure or cancellation.
`resource_id`	string ID of the resource operation performed on.

RescheduleMaintenance

Reschedule planned maintenance operation.

Request

Field	Description
`cluster_id`	string Required. ID of the Kafka cluster to maintenance reschedule.
`reschedule_type`	doublecloud.v1.RescheduleType Required. The type of reschedule request.
`delayed_until_time`	google.protobuf.Timestamp The time for SPECIFIC_TIME reschedule. Limited by two weeks since first time scheduled.

Response

Field	Description
`id`	string ID of the operation.
`project_id`	string ID of the project where operation performed.
`description`	string Description of the operation.
`created_by`	string ID of the user or service account who initiated the operation.
`metadata`	list Operation metadata (e.g. cluster_id for create cluster operation).
`metadata[]`	doublecloud.v1.Operation.MetadataEntry
`create_time`	google.protobuf.Timestamp The time when the operation was created.
`start_time`	google.protobuf.Timestamp The time when the operation was started.
`finish_time`	google.protobuf.Timestamp The time when the operation was finished.
`status`	doublecloud.v1.Operation.Status The status of the operation.
`error`	google.rpc.Status The error result of the operation in case of failure or cancellation.
`resource_id`	string ID of the resource operation performed on.

ListOperations

List cluster operations.

Request

Field	Description
`cluster_id`	string Required. ID of the Kafka cluster.
`paging`	doublecloud.v1.Paging Paging information of the request

Response

Field	Description
`operations`	list
`operations[]`	doublecloud.v1.Operation
`next_page`	doublecloud.v1.NextPage Pagination information of the response