v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-13356598.3 KB
projects

Creates a new cluster in a given project and location.

post/v1/{+parent}/clusters

Path parameters

parentstring required

Required. The parent region in which to create the cluster. Structured like projects/{project}/locations/{location}.

Query parameters

clusterIdstring

Required. The ID to use for the cluster, which will become the final component of the cluster's name. The ID must be 1-63 characters long, and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? to comply with RFC 1035. This value is structured like: my-cluster-id.

requestIdstring

Optional. An optional request ID to identify requests. Specify a unique request ID to avoid duplication of requests. If a request times out or fails, retrying with the same ID allows the server to recognize the previous attempt. For at least 60 minutes, the server ignores duplicate requests bearing the same ID. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID within 60 minutes of the last request, the server checks if an original operation with the same request ID was received. If so, the server ignores the second request. The request ID must be a valid UUID. A zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Request body

namestring

Identifier. The name of the cluster. Structured like: projects/{project_number}/locations/{location}/clusters/{cluster_id}

updateTimestring google-datetime

Output only. The time when the cluster was last updated.

labelsobject

Optional. Labels as key value pairs.

kafkaVersionstring

Output only. Only populated when FULL view is requested. The Kafka version of the cluster.

state'STATE_UNSPECIFIED' | 'CREATING' | 'ACTIVE' | 'DELETING' | 'UPDATING'

Output only. The current state of the cluster.

satisfiesPziboolean

Output only. Reserved for future use.

satisfiesPzsboolean

Output only. Reserved for future use.

createTimestring google-datetime

Output only. The time when the cluster was created.

Response

Successful response