openapi: 3.2.0 info: description: Use Oracle Streaming with Apache Kafka Control Plane API to create/update/delete managed Kafka clusters. title: Oracle Streaming with Apache Kafka (OSAK) Kafka Cluster API version: '20240901' x-provenance: method: harvested first_party: true publisher: Oracle source: https://docs.oracle.com/en-us/iaas/api/specs/20737ba1cc15ca6941bfbbe2c9c672c4c8aac64b84d4892caf422bdd2f125081.yaml harvested: '2026-08-04' note: Published by Oracle as the contract for the Oracle Streaming with Apache Kafka (OSAK) API OCI service and stored verbatim; API Evangelist added only this provenance block. x-evidence: - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json what: Oracle's own index of every OCI service specification - url: https://docs.oracle.com/en-us/iaas/api/specs/20737ba1cc15ca6941bfbbe2c9c672c4c8aac64b84d4892caf422bdd2f125081.yaml what: the harvested document for Oracle Streaming with Apache Kafka (OSAK) API servers: - url: http://127.0.0.1/20240901 - url: https://127.0.0.1/20240901 tags: - name: kafkaCluster paths: /addonOptions: get: description: Gets a list of supported KafkaClusterAddons. operationId: ListAddonOptions parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByTimeCreatedQueryParam' responses: 200: description: A page of AddonOptionSummary objects. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AddonOptionCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of supported KafkaClusterAddons. tags: - kafkaCluster /kafkaClusterConfigs: get: description: 'Gets a list of KafkaClusterConfigs. ' operationId: ListKafkaClusterConfigs parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/ConfigLifecycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/KafkaClusterConfigIdentifierQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of KafkaClusterConfigSummary objects. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/KafkaClusterConfigCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of KafkaClusterConfigs. tags: - kafkaCluster x-related-resource: '#/definitions/KafkaClusterConfig' post: description: 'Creates a KafkaClusterConfig. ' operationId: CreateKafkaClusterConfig parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The KafkaClusterConfig created. headers: content-location: description: Same as location. schema: type: string format: uri-reference etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string location: description: URL for the created kafkaCluster. The kafkaCluster OCID is generated after this request is sent. schema: type: string format: uri-reference opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/KafkaClusterConfig' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a KafkaClusterConfig. tags: - kafkaCluster x-related-resource: '#/definitions/KafkaClusterConfig' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateKafkaClusterConfigDetails' description: Details for the new KafkaClusterConfig. required: true /kafkaClusterConfigs/{kafkaClusterConfigId}: delete: description: Deletes a KafkaClusterConfig. operationId: DeleteKafkaClusterConfig parameters: - $ref: '#/components/parameters/KafkaClusterConfigIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: The KafkaClusterConfig was deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes a KafkaClusterConfig. tags: - kafkaCluster x-related-resource: '#/definitions/KafkaClusterConfig' get: description: Gets information about a KafkaClusterConfig. operationId: GetKafkaClusterConfig parameters: - $ref: '#/components/parameters/KafkaClusterConfigIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The KafkaClusterConfig was retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/KafkaClusterConfig' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get KafkaClusterConfig tags: - kafkaCluster put: description: Updates a KafkaClusterConfig. operationId: UpdateKafkaClusterConfig parameters: - $ref: '#/components/parameters/KafkaClusterConfigIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The KafkaClusterConfig was updated. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/KafkaClusterConfig' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/405' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates a KafkaClusterConfig. tags: - kafkaCluster x-related-resource: '#/definitions/KafkaClusterConfig' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateKafkaClusterConfigDetails' description: The information to be updated. required: true /kafkaClusterConfigs/{kafkaClusterConfigId}/actions/changeCompartment: post: description: 'Moves a KafkaClusterConfig into a different compartment within the same tenancy. For information about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). ' operationId: ChangeKafkaClusterConfigCompartment parameters: - $ref: '#/components/parameters/KafkaClusterConfigIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: The KafkaClusterConfig was moved into a different compartment. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Moves a KafkaClusterConfig into a different compartment. tags: - kafkaCluster x-related-resource: '#/definitions/KafkaClusterConfig' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeKafkaClusterConfigCompartmentDetails' description: The information to be updated. required: true /kafkaClusterConfigs/{kafkaClusterConfigId}/versions: get: description: 'Gets a list of KafkaClusterConfig Versions. ' operationId: ListKafkaClusterConfigVersions parameters: - $ref: '#/components/parameters/KafkaClusterConfigIdentifierPathParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/KafkaClusterConfigVersionQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of kafka cluster config's version summary objects. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/KafkaClusterConfigVersionCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of KafkaClusterConfig Versions. tags: - kafkaCluster /kafkaClusterConfigs/{kafkaClusterConfigId}/versions/{versionNumber}: delete: description: Deletes a KafkaClusterConfig version. operationId: DeleteKafkaClusterConfigVersion parameters: - $ref: '#/components/parameters/KafkaClusterConfigIdentifierPathParam' - $ref: '#/components/parameters/KafkaClusterConfigVersionPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: The KafkaCluster config version was deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes a KafkaClusterConfig version. tags: - kafkaCluster x-related-resource: '#/definitions/KafkaClusterConfigVersion' get: description: Gets information about a KafkaClusterConfig version. operationId: GetKafkaClusterConfigVersion parameters: - $ref: '#/components/parameters/KafkaClusterConfigIdentifierPathParam' - $ref: '#/components/parameters/KafkaClusterConfigVersionPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The KafkaClusterConfig version was retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/KafkaClusterConfigVersion' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get KafkaClusterConfig version tags: - kafkaCluster /kafkaClusters: get: description: 'Gets a list of KafkaClusters. ' operationId: ListKafkaClusters parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/ClusterLifecycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/KafkaClusterIdentifierQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of KafkaClusterSummary objects. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/KafkaClusterCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of KafkaClusters. tags: - kafkaCluster x-related-resource: '#/definitions/KafkaCluster' post: description: 'Creates a KafkaCluster. ' operationId: CreateKafkaCluster parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: Accepted the request. The KafkaCluster will be created. headers: content-location: description: Same as location. schema: type: string format: uri-reference etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string location: description: URL for the created kafkaCluster. The kafkaCluster OCID is generated after this request is sent. schema: type: string format: uri-reference opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/KafkaCluster' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a KafkaCluster. tags: - kafkaCluster x-related-resource: '#/definitions/KafkaCluster' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateKafkaClusterDetails' description: Details for the new KafkaCluster. required: true /kafkaClusters/{kafkaClusterId}: delete: description: Deletes a KafkaCluster. operationId: DeleteKafkaCluster parameters: - $ref: '#/components/parameters/KafkaClusterIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The KafkaCluster will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes a KafkaCluster. tags: - kafkaCluster x-related-resource: '#/definitions/KafkaCluster' get: description: Gets information about a KafkaCluster. operationId: GetKafkaCluster parameters: - $ref: '#/components/parameters/KafkaClusterIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The KafkaCluster was retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/KafkaCluster' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get KafkaCluster tags: - kafkaCluster put: description: Updates a KafkaCluster. operationId: UpdateKafkaCluster parameters: - $ref: '#/components/parameters/KafkaClusterIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The KafkaCluster will be updated. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/KafkaCluster' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates a KafkaCluster. tags: - kafkaCluster x-related-resource: '#/definitions/KafkaCluster' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateKafkaClusterDetails' description: The information to be updated. required: true /kafkaClusters/{kafkaClusterId}/actions/changeCompartment: post: description: 'Moves a KafkaCluster into a different compartment within the same tenancy. For information about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). ' operationId: ChangeKafkaClusterCompartment parameters: - $ref: '#/components/parameters/KafkaClusterIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The KafkaCluster will be moved into a different compartment. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Moves a KafkaCluster into a different compartment. tags: - kafkaCluster x-related-resource: '#/definitions/KafkaCluster' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeKafkaClusterCompartmentDetails' description: The information to be updated. required: true /kafkaClusters/{kafkaClusterId}/actions/disableSuperuser: post: description: 'Removes the SASL superuser to the Kafka cluster. ' operationId: DisableSuperuser parameters: - $ref: '#/components/parameters/KafkaClusterIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. The superuser will be removed from the cluster. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Disables the Kafka cluster SASL superuser tags: - kafkaCluster x-obmcs-terraform: actionType: DISABLE identifier: Superuser x-related-resource: '#/definitions/KafkaCluster' /kafkaClusters/{kafkaClusterId}/actions/enableSuperuser: post: description: 'Adds a SASL superuser to the Kafka cluster. A generated password will be updated to the specified vault. ' operationId: EnableSuperuser parameters: - $ref: '#/components/parameters/KafkaClusterIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. A superuser will be added to the cluster. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Enables the Kafka cluster SASL superuser tags: - kafkaCluster x-obmcs-terraform: actionType: ENABLE identifier: Superuser x-related-resource: '#/definitions/KafkaCluster' requestBody: content: application/json: schema: $ref: '#/components/schemas/EnableSuperuserDetails' description: The information to be updated. required: true /kafkaClusters/{kafkaClusterId}/addons: get: description: Gets a list of KafkaClusterAddons. operationId: ListAddons parameters: - $ref: '#/components/parameters/KafkaClusterIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/AddonLifecycleStateQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/NameFilterQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByTimeCreatedQueryParam' responses: 200: description: A page of AddonSummary objects. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AddonCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of KafkaClusterAddons. tags: - kafkaCluster x-related-resource: '#/definitions/KafkaCluster' post: description: Installs a KafkaClusterAddon. operationId: InstallAddon parameters: - $ref: '#/components/parameters/KafkaClusterIdentifierPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: Accepted the request. The KafkaClusterAddon will be installed. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/KafkaClusterAddon' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Installs a KafkaClusterAddon. tags: - kafkaCluster x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/KafkaCluster' requestBody: content: application/json: schema: $ref: '#/components/schemas/InstallAddonDetails' description: Details for the new KafkaClusterAddon. required: true /kafkaClusters/{kafkaClusterId}/addons/{addonName}: delete: description: Uninstalls a KafkaClusterAddon in a provisioned cluster. operationId: UninstallAddon parameters: - $ref: '#/components/parameters/KafkaClusterIdentifierPathParam' - $ref: '#/components/parameters/AddonNamePathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: The KafkaClusterAddon was uninstalled. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Uninstalls a KafkaClusterAddon. tags: - kafkaCluster x-related-resource: '#/definitions/KafkaCluster' get: description: Gets information about a KafkaClusterAddon. operationId: GetAddon parameters: - $ref: '#/components/parameters/KafkaClusterIdentifierPathParam' - $ref: '#/components/parameters/AddonNamePathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The KafkaClusterAddon was retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/KafkaClusterAddon' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get KafkaClusterAddon tags: - kafkaCluster x-related-resource: '#/definitions/KafkaCluster' put: description: Installs updates on the existing KafkaClusterAddon. operationId: UpdateAddon parameters: - $ref: '#/components/parameters/KafkaClusterIdentifierPathParam' - $ref: '#/components/parameters/AddonNamePathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: The KafkaClusterAddon was updated. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/KafkaClusterAddon' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/405' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates a KafkaClusterAddon. tags: - kafkaCluster x-related-resource: '#/definitions/KafkaCluster' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateAddonDetails' description: The information to be updated. required: true /nodeShapes: get: description: Returns the list of shapes allowed in the region. operationId: ListNodeShapes parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/NameFilterQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' responses: 200: description: A list of available shapes. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/NodeShapeCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of all possible node shapes tags: - kafkaCluster x-related-resource: '#/definitions/KafkaCluster' /workRequests: get: description: 'Lists the work requests in a compartment. ' operationId: ListWorkRequests parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/WorkRequestIdQueryParam' - $ref: '#/components/parameters/WorkRequestStatusQueryParam' - $ref: '#/components/parameters/ResourceIdentifierQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/WorkRequestSortByQueryParam' responses: 200: description: The list of work requests was retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/WorkRequestSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: List work requests tags: - kafkaCluster x-related-resource: '#/definitions/WorkRequest' /workRequests/{workRequestId}: delete: description: Cancels a work request. operationId: CancelWorkRequest parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: The work request will be canceled. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Cancel work request tags: - kafkaCluster x-related-resource: '#/definitions/WorkRequest' get: description: Gets the details of a work request. operationId: GetWorkRequest parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The work request was retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string retry-after: description: A decimal number representing the number of seconds the client should wait before polling this endpoint again. schema: type: integer content: application/json: schema: $ref: '#/components/schemas/WorkRequest' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get work request status tags: - kafkaCluster x-related-resource: '#/definitions/WorkRequest' /workRequests/{workRequestId}/errors: get: description: 'Lists the errors for a work request. ' operationId: ListWorkRequestErrors parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/WorkRequestLogAndErrorSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' responses: 200: description: The list of work request errors was retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/WorkRequestErrorCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: List work request errors tags: - kafkaCluster x-related-resource: '#/definitions/WorkRequestError' /workRequests/{workRequestId}/logs: get: description: 'Lists the logs for a work request. ' operationId: ListWorkRequestLogs parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/WorkRequestLogAndErrorSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' responses: 200: description: The list of work request logs. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/WorkRequestLogEntryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: List work request logs tags: - kafkaCluster x-related-resource: '#/definitions/WorkRequestLogEntry' components: parameters: KafkaClusterConfigVersionPathParam: description: The versionNumber of the KafkaClusterConfig. in: path name: versionNumber required: true schema: type: integer minimum: 1 SortByQueryParam: description: 'The field to sort by. You can provide only one sort order. Default order for `timeCreated` is descending. Default order for `displayName` is ascending. ' in: query name: sortBy schema: type: string enum: - timeCreated - displayName default: timeCreated ConfigLifecycleStateQueryParam: description: 'A filter to return only resources that match the given lifecycle state. The state value is case-insensitive. ' in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/KafkaClusterConfig/lifecycleState' schema: type: string AddonLifecycleStateQueryParam: description: 'A filter to return only resources that match the given lifecycle state. The state value is case-insensitive. ' in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/KafkaClusterAddon/lifecycleState' schema: type: string ResourceIdentifierQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the resource affected by the work request. in: query name: resourceId x-default-description: 'null' schema: type: string SortByTimeCreatedQueryParam: description: 'The field to sort by. You can provide only one sort order. Default order for `timeCreated` is descending. ' in: query name: sortBy schema: type: string enum: - timeCreated default: timeCreated KafkaClusterConfigVersionQueryParam: description: 'The field to sort by. You can provide only one sort order. Default order for `versionNumber` is descending. ' in: query name: sortBy schema: type: string enum: - versionNumber default: versionNumber CompartmentIdQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. in: query name: compartmentId x-default-description: 'null' schema: type: string IfMatchHeader: description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource''s current etag value. ' in: header name: if-match required: false schema: type: string WorkRequestStatusQueryParam: description: A filter to return only the resources that match the given lifecycle state. in: query name: status required: false x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/OperationStatus' schema: type: string enum: - ACCEPTED - IN_PROGRESS - WAITING - NEEDS_ATTENTION - FAILED - SUCCEEDED - CANCELING - CANCELED PaginationLimitQueryParam: description: 'For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' in: query name: limit schema: type: integer default: 10 maximum: 1000 minimum: 1 NameFilterQueryParam: description: The name to filter on. in: query name: name schema: type: string WorkRequestIdPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. in: path name: workRequestId required: true schema: type: string SortOrderQueryParam: description: The sort order to use, either ascending (`ASC`) or descending (`DESC`). in: query name: sortOrder x-default-description: 'The default value depends upon `sortBy`, and in general is `DESC` when sorting by time and `ASC` otherwise. ' x-obmcs-top-level-enum: '#/definitions/SortOrder' schema: type: string enum: - ASC - DESC WorkRequestIdQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. in: query name: workRequestId x-default-description: 'null' schema: type: string AddonNamePathParam: description: The unique name of the KafkaClusterAddon. in: path name: addonName required: true schema: type: string WorkRequestLogAndErrorSortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for `timestamp` is descending. ' in: query name: sortBy schema: type: string enum: - timestamp default: timestamp KafkaClusterConfigIdentifierQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the KafkaClusterConfig. in: query name: id x-default-description: 'null' schema: type: string ClusterLifecycleStateQueryParam: description: 'A filter to return only resources that match the given lifecycle state. The state value is case-insensitive. ' in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/KafkaCluster/lifecycleState' schema: type: string RetryTokenHeader: description: 'A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of running that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and removed from the system, then a retry of the original creation request might be rejected. ' in: header name: opc-retry-token required: false schema: type: string maxLength: 64 minLength: 1 PaginationTokenQueryParam: description: 'For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' in: query name: page schema: type: string minLength: 1 DisplayNameQueryParam: description: A filter to return only resources that match the given display name exactly. in: query name: displayName x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 KafkaClusterIdentifierQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the KafkaCluster. in: query name: id x-default-description: 'null' schema: type: string WorkRequestSortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for `timeAccepted` is descending. ' in: query name: sortBy schema: type: string enum: - timeAccepted default: timeAccepted RequestIdHeader: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash. ' in: header name: opc-request-id schema: type: string KafkaClusterConfigIdentifierPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the KafkaClusterConfig. in: path name: kafkaClusterConfigId required: true schema: type: string KafkaClusterIdentifierPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the KafkaCluster. in: path name: kafkaClusterId required: true schema: type: string schemas: BootstrapUrl: description: Kafka bootstrap URL properties: name: description: Name of the Kafka listener providing this bootstrap URL type: string url: description: Bootstrap URL type: string required: - name - url type: object CreateKafkaClusterConfigDetails: description: The data to create a KafkaClusterConfig. properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to create the KafkaClusterConfig in. ' maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object latestConfig: $ref: '#/components/schemas/KafkaClusterConfigVersion' required: - compartmentId - latestConfig type: object KafkaClusterCollection: description: Results of a kafkaCluster search. Contains both KafkaClusterSummary items and other information, such as metadata. properties: items: description: List of kafkaClusters. items: $ref: '#/components/schemas/KafkaClusterSummary' type: array required: - items type: object NodeShapeSummary: description: Summary of the shape. properties: name: description: The name of the shape maxLength: 255 minLength: 1 type: string required: - name type: object CreateKafkaClusterDetails: description: The data to create a KafkaCluster. properties: accessSubnets: description: Subnets where broker/coordinator VNICs will be created. items: $ref: '#/components/schemas/SubnetSet' type: array brokerShape: $ref: '#/components/schemas/BrokerShape' clientCertificateBundle: description: CA certificate bundle for mTLS broker authentication. type: string clusterConfigId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of Kafka Cluster configuration object type: string clusterConfigVersion: description: The version of configuration object type: integer clusterType: description: "Type of the cluster to spin up. \nDEVELOPMENT - setting that allows to sacrifice HA and spin up cluster on single node\nPRODUCTION - Minimum allowed broker count is 3\n" type: string x-obmcs-enumref: '#/definitions/KafkaCluster/clusterType' compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to create the KafkaCluster in. ' maxLength: 255 minLength: 1 type: string coordinationType: description: Kafka coordination type. Set of available types depends on Kafka version type: string x-obmcs-enumref: '#/definitions/KafkaCluster/coordinationType' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object kafkaVersion: description: Version of Kafka to use to spin up the cluster type: string required: - compartmentId - accessSubnets - kafkaVersion - brokerShape - clusterType - clusterConfigId - clusterConfigVersion - coordinationType type: object KafkaClusterConfig: description: 'A shared configuration object used by 0 or more kafka clusters. To use any of the API operations, you must be authorized in an IAM policy. If you''re not authorized, talk to an administrator. If you''re an administrator who needs to write policies to give users access, see [Getting Started with Policies](/iaas/Content/Identity/policiesgs/get-started-with-policies.htm). ' properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: A user-friendly name. Does not have to be unique, and it's changeable. type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the KafkaClusterConfig. type: string latestConfig: $ref: '#/components/schemas/KafkaClusterConfigVersion' lifecycleDetails: description: 'A message that describes the current state of the KafkaClusterConfig in more detail. For example, can be used to provide actionable information for a resource in the Failed state. ' type: string lifecycleState: description: The current state of the KafkaClusterConfig. enum: - CREATING - ACTIVE - UPDATING - DELETED type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a system tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The date and time the KafkaClusterConfig was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time the KafkaClusterConfig was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string required: - id - compartmentId - lifecycleState - timeCreated - displayName - freeformTags - definedTags - latestConfig type: object AddonOptionCollection: description: 'Results of a AddonOptions search. Contains AddonOptionSummary items ' properties: items: description: List of kafka Cluster AddonOptions. items: $ref: '#/components/schemas/AddonOptionSummary' type: array required: - items type: object KafkaClusterConfigSummary: description: Summary information about a KafkaClusterConfig. properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: A user-friendly name. Does not have to be unique, and it's changeable. type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the KafkaClusterConfig. type: string lifecycleDetails: description: 'A message that describes the current state of the KafkaClusterConfig in more detail. For example, can be used to provide actionable information for a resource in the Failed state. ' type: string lifecycleState: description: The current state of the KafkaClusterConfig. type: string x-obmcs-enumref: '#/definitions/KafkaClusterConfig/lifecycleState' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a system tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The date and time the KafkaClusterConfig was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time the KafkaClusterConfig was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string required: - id - compartmentId - lifecycleState - timeCreated - displayName - freeformTags - definedTags type: object Error: description: Error information. properties: code: description: A short error code that defines the error, meant for programmatic parsing. type: string message: description: A human-readable error message. type: string required: - code - message UpdateKafkaClusterDetails: description: The data to update a KafkaCluster. properties: accessSubnets: description: Subnets where broker/coordinator VNICs will be created. items: $ref: '#/components/schemas/SubnetSet' type: array brokerShape: $ref: '#/components/schemas/BrokerShape' clientCertificateBundle: description: CA certificate bundle for mTLS broker authentication. type: string clusterConfigId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of Kafka Cluster configuration object type: string clusterConfigVersion: description: The version of configuration object type: integer coordinationType: description: Kafka coordination type. Set of available types depends on Kafka version type: string x-obmcs-enumref: '#/definitions/KafkaCluster/coordinationType' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object type: object ChangeKafkaClusterCompartmentDetails: description: The configuration details for the move operation. properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the KafkaCluster to. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object EnableSuperuserDetails: description: The configuration details for the enable superuser operation. properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the superuser secret. maxLength: 255 minLength: 1 type: string secretId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the secret that will be populated with the generated superuser password. ' maxLength: 255 minLength: 1 type: string required: - compartmentId - secretId type: object AddonCollection: description: 'Results of a kafkaClusterAddon search. Contains both AddonSummary items and other information. ' properties: items: description: List of kafkaClusterAddons. items: $ref: '#/components/schemas/AddonSummary' type: array required: - items type: object ChangeKafkaClusterConfigCompartmentDetails: description: The configuration details for the move operation. properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the KafkaClusterConfig to. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object KafkaCluster: description: 'A KafkaCluster is a description of a KafkaCluster. To use any of the API operations, you must be authorized in an IAM policy. If you''re not authorized, talk to an administrator. If you''re an administrator who needs to write policies to give users access, see [Getting Started with Policies](/iaas/Content/Identity/policiesgs/get-started-with-policies.htm). ' properties: accessSubnets: description: Subnets where broker/coordinator VNICs will be created. items: $ref: '#/components/schemas/SubnetSet' type: array brokerShape: $ref: '#/components/schemas/BrokerShape' clientCertificateBundle: description: CA certificate bundle for mTLS broker authentication. type: string clusterConfigId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of Kafka Cluster configuration object type: string clusterConfigVersion: description: The version of configuration object type: integer clusterType: description: "Type of the cluster to spin up. \nDEVELOPMENT - setting that allows to sacrifice HA and spin up cluster on a single node\nPRODUCTION - Minimum allowed broker count is 3\n" enum: - DEVELOPMENT - PRODUCTION type: string compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. type: string coordinationType: description: Kafka coordination type. Set of available types depends on Kafka version enum: - ZOOKEEPER - KRAFT type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: A user-friendly name. Does not have to be unique, and it's changeable. type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the KafkaCluster. type: string kafkaBootstrapUrls: description: Bootstrap URL that can be used to connect to Kafka items: $ref: '#/components/schemas/BootstrapUrl' type: array kafkaVersion: description: Version of Kafka to use to spin up the cluster type: string lifecycleDetails: description: 'A message that describes the current state of the KafkaCluster in more detail. For example, can be used to provide actionable information for a resource in the Failed state. ' type: string lifecycleState: description: The current state of the KafkaCluster. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string secretId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the secret that contains superuser password. type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a system tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The date and time the KafkaCluster was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time the KafkaCluster was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string required: - id - compartmentId - lifecycleState - timeCreated - displayName - freeformTags - definedTags - accessSubnets - kafkaVersion - brokerShape - clusterType - clusterConfigId - clusterConfigVersion type: object AddonSummary: description: Summary information about a KafkaClusterAddon. properties: addonType: description: Addon Type type: string x-obmcs-enumref: '#/definitions/KafkaClusterAddon/addonType' lifecycleDetails: description: 'A message that describes the current state of the KafkaClusterAddon in more detail. For example, can be used to provide actionable information for a resource in the Failed state. ' type: string lifecycleState: description: The current state of the KafkaClusterAddon. type: string x-obmcs-enumref: '#/definitions/KafkaClusterAddon/lifecycleState' name: description: A user-friendly name. type: string timeCreated: description: "The date and time the KafkaClusterAddon was created, in the format defined by \n[RFC 3339](https://tools.ietf.org/html/rfc3339).\n\nExample: `2016-08-25T21:10:29.600Z`\n" format: date-time type: string timeUpdated: description: "The date and time the KafkaClusterAddon was updated, in the format defined by \n[RFC 3339](https://tools.ietf.org/html/rfc3339).\n\nExample: `2016-08-25T21:10:29.600Z`\n" format: date-time type: string required: - name - addonType - lifecycleState type: object KafkaClusterConfigVersionCollection: description: Results of a kafkaClusterConfigVersion search. Contains both KafkaClusterConfigVersionSummary items. properties: items: description: List of kafkaClustersConfigVersion. items: $ref: '#/components/schemas/KafkaClusterConfigVersionSummary' maxItems: 10 minItems: 1 type: array required: - items type: object BrokerShape: description: Configuration of the broker node. properties: nodeCount: description: Number of Kafka broker nodes minimum: 1 type: integer nodeShape: description: Node shape for broker is passed as part of cluster creation, similar to VM.Standard.A1.Flex type: string ocpuCount: description: Number of OCPUs per nodes maximum: 80 minimum: 1 type: integer storageSizeInGbs: default: 50 description: Size of the storage per nodes. maximum: 16000 minimum: 50 multipleOf: 50 type: integer required: - nodeCount - ocpuCount type: object UpdateAddonDetails: description: The data to update a KafkaClusterAddon. discriminator: propertyName: addonType properties: addonType: description: This is Addon Type of OCI kafka cluster readOnly: true type: string x-obmcs-enumref: '#/definitions/KafkaClusterAddon/addonType' description: description: A unique user-friendly name. Avoid entering confidential information. type: string KafkaClusterAddon: description: The base data object to represent a KafkaClusterAddon. discriminator: propertyName: addonType properties: addonType: description: The type of addon enum: - PUBLICCONNECTIVITY readOnly: true type: string description: description: Description of the add on type: string lifecycleState: description: The current state of the KafkaCluster. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string name: description: A unique user-friendly name. type: string timeCreated: description: The time the addon was created. example: '2017-07-21T16:11:29Z' format: date-time type: string timeUpdated: description: The time the addon was updated. example: '2017-07-21T16:12:29Z' format: date-time type: string required: - name - addonType - lifecycleState type: object SubnetSet: description: Summary information about a KafkaCluster. properties: subnets: description: Subnets OCIDs items: type: string maxItems: 10 minItems: 1 type: array required: - subnets type: object WorkRequestResource: description: A resource created or operated on by a work request. properties: actionType: description: 'The way in which this resource is affected by the operation tracked in the work request. A resource being created, updated, or deleted remains in the IN_PROGRESS state until work is complete for that resource, at which point it transitions to CREATED, UPDATED, or DELETED, respectively. ' enum: - CREATED - UPDATED - DELETED - IN_PROGRESS - RELATED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/ActionType' entityType: description: The resource type that the work request affects. type: string entityUri: description: The URI path that you can use for a GET request to access the resource metadata. type: string identifier: description: An [OCID](/iaas/Content/General/Concepts/identifiers.htm) or other unique identifier for the resource. type: string metadata: additionalProperties: type: string description: Additional information that helps to explain the resource. enum: - IS_DRY_RUN type: object x-obmcs-top-level-enum: '#/definitions/WorkRequestResourceMetadataKey' required: - actionType - entityType - identifier NodeShapeCollection: description: Results of a NodeShapeCollection search. properties: items: description: List of NodeShapeSummary. items: $ref: '#/components/schemas/NodeShapeSummary' type: array required: - items type: object WorkRequestSummaryCollection: description: A list of work requests. Can contain both work requests and other information, such as metadata. properties: items: description: A list of work requests. items: $ref: '#/components/schemas/WorkRequestSummary' type: array required: - items type: object KafkaClusterConfigVersionSummary: description: Summary information about a KafkaClusterConfigVersion. properties: configId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the KafkaClusterConfig. type: string timeCreated: description: 'The date and time the KafkaClusterConfigVersion was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string versionNumber: description: Version of the cluster configuration type: integer required: - configId - versionNumber - timeCreated type: object WorkRequestErrorCollection: description: A list of work request errors. Can contain both errors and other information, such as metadata. properties: items: description: A list of work request errors. items: $ref: '#/components/schemas/WorkRequestError' type: array required: - items type: object AddonOptionSummary: description: Summary information about a AddonOptions. properties: lifecycleState: description: The current state of the KafkaClusterAddon. enum: - ACTIVE - INACTIVE type: string name: description: A user-friendly name. type: string required: - name - lifecycleState type: object InstallAddonDetails: description: The data to create a KafkaClusterAddon. discriminator: propertyName: addonType properties: addonType: description: This is Addon Type of OCI kafka cluster type: string x-obmcs-enumref: '#/definitions/KafkaClusterAddon/addonType' description: description: A brief description of the add on being installed. type: string name: description: A unique user-friendly name. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string required: - name - addonType KafkaClusterSummary: description: Summary information about a KafkaCluster. properties: accessSubnets: description: Subnets where broker/coordinator VNICs will be created. items: $ref: '#/components/schemas/SubnetSet' type: array brokerShape: $ref: '#/components/schemas/BrokerShape' clusterConfigId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of Kafka Cluster configuration object type: string clusterConfigVersion: description: The version of configuration object type: integer clusterType: description: "Type of the cluster to spin up. \nDEVELOPMENT - setting that allows to sacrifice HA and spin up cluster on single node\nPRODUCTION - Minimum allowed broker count is 3\n" type: string x-obmcs-enumref: '#/definitions/KafkaCluster/clusterType' compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. type: string coordinationType: description: Kafka coordination type. Set of available types depends on Kafka version type: string x-obmcs-enumref: '#/definitions/KafkaCluster/coordinationType' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: A user-friendly name. Does not have to be unique, and it's changeable. type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the KafkaCluster. type: string kafkaVersion: description: Version of Kafka to use to spin up the cluster type: string lifecycleDetails: description: 'A message that describes the current state of the KafkaCluster in more detail. For example, can be used to provide actionable information for a resource in the Failed state. ' type: string lifecycleState: description: The current state of the KafkaCluster. type: string x-obmcs-enumref: '#/definitions/KafkaCluster/lifecycleState' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a system tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The date and time the KafkaCluster was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time the KafkaCluster was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string required: - id - compartmentId - lifecycleState - timeCreated - displayName - freeformTags - definedTags - accessSubnets - kafkaVersion - brokerShape - clusterType - clusterConfigId - clusterConfigVersion type: object WorkRequestSummary: description: Summary information about an asynchronous work request. properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the work request. ' type: string id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. type: string operationType: description: The asynchronous operation tracked by this work request. enum: - CREATE_KAFKA_CLUSTER - UPDATE_KAFKA_CLUSTER - DELETE_KAFKA_CLUSTER - MOVE_KAFKA_CLUSTER - ENABLE_SUPERUSER - DISABLE_SUPERUSER - INSTALL_KAFKA_CLUSTER_ADDON - UPDATE_KAFKA_CLUSTER_ADDON - UNINSTALL_KAFKA_CLUSTER_ADDON type: string x-obmcs-top-level-enum: '#/definitions/OperationType' percentComplete: description: 'Shows the progress of the operation tracked by the work request, as a percentage of the total work that must be performed. ' format: float type: number resources: description: The resources that are affected by this work request. items: $ref: '#/components/schemas/WorkRequestResource' type: array status: description: The status of the work request. enum: - ACCEPTED - IN_PROGRESS - WAITING - NEEDS_ATTENTION - FAILED - SUCCEEDED - CANCELING - CANCELED type: string x-obmcs-top-level-enum: '#/definitions/OperationStatus' timeAccepted: description: 'The date and time the work request was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). ' format: date-time type: string timeFinished: description: 'The date and time the work request was finished, in the format defined by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). ' format: date-time type: string timeStarted: description: 'The date and time the work request was started, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). ' format: date-time type: string timeUpdated: description: 'The date and time the work request was updated, in the format defined by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). ' format: date-time type: string required: - operationType - status - id - compartmentId - resources - percentComplete - timeAccepted KafkaClusterConfigVersion: description: 'A shared configuration object used by 0 or more kafka clusters. ' properties: configId: description: ID cluster configuration type: string properties: additionalProperties: type: string description: Cluster configuration key-value pairs maxProperties: 1000 type: object timeCreated: description: 'The date and time the KafkaClusterConfigVersion was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string versionNumber: description: Version of the cluster configuration type: integer required: - properties type: object WorkRequestError: description: An error encountered while performing an operation that is tracked by a work request. properties: code: description: 'A machine-usable code for the error that occurred. For a list of error codes, see [API Errors](/iaas/Content/API/References/apierrors.htm). ' type: string message: description: A human-readable error message. type: string timestamp: description: 'The date and time the error occurred, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). ' format: date-time type: string required: - code - message - timestamp UpdateKafkaClusterConfigDetails: description: The data to update a KafkaClusterConfig. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object latestConfig: $ref: '#/components/schemas/KafkaClusterConfigVersion' type: object WorkRequestLogEntry: description: A log message from performing an operation that is tracked by a work request. properties: message: description: A human-readable log message. type: string timestamp: description: 'The date and time the log message was written, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). ' format: date-time type: string required: - message - timestamp KafkaClusterConfigCollection: description: Results of a kafkaClusterConfig search. Contains both KafkaClusterConfigSummary items and other information, such as metadata. properties: items: description: List of kafkaClustersConfig. items: $ref: '#/components/schemas/KafkaClusterConfigSummary' type: array required: - items type: object WorkRequestLogEntryCollection: description: A list of work request logs. Can contain both logs and other information, such as metadata. properties: items: description: A list of work request log entries. items: $ref: '#/components/schemas/WorkRequestLogEntry' type: array required: - items type: object WorkRequest: description: 'An asynchronous work request. Work requests help you monitor long-running operations. When you start a long-running operation, the service creates a work request. A work request is an activity log that lets you track each step in the operation''s progress. Each work request has an OCID that lets you interact with it programmatically and use it for automation. ' properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the work request. ' type: string id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. type: string operationType: description: The asynchronous operation tracked by this work request. enum: - CREATE_KAFKA_CLUSTER - UPDATE_KAFKA_CLUSTER - DELETE_KAFKA_CLUSTER - MOVE_KAFKA_CLUSTER - ENABLE_SUPERUSER - DISABLE_SUPERUSER - INSTALL_KAFKA_CLUSTER_ADDON - UPDATE_KAFKA_CLUSTER_ADDON - UNINSTALL_KAFKA_CLUSTER_ADDON type: string x-obmcs-top-level-enum: '#/definitions/OperationType' percentComplete: description: 'Shows the progress of the operation tracked by the work request, as a percentage of the total work that must be performed. ' format: float type: number resources: description: The resources that are affected by the work request. items: $ref: '#/components/schemas/WorkRequestResource' type: array status: description: The status of the work request. enum: - ACCEPTED - IN_PROGRESS - WAITING - NEEDS_ATTENTION - FAILED - SUCCEEDED - CANCELING - CANCELED type: string x-obmcs-top-level-enum: '#/definitions/OperationStatus' timeAccepted: description: 'The date and time the work request was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). ' format: date-time type: string timeFinished: description: 'The date and time the work request was finished, in the format defined by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). ' format: date-time type: string timeStarted: description: 'The date and time the work request was started, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). ' format: date-time type: string timeUpdated: description: 'The date and time the work request was updated, in the format defined by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). ' format: date-time type: string required: - operationType - status - id - compartmentId - resources - percentComplete - timeAccepted responses: default: description: Unknown Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' x-anchors: x-headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' type: string opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' type: string retry-after: description: A decimal number representing the number of seconds the client should wait before polling this endpoint again. type: integer x-properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a system tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object x-tag-groups: addons: - kafkaCluster kafkaCluster: - kafkaCluster kafkaClusterConfig: - kafkaCluster shapes: - kafkaCluster workRequest: - kafkaCluster x-obmcs-client-retries-enabled: true x-oracle-package: com.oracle.oci.kafka