openapi: 3.2.0 info: title: Confluent Cloud Share Group (v3) API version: '' x-api-id: 46234552-5833-42eb-ba0f-883ad3f70d2b x-audience: external-public x-logo: url: https://assets.confluent.io/m/1661ef5e4ff82d3d/ description: '# Introduction Note This documents the collection of Confluent Cloud APIs.' servers: - url: https://api.confluent.cloud description: Confluent Cloud API tags: - name: Share Group (v3) description: '' paths: /kafka/v3/clusters/{cluster_id}/share-groups: servers: - url: https://pkc-00000.region.provider.confluent.cloud x-audience: business-unit-internal description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud parameters: - $ref: '#/components/parameters/ClusterId' get: summary: List Share Groups operationId: listKafkaShareGroups description: ' Return the list of share groups that belong to the specified Kafka cluster.' tags: - Share Group (v3) security: - resource-api-key: [] - external-access-token: [] responses: '200': $ref: '#/components/responses/ListShareGroupsResponse' '400': $ref: '#/components/responses/BadRequestErrorResponse' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': $ref: '#/components/responses/ForbiddenErrorResponse' '429': $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' /kafka/v3/clusters/{cluster_id}/share-groups/{group_id}: servers: - url: https://pkc-00000.region.provider.confluent.cloud x-audience: business-unit-internal description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud parameters: - $ref: '#/components/parameters/ClusterId' - $ref: '#/components/parameters/GroupId' get: summary: Get Share Group operationId: getKafkaShareGroup description: ' Return the share group specified by the ``group_id``.' tags: - Share Group (v3) security: - resource-api-key: [] - external-access-token: [] responses: '200': $ref: '#/components/responses/GetShareGroupResponse' '400': $ref: '#/components/responses/BadRequestErrorResponse' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': $ref: '#/components/responses/ForbiddenErrorResponse' '429': $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' delete: summary: Delete Share Group operationId: deleteKafkaShareGroup description: ' Delete the share group specified by the ``group_id``.' tags: - Share Group (v3) security: - resource-api-key: [] - external-access-token: [] responses: '204': $ref: '#/components/responses/NoContentResponse' '400': $ref: '#/components/responses/BadRequestErrorResponse' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': $ref: '#/components/responses/ForbiddenErrorResponse' '404': $ref: '#/components/responses/NotFoundErrorResponse' '429': $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' /kafka/v3/clusters/{cluster_id}/share-groups/{group_id}/consumers: servers: - url: https://pkc-00000.region.provider.confluent.cloud x-audience: business-unit-internal description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud parameters: - $ref: '#/components/parameters/ClusterId' - $ref: '#/components/parameters/GroupId' get: summary: List Share Group Consumers operationId: listKafkaShareGroupConsumers description: ' Return a list of consumers that belong to the specified share group.' tags: - Share Group (v3) security: - resource-api-key: [] - external-access-token: [] responses: '200': $ref: '#/components/responses/ListShareGroupConsumersResponse' '400': $ref: '#/components/responses/BadRequestErrorResponse' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': $ref: '#/components/responses/ForbiddenErrorResponse' '429': $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' /kafka/v3/clusters/{cluster_id}/share-groups/{group_id}/consumers/{consumer_id}: servers: - url: https://pkc-00000.region.provider.confluent.cloud x-audience: business-unit-internal description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud parameters: - $ref: '#/components/parameters/ClusterId' - $ref: '#/components/parameters/GroupId' - $ref: '#/components/parameters/ConsumerId' get: summary: Get Share Group Consumer operationId: getKafkaShareGroupConsumer description: ' Return the consumer specified by the ``consumer_id``.' tags: - Share Group (v3) security: - resource-api-key: [] - external-access-token: [] responses: '200': $ref: '#/components/responses/GetShareGroupConsumerResponse' '400': $ref: '#/components/responses/BadRequestErrorResponse' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': $ref: '#/components/responses/ForbiddenErrorResponse' '429': $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' /kafka/v3/clusters/{cluster_id}/share-groups/{group_id}/consumers/{consumer_id}/assignments: servers: - url: https://pkc-00000.region.provider.confluent.cloud x-audience: business-unit-internal description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud parameters: - $ref: '#/components/parameters/ClusterId' - $ref: '#/components/parameters/GroupId' - $ref: '#/components/parameters/ConsumerId' get: summary: List Share Group Consumer Assignments operationId: listKafkaShareGroupConsumerAssignments description: ' Return the consumer assignments specified by the ``consumer_id``.' tags: - Share Group (v3) security: - resource-api-key: [] - external-access-token: [] responses: '200': $ref: '#/components/responses/ListShareGroupConsumerAssignmentsResponse' '400': $ref: '#/components/responses/BadRequestErrorResponse' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': $ref: '#/components/responses/ForbiddenErrorResponse' '429': $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' components: schemas: Relationship: type: object required: - related properties: related: type: string Error: type: object description: Describes a particular error encountered while performing an operation. properties: id: description: A unique identifier for this particular occurrence of the problem. type: string maxLength: 255 status: description: The HTTP status code applicable to this problem, expressed as a string value. type: string code: description: An application-specific error code, expressed as a string value. type: string title: description: A short, human-readable summary of the problem. It **SHOULD NOT** change from occurrence to occurrence of the problem, except for purposes of localization. type: string detail: description: A human-readable explanation specific to this occurrence of the problem. type: string source: type: object description: If this error was caused by a particular part of the API request, the source will point to the query string parameter or request body property that caused it. properties: pointer: description: A JSON Pointer [RFC6901] to the associated entity in the request document [e.g. "/spec" for a spec object, or "/spec/title" for a specific field]. type: string parameter: description: A string indicating which query parameter caused the error. type: string error_code: type: integer format: int32 message: type: - string - 'null' additionalProperties: false ShareGroupConsumerAssignmentDataList: allOf: - $ref: '#/components/schemas/ResourceCollection' - type: object required: - data properties: data: type: array items: $ref: '#/components/schemas/ShareGroupConsumerAssignmentData' ShareGroupState: type: string x-extensible-enum: - UNKNOWN - PREPARING_REBALANCE - COMPLETING_REBALANCE - STABLE - DEAD - EMPTY ResourceCollectionMetadata: type: object required: - self properties: self: type: string next: type: - string - 'null' ShareGroupConsumerDataList: allOf: - $ref: '#/components/schemas/ResourceCollection' - type: object required: - data properties: data: type: array items: $ref: '#/components/schemas/ShareGroupConsumerData' Resource: type: object required: - kind - metadata properties: kind: type: string metadata: $ref: '#/components/schemas/ResourceMetadata' ShareGroupConsumerAssignmentData: allOf: - $ref: '#/components/schemas/Resource' - type: object required: - cluster_id - group_id - consumer_id - topic_name - partition_id - partition properties: cluster_id: type: string group_id: type: string consumer_id: type: string topic_name: type: string partition_id: type: integer partition: $ref: '#/components/schemas/Relationship' ShareGroupData: allOf: - $ref: '#/components/schemas/Resource' - type: object required: - cluster_id - share_group_id - state - coordinator - consumers - consumer_count - partition_count properties: cluster_id: type: string share_group_id: type: string state: $ref: '#/components/schemas/ShareGroupState' coordinator: $ref: '#/components/schemas/Relationship' consumers: $ref: '#/components/schemas/Relationship' consumer_count: type: integer format: int32 description: Number of consumers in this share group partition_count: type: integer format: int32 description: Total number of partitions assigned to this share group across all consumers assigned_topic_partitions: type: array items: $ref: '#/components/schemas/ShareGroupTopicPartitionData' description: List of topic-partitions assigned to this share group, including those from empty groups ShareGroupConsumerData: allOf: - $ref: '#/components/schemas/Resource' - type: object required: - cluster_id - group_id - consumer_id - client_id - assignments properties: cluster_id: type: string group_id: type: string consumer_id: type: string client_id: type: string assignments: $ref: '#/components/schemas/Relationship' ShareGroupTopicPartitionData: allOf: - $ref: '#/components/schemas/Resource' - type: object required: - topic_name - partition_id - partition properties: topic_name: type: string description: The name of the topic partition_id: type: integer format: int32 description: The partition ID partition: $ref: '#/components/schemas/Relationship' description: Link to the topic partition ShareGroupDataList: allOf: - $ref: '#/components/schemas/ResourceCollection' - type: object required: - data properties: data: type: array items: $ref: '#/components/schemas/ShareGroupData' ResourceCollection: type: object required: - kind - metadata properties: kind: type: string metadata: $ref: '#/components/schemas/ResourceCollectionMetadata' ResourceMetadata: type: object required: - self properties: self: type: string resource_name: type: - string - 'null' responses: ForbiddenErrorResponse: description: Indicates a client authorization error. Kafka authorization failures will contain error code 40301 in the response body. content: application/json: schema: $ref: '#/components/schemas/Error' examples: kafka_authorization_failed: description: Thrown when the caller is not authorized to perform the underlying operation. value: error_code: 40301 message: Request is not authorized GetShareGroupResponse: description: The share group. content: application/json: schema: $ref: '#/components/schemas/ShareGroupData' example: kind: KafkaShareGroup metadata: self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1 resource_name: crn:///kafka=cluster-1/share-group=share-group-1 cluster_id: cluster-1 share_group_id: share-group-1 state: STABLE coordinator: related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/1 consumers: related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1/consumers consumer_count: 2 partition_count: 3 assigned_topic_partitions: - kind: KafkaShareGroupTopicPartition metadata: self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1/assigned-topic-partitions/topic-1/0 resource_name: crn:///kafka=cluster-1/share-group=share-group-1/topic-partition=topic-1:0 topic_name: topic-1 partition_id: 0 partition: related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/0 - kind: KafkaShareGroupTopicPartition metadata: self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1/assigned-topic-partitions/topic-1/1 resource_name: crn:///kafka=cluster-1/share-group=share-group-1/topic-partition=topic-1:1 topic_name: topic-1 partition_id: 1 partition: related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/1 ListShareGroupsResponse: description: The list of share groups. content: application/json: schema: $ref: '#/components/schemas/ShareGroupDataList' example: kind: KafkaShareGroupList metadata: self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups next: null data: - kind: KafkaShareGroup metadata: self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1 resource_name: crn:///kafka=cluster-1/share-group=share-group-1 cluster_id: cluster-1 share_group_id: share-group-1 state: STABLE coordinator: related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/1 consumers: related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1/consumers consumer_count: 2 partition_count: 3 assigned_topic_partitions: - kind: KafkaShareGroupTopicPartition metadata: self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1/assigned-topic-partitions/topic-1/0 resource_name: crn:///kafka=cluster-1/share-group=share-group-1/topic-partition=topic-1:0 topic_name: topic-1 partition_id: 0 partition: related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/0 - kind: KafkaShareGroup metadata: self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-2 resource_name: crn:///kafka=cluster-1/share-group=share-group-2 cluster_id: cluster-1 share_group_id: share-group-2 state: EMPTY coordinator: related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/2 consumers: related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-2/consumers consumer_count: 2 partition_count: 3 assigned_topic_partitions: - kind: KafkaShareGroupTopicPartition metadata: self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-2/assigned-topic-partitions/topic-1/0 resource_name: crn:///kafka=cluster-1/share-group=share-group-2/topic-partition=topic-1:0 topic_name: topic-1 partition_id: 0 partition: related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/0 BadRequestErrorResponse: description: Indicates a bad request error. It could be caused by an unexpected request body format or other forms of request validation failure. content: application/json: schema: $ref: '#/components/schemas/Error' examples: bad_request_cannot_deserialize: description: Thrown when trying to deserialize an integer from non-integer data. value: error_code: 400 message: 'Cannot deserialize value of type `java.lang.Integer` from String "A": not a valid `java.lang.Integer` value' unsupported_version_exception: description: Thrown when the version of this API is not supported in the underlying Kafka cluster. value: error_code: 40035 message: The version of this API is not supported in the underlying Kafka cluster. UnauthorizedErrorResponse: description: Indicates a client authentication error. Kafka authentication failures will contain error code 40101 in the response body. content: application/json: schema: $ref: '#/components/schemas/Error' examples: kafka_authentication_failed: description: Thrown when using Basic authentication with wrong Kafka credentials. value: error_code: 40101 message: Authentication failed TooManyRequestsErrorResponse: description: Indicates that a rate limit threshold has been reached, and the client should retry again later. content: text/html: schema: type: string example: description: A sample response from Jetty's DoSFilter. value:
| URI: | /v3/clusters/my-cluster |
|---|---|
| STATUS: | 429 |
| MESSAGE: | Too Many Requests |
| SERVLET: | default |