openapi: 3.2.0
info:
  description: API for managing cluster placement groups.
  title: Cluster Placement Groups Cluster Placement Groups CP API
  version: '20230801'
  x-provenance:
    method: harvested
    first_party: true
    publisher: Oracle
    source: https://docs.oracle.com/en-us/iaas/api/specs/94747eeacc55eb7860de779ab6595387dd81dad6e01e21c95540797fa15ac913.yaml
    harvested: '2026-08-04'
    note: Published by Oracle as the contract for the Cluster Placement Groups 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/94747eeacc55eb7860de779ab6595387dd81dad6e01e21c95540797fa15ac913.yaml
    what: the harvested document for Cluster Placement Groups API
servers:
- url: http://127.0.0.1/20230801
- url: https://127.0.0.1/20230801
tags:
- name: ClusterPlacementGroupsCP
paths:
  /clusterPlacementGroups:
    get:
      description: 'Gets a list of all cluster placement groups in the specified compartment.

        '
      operationId: ListClusterPlacementGroups
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/LifecycleStateQueryParam'
      - $ref: '#/components/parameters/NameQueryParam'
      - $ref: '#/components/parameters/AvailabilityDomain_query'
      - $ref: '#/components/parameters/ClusterPlacementGroupIdentifierQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/CompartmentIdInSubtree_query'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: A page of cluster placement group summary objects.
          headers:
            opc-next-page:
              description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,

                then there are additional items to get. Include this value as the `page` parameter for the

                subsequent GET request to get the next batch of items. For information about pagination, see [List Pagination](/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/ClusterPlacementGroupCollection'
        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 cluster placement groups.
      tags:
      - ClusterPlacementGroupsCP
      x-example: 'GET /20230801/clusterPlacementGroups?compartmentId=ocid1.tenancy.oc1..examplemyog6kcvbvq5dlzojpa7fauxila6fj4azxmethmwa

        Host: clusterplacementgroups.us-ashburn-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/ClusterPlacementGroupCollection'
    post:
      description: 'Creates a new cluster placement group in the specified compartment.

        '
      operationId: CreateClusterPlacementGroup
      parameters:
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/DryRun_header'
      responses:
        201:
          description: The request was accepted. The cluster placement group is being 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: The URL for the created cluster placement group. The cluster placement group ID 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: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClusterPlacementGroup'
        204:
          description: Validation completed successfully.
          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: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status.

                '
              schema:
                type: string
        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 new cluster placement group.
      tags:
      - ClusterPlacementGroupsCP
      x-example: "POST /20230801/clusterPlacementGroups\nHost: clusterplacementgroups.us-ashburn-1.oci.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"name\" : \"testclusterplacementgroup\",\n  \"clusterPlacementGroupType\" : \"STANDARD\",\n  \"availabilityDomain\" : \"ABcd:US-ASHBURN-1\",\n  \"description\" : \"test cluster placement group\",\n  \"compartmentId\" : \"ocid1.tenancy.oc1..examplemyog6kcvbvq5dlzojpa7fauxila6fj4azxmethmwa\",\n  \"capabilities\" : {\n    \"items\" : [\n      {\n        \"service\" : \"block-storage\",\n        \"name\" : \"volume\"\n      },\n      {\n        \"service\" : \"compute\",\n        \"name\" : \"general\"\n      }\n    ]\n  }\n}\n"
      x-related-resource: '#/definitions/ClusterPlacementGroup'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateClusterPlacementGroupDetails'
        description: The details for creating the new cluster placement group.
        required: true
  /clusterPlacementGroups/{clusterPlacementGroupId}:
    delete:
      description: Deletes the specified cluster placement group.
      operationId: DeleteClusterPlacementGroup
      parameters:
      - $ref: '#/components/parameters/ClusterPlacementGroupIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: The request was accepted. The cluster placement group is being 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: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Delete a provisioned cluster placement group.
      tags:
      - ClusterPlacementGroupsCP
      x-example: 'DELETE /20230801/clusterPlacementGroups/ocid1.clusterplacementgroup.oc1.iad.example7kwcej5cvbf23yyraup4uzr6fauxakv7ccyhjjoq

        Host: clusterplacementgroups.us-ashburn-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/ClusterPlacementGroup'
    get:
      description: Gets the specified cluster placement group.
      operationId: GetClusterPlacementGroup
      parameters:
      - $ref: '#/components/parameters/ClusterPlacementGroupIdentifierPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The cluster placement group with the specified OCID.
          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/ClusterPlacementGroup'
        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 a cluster placement group.
      tags:
      - ClusterPlacementGroupsCP
      x-example: 'GET /20230801/clusterPlacementGroups/ocid1.clusterplacementgroup.oc1.iad.example7kwcej5cvbf23yyraup4uzr6fauxakv7ccyhjjoq

        Host: clusterplacementgroups.us-ashburn-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
    put:
      description: Updates the specified cluster placement group.
      operationId: UpdateClusterPlacementGroup
      parameters:
      - $ref: '#/components/parameters/ClusterPlacementGroupIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          $ref: '#/components/responses/202_ClusterPlacementGroupUpdated'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        405:
          $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: Update a cluster placement group.
      tags:
      - ClusterPlacementGroupsCP
      x-example: "PUT /20230801/clusterPlacementGroups/ocid1.clusterplacementgroup.oc1.iad.example7kwcej5cvbf23yyraup4uzr6fauxakv7ccyhjjoq\nHost: clusterplacementgroups.us-ashburn-1.oci.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"description\" : \"updated test cluster placement group description\"\n}\n"
      x-related-resource: '#/definitions/ClusterPlacementGroup'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateClusterPlacementGroupDetails'
        description: The details of the cluster placement group to update.
        required: true
  /clusterPlacementGroups/{clusterPlacementGroupId}/actions/activate:
    post:
      description: 'Activates the specified, previously deactivated cluster placement group to let resources be created in it.

        '
      operationId: ActivateClusterPlacementGroup
      parameters:
      - $ref: '#/components/parameters/ClusterPlacementGroupIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        200:
          $ref: '#/components/responses/200OK_ClusterPlacementGroupDetails'
        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: Activate a cluster placement group.
      tags:
      - ClusterPlacementGroupsCP
      x-example: 'POST /20230801/clusterPlacementGroups/ocid1.clusterplacementgroup.oc1.iad.example7kwcej5cvbf23yyraup4uzr6fauxakv7ccyhjjoq/actions/activate

        Host: clusterplacementgroups.us-ashburn-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-obmcs-terraform:
        actionType: START
      x-related-resource: '#/definitions/ClusterPlacementGroup'
  /clusterPlacementGroups/{clusterPlacementGroupId}/actions/changeCompartment:
    post:
      description: 'Moves a cluster placement group resource from one compartment to another in the same tenancy. For information about

        moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).


        When provided, If-Match is checked against ETag values of the resource.

        '
      operationId: ChangeClusterPlacementGroupCompartment
      parameters:
      - $ref: '#/components/parameters/ClusterPlacementGroupIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        204:
          $ref: '#/components/responses/204_ClusterPlacementGroupMoved'
        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: Move a cluster placement group to a different compartment.
      tags:
      - ClusterPlacementGroupsCP
      x-example: "PUT /20230801/clusterPlacementGroups/actions/changeCompartment\nHost: clusterplacementgroups.us-ashburn-1.oci.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"compartmentId\" : \"ocid1.compartment.oc1..exampledcvbgd7hkv5a6d35b3fauxcofhmoeprcjm4fpa\"\n}\n"
      x-related-resource: '#/definitions/ClusterPlacementGroup'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangeClusterPlacementGroupCompartmentDetails'
        description: The details of the updated compartment.
        required: true
  /clusterPlacementGroups/{clusterPlacementGroupId}/actions/deactivate:
    post:
      description: Deactivates the specified cluster placement group to prevent new resources from being created in it.
      operationId: DeactivateClusterPlacementGroup
      parameters:
      - $ref: '#/components/parameters/ClusterPlacementGroupIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        200:
          $ref: '#/components/responses/200OK_ClusterPlacementGroupDetails'
        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: Deactivate a cluster placement group.
      tags:
      - ClusterPlacementGroupsCP
      x-example: 'POST /20230801/clusterPlacementGroups/ocid1.clusterplacementgroup.oc1.iad.example7kwcej5cvbf23yyraup4uzr6fauxakv7ccyhjjoq/actions/deactivate

        Host: clusterplacementgroups.us-ashburn-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-obmcs-terraform:
        actionType: STOP
      x-related-resource: '#/definitions/ClusterPlacementGroup'
  /workRequests:
    get:
      description: 'Lists all work requests in the specified 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: A list of work request summaries.
          headers:
            opc-next-page:
              description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,

                then there are additional items to get. Include this value as the `page` parameter for the

                subsequent GET request to get the next batch of items. For information about pagination, see [List Pagination](/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:
      - ClusterPlacementGroupsCP
      x-example: 'GET /20230801/workRequests?compartmentId=ocid1.tenancy.oc1..exampleddcvbfxlj5w6l5faux3pa5ysj7p4375oem7mgq

        Host: clusterplacementgroups.us-ashburn-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/WorkRequest'
  /workRequests/{workRequestId}:
    delete:
      description: Cancels the work request with the specified ID.
      operationId: CancelWorkRequest
      parameters:
      - $ref: '#/components/parameters/WorkRequestIdPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: The work request is being 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:
      - ClusterPlacementGroupsCP
      x-example: 'DELETE /20230801/workRequests/ocid1.clusterplacementgroupworkrequest.oc1.iad.examplebapgccvbv4f3ldrzulk3ifauxdo4zwy6gsgdgq

        Host: clusterplacementgroups.us-ashburn-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/WorkRequest'
    get:
      description: Gets details of the work request with the specified ID.
      operationId: GetWorkRequest
      parameters:
      - $ref: '#/components/parameters/WorkRequestIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The details of the work request.
          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:
      - ClusterPlacementGroupsCP
      x-example: 'GET /20230801/workRequests/ocid1.clusterplacementgroupworkrequest.oc1.iad.examplebapgccvbv4f3ldrzulk3ifauxdo4zwy6gsgdgq

        Host: clusterplacementgroups.us-ashburn-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/WorkRequest'
  /workRequests/{workRequestId}/errors:
    get:
      description: 'Returns a (paginated) list of errors for the work request with the specified ID.

        '
      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.
          headers:
            opc-next-page:
              description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,

                then there are additional items to get. Include this value as the `page` parameter for the

                subsequent GET request to get the next batch of items. For information about pagination, see [List Pagination](/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:
      - ClusterPlacementGroupsCP
      x-example: 'GET /20230801/workRequests/ocid1.clusterplacementgroupworkrequest.oc1.iad.examplebapgccvbv4f3ldrzulk3ifauxdo4zwy6gsgdgq/errors

        Host: clusterplacementgroups.us-ashburn-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/WorkRequestError'
  /workRequests/{workRequestId}/logs:
    get:
      description: 'Returns a (paginated) list of logs for the work request with the specified ID.

        '
      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 pagination of a list of items. When paging through a list, if this header appears in the response,

                then there are additional items to get. Include this value as the `page` parameter for the

                subsequent GET request to get the next batch of items. For information about pagination, see [List Pagination](/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:
      - ClusterPlacementGroupsCP
      x-example: "GET /20230801/workRequests/ocid1.clusterplacementgroupworkrequest.oc1.iad.examplebapgccvbv4f3ldrzulk3ifauxdo4zwy6gsgdgq/logs\nHost: clusterplacementgroups.us-ashburn-1.oci.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>        \n"
      x-related-resource: '#/definitions/WorkRequestLogEntry'
components:
  parameters:
    CompartmentIdInSubtree_query:
      description: 'When set to `true`, cluster placement groups in all compartments under the specified compartment are returned. The default is set to `false`.

        '
      in: query
      name: compartmentIdInSubtree
      required: false
      schema:
        type: boolean
        default: false
    NameQueryParam:
      description: A filter to return only the resources that match the entire display name specified.
      in: query
      name: name
      x-default-description: 'null'
      schema:
        type: string
        maxLength: 255
        minLength: 1
    PaginationTokenQueryParam:
      description: A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
      in: query
      name: page
      schema:
        type: string
        minLength: 1
    SortByQueryParam:
      description: 'The field to sort by. You can specify only one sort order. The default order for `timeCreated` is descending. The default order for `name` is ascending.

        '
      in: query
      name: sortBy
      schema:
        type: string
        enum:
        - timeCreated
        - name
        - id
        default: timeCreated
    DryRun_header:
      description: 'When set to `true`, the request performs validation on the submitted data without modifying configuration item details.

        '
      in: header
      name: opc-dry-run
      required: false
      schema:
        type: boolean
        default: false
    ResourceIdentifierQueryParam:
      description: The ID of the resource affected by the work request.
      in: query
      name: resourceId
      x-default-description: 'null'
      schema:
        type: string
    AvailabilityDomain_query:
      description: A filter to return only the resources that match the specified availability domain.
      in: query
      name: ad
      required: false
      x-default-description: If availability domain parameter is not specified, resources from all availability domains are returned.
      schema:
        type: string
        default: null
    CompartmentIdQueryParam:
      description: 'A filter to return only the resources that match the specified compartment [OCID](/iaas/Content/General/Concepts/identifiers.htm).

        '
      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 resources with a lifecycle state that matches the specified operation status.
      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
    ClusterPlacementGroupIdentifierPathParam:
      description: A unique cluster placement group identifier.
      in: path
      name: clusterPlacementGroupId
      required: true
      schema:
        type: string
    PaginationLimitQueryParam:
      description: The maximum number of items to return.
      in: query
      name: limit
      schema:
        type: integer
        default: 10
        maximum: 1000
        minimum: 1
    LifecycleStateQueryParam:
      description: A filter to return only the resources that match the specified lifecycle state.
      in: query
      name: lifecycleState
      required: false
      x-default-description: 'null'
      x-obmcs-enumref: '#/definitions/ClusterPlacementGroup/lifecycleState'
      schema:
        type: string
    WorkRequestIdPathParam:
      description: The ID of the asynchronous work request.
      in: path
      name: workRequestId
      required: true
      schema:
        type: string
    WorkRequestIdQueryParam:
      description: The ID of the asynchronous work request.
      in: query
      name: workRequestId
      x-default-description: 'null'
      schema:
        type: string
    SortOrderQueryParam:
      description: The sort order to use, either 'ASC' or '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
    WorkRequestLogAndErrorSortByQueryParam:
      description: 'The field to sort by. You can specify only one sort order. The default order for `timestamp` is descending.

        '
      in: query
      name: sortBy
      schema:
        type: string
        enum:
        - timestamp
        default: timestamp
    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 executing 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 purged 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
    ClusterPlacementGroupIdentifierQueryParam:
      description: A filter to return only the resources that match the specified unique cluster placement group identifier.
      in: query
      name: id
      x-default-description: 'null'
      schema:
        type: string
    WorkRequestSortByQueryParam:
      description: 'The field to sort by. You can specify only one sort order. The default order for `timeAccepted` is descending.

        '
      in: query
      name: sortBy
      schema:
        type: string
        enum:
        - timeAccepted
        default: timeAccepted
    RequestIdHeader:
      description: The client request ID for tracing.
      in: header
      name: opc-request-id
      schema:
        type: string
  schemas:
    AdditionalCapabilityDetails:
      description: Additional details describing the selected capability.
      discriminator:
        propertyName: serviceType
      properties:
        serviceType:
          description: 'Additional details about what service provides the capability. For example, `COMPUTE` means that the Oracle Cloud Infrastructure Compute service provides the selected capability.

            '
          enum:
          - COMPUTE
          type: string
      required:
      - serviceType
    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 string.
          type: string
      required:
      - code
      - message
    ClusterPlacementGroupCollection:
      description: 'The results of a cluster placement group search, including cluster placement group summary objects and other information, such as metadata.

        '
      properties:
        items:
          description: A list of cluster placement groups.
          items:
            $ref: '#/components/schemas/ClusterPlacementGroupSummary'
          type: array
      required:
      - items
      type: object
      x-example: "{\n  \"items\": [\n    {\n      \"id\" : \"ocid1.clusterplacementgroup.oc1.iad.example7kwcej5cvbf23yyraup4uzr6fauxakv7ccyhjjoq\",\n      \"name\" : \"testclusterplacementgroup1\",\n      \"compartmentId\" : \"ocid1.tenancy.oc1..examplemyog6kcvbvq5dlzojpa7fauxila6fj4azxmethmwa\",\n      \"availabilityDomain\" : \"ABcd:US-ASHBURN-AD-1\",\n      \"clusterPlacementGroupType\" : \"STANDARD\",\n      \"timeCreated\" : \"2024-04-15T23:46:54.321Z\",\n      \"timeUpdated\" : \"2024-04-15T23:46:54.321Z\",\n      \"lifecycleState\" : \"ACTIVE\",\n      \"lifecycleDetails\" : null,\n      \"freeformTags\" : null,\n      \"definedTags\" : null,\n      \"systemTags\" : null\n    },\n    {\n      \"id\" : \"ocid1.clusterplacementgroup.oc1.iad.examplebzmccvb5xf6i6bx56j7gpgfaux66gqa3iux2uq\",\n      \"name\" : \"test cluster placement group 2\",\n      \"compartmentId\" : \"ocid1.tenancy.oc1..examplemyog6kcvbvq5dlzojpa7fauxila6fj4azxmethmwa\",\n      \"availabilityDomain\" : \"ABcd:US-ASHBURN-AD-1\",\n      \"clusterPlacementGroupType\" : \"STANDARD\",\n      \"timeCreated\" : \"2024-04-16T12:12:31.267Z\",\n      \"timeUpdated\" : \"2024-04-16T12:12:31.267Z\",\n      \"lifecycleState\" : \"ACTIVE\",\n      \"lifecycleDetails\" : null,\n      \"freeformTags\" : null,\n      \"definedTags\" : null,\n      \"systemTags\" : null\n    }\n  ]\n}\n"
    PlacementInstructionDetails:
      description: Details that inform cluster placement group provisioning.
      properties:
        type:
          description: The type of placement instruction.
          enum:
          - TOKEN
          type: string
        value:
          description: The value of the token designated for placement of the cluster placement group upon creation.
          type: string
      required:
      - type
      - value
      type: object
      x-example: "{\n  \"type\" : \"TOKEN\",\n  \"value\" : \"<var>&lt;unique_token&gt;</var>\"\n}\n"
    ClusterPlacementGroupSummary:
      description: A summary object that provides the metadata details of the cluster placement group.
      properties:
        availabilityDomain:
          description: The availability domain of the cluster placement group.
          type: string
        clusterPlacementGroupType:
          description: The type of cluster placement group.
          enum:
          - STANDARD
          type: string
          x-obmcs-top-level-enum: '#/definitions/ClusterPlacementGroupType'
        compartmentId:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the cluster placement group.
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string type is supported.

                '
              type: object
            description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.

              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

            Example: `{"foo-namespace": {"bar-key": "value"}}`

            '
          type: object
        freeformTags:
          additionalProperties:
            type: string
          description: 'Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only.

            Example: `{"bar-key": "value"}`

            '
          type: object
        id:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the cluster placement group.
          type: string
        lifecycleDetails:
          description: 'A message describing the current state in more detail. For example, lifecycle details for a resource in a Failed state might include information to act on.

            '
          type: string
        lifecycleState:
          description: The current state of the cluster placement group.
          type: string
          x-obmcs-enumref: '#/definitions/ClusterPlacementGroup/lifecycleState'
        name:
          description: The friendly name of the cluster placement group.
          type: string
        systemTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string type is supported.

                '
              type: object
            description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.

              Example: `{"bar-key": "value"}`

              '
            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 time the cluster placement group was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.
          format: date-time
          type: string
        timeUpdated:
          description: 'The time the cluster placement group was updated, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.

            '
          format: date-time
          type: string
      required:
      - id
      - compartmentId
      - availabilityDomain
      - clusterPlacementGroupType
      - lifecycleState
      - timeCreated
      - name
      - freeformTags
      - definedTags
      type: object
      x-example: "{\n  \"id\" : \"ocid1.clusterplacementgroup.oc1.iad.example7kwcej5cvbf23yyraup4uzr6fauxakv7ccyhjjoq\",\n  \"name\" : \"testclusterplacementgroup1\",\n  \"compartmentId\" : \"ocid1.tenancy.oc1..examplemyog6kcvbvq5dlzojpa7fauxila6fj4azxmethmwa\",\n  \"availabilityDomain\" : \"ABcd:US-ASHBURN-AD-1\",\n  \"clusterPlacementGroupType\" : \"STANDARD\",\n  \"timeCreated\" : \"2024-04-15T23:46:54.321Z\",\n  \"timeUpdated\" : \"2024-04-15T23:46:54.321Z\",\n  \"lifecycleState\" : \"ACTIVE\",\n  \"lifecycleDetails\" : null,\n  \"freeformTags\" : null,\n  \"definedTags\" : null,\n  \"systemTags\" : null\n}\n"
    CapabilityDetails:
      description: Details about the supported type of resource.
      properties:
        additionalDetails:
          $ref: '#/components/schemas/AdditionalCapabilityDetails'
        name:
          description: The type of resource.
          maxLength: 255
          minLength: 1
          type: string
        service:
          description: The service that the resource is part of.
          maxLength: 255
          minLength: 1
          type: string
      required:
      - service
      - name
      type: object
    WorkRequestResource:
      description: The resource created or operated on by a work request.
      properties:
        actionType:
          description: 'The way in which the resource is affected by the work 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 the state 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 to which a client can send a GET to access the resource metadata.
          type: string
        identifier:
          description: The identifier of the resource that the work request affects.
          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
      x-example: "{\n  \"entityType\" : \"clusterplacementgroup\",\n  \"actionType\" : \"CREATED\",\n  \"identifier\" : \"ocid1.clusterplacementgroup.oc1.iad.examplet72sl22ycvbagpvq4lj52clrx4bwlkfauxuve5x7jaak46oijfata\",\n  \"entityUri\" : \"/clusterPlacementGroups/ocid1.clusterplacementgroup.oc1.iad.examplet72sl22ycvbagpvq4lj52clrx4bwlkfauxuve5x7jaak46oijfata\",\n  \"metadata\" : {\n    \"is_dry_run\" : \"false\"\n  }\n}\n"
    WorkRequestSummaryCollection:
      description: The results of a work request search. Results contain both work request items and other information, such as metadata.
      properties:
        items:
          description: A list of work request summary objects.
          items:
            $ref: '#/components/schemas/WorkRequestSummary'
          type: array
      required:
      - items
      type: object
      x-example: "[\n  {\n    \"operationType\" : \"CREATE_CLUSTER_PLACEMENT_GROUP\",\n    \"status\" : \"SUCCEEDED\",\n    \"id\" : \"ocid1.tenancy.oc1..exampleavr2ys75n2gcvbzdddm4fxlj5w6l5eged3pa5fauxp4375oem7mgq\",\n    \"compartmentId\" : \"ocid1.tenancy.oc1..exampleavr2ys75n2gcvbzdddm4fxlj5w6l5eged3pa5fauxp4375oem7mgq\",\n    \"resources\" : [\n      {\n        \"entityType\" : \"clusterplacementgroup\",\n        \"actionType\" : \"CREATED\",\n        \"identifier\" : \"ocid1.clusterplacementgroup.oc1.iad.examplet72sl22ycvbagpvq4lj52clrx4bwlkfauxuve5x7jaak46oijfata\",\n        \"entityUri\" : \"/clusterPlacementGroups/ocid1.clusterplacementgroup.oc1.iad.examplet72sl22ycvbagpvq4lj52clrx4bwlkfauxuve5x7jaak46oijfata\",\n        \"metadata\" : {\n          \"is_dry_run\" : \"false\"\n        }\n      }\n    ],\n    \"percentComplete\" : 100.0,\n    \"timeAccepted\" : \"2024-04-16T23:13:58.181Z\",\n    \"timeStarted\" : \"2024-04-16T23:13:58.217Z\",\n    \"timeFinished\" : \"2024-04-16T23:13:58.217Z\",\n    \"timeUpdated\" : \"2024-04-16T23:13:58.217Z\"\n  },\n  {\n    \"operationType\" : \"UPDATE_CLUSTER_PLACEMENT_GROUP\",\n    \"status\" : \"SUCCEEDED\",\n    \"id\" : \"ocid1.clusterplacementgroupworkrequest.oc1.iad.examplea72sl22ya4v3oc3cvbgcxx6v4f3ldrzulk3ivfauxo4zwy6gsgdgq\",\n    \"compartmentId\" : \"ocid1.tenancy.oc1..exampleavr2ys75n2gcvbzdddm4fxlj5w6l5eged3pa5fauxp4375oem7mgq\",\n    \"resources\" : [\n      {\n        \"entityType\" : \"clusterplacementgroup\",\n        \"actionType\" : \"UPDATED\",\n        \"identifier\" : \"ocid1.clusterplacementgroup.oc1.iad.exampler72sl22yadoiacvbm2abqnwk64q3lljj5md3fauxzoeyt7edcfeoa\",\n        \"entityUri\" : \"/clusterPlacementGroups/ocid1.clusterplacementgroup.oc1.iad.exampler72sl22yadoiacvbm2abqnwk64q3lljj5md3fauxzoeyt7edcfeoa\",\n        \"metadata\" : {\n          \"is_dry_run\" : \"false\"\n        }\n      }\n    ],\n    \"percentComplete\" : 100.0,\n    \"timeAccepted\" : \"2024-04-16T00:40:17.434Z\",\n    \"timeStarted\" : \"2024-04-16T00:40:17.437Z\",\n    \"timeFinished\" : \"2024-04-16T00:40:17.437Z\",\n    \"timeUpdated\" : \"2024-04-16T00:40:17.437Z\"\n  }\n]\n"
    WorkRequestErrorCollection:
      description: The results of a work request error search. Results contain both work request error items and other information, such as metadata.
      properties:
        items:
          description: A list of work request error objects.
          items:
            $ref: '#/components/schemas/WorkRequestError'
          type: array
      required:
      - items
      type: object
      x-example: "{\n  \"items\" : [\n    {\n      \"code\" : \"InternalError\",\n      \"message\" : \"CPG deletion failed, retrying failed to complete successfully after 5 attempts\",\n      \"timestamp\" : \"2024-04-16T02:16:23.225Z\"\n    }\n  ]\n}\n"
    ChangeClusterPlacementGroupCompartmentDetails:
      description: The information to update.
      properties:
        compartmentId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment

            into which the resource should be moved.

            '
          maxLength: 255
          minLength: 1
          type: string
      required:
      - compartmentId
      type: object
      x-example: "{\n  \"compartmentId\" : \"ocid1.tenancy.oc1..examplemyog6kcvbvq5dlzojpa7fauxila6fj4azxmethmwa\"\n}\n"
    WorkRequestSummary:
      description: A summary object that provides the metadata details of a work request.
      properties:
        compartmentId:
          description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the work request. Work requests are scoped to

            the same compartment as the resource that the work request affects. If the work request affects multiple resources

            and those resources are not in the same compartment, the OCID of the resource designated as the primary

            resource is used.

            '
          type: string
        id:
          description: The ID of the work request.
          type: string
        operationType:
          description: The type of work request.
          enum:
          - CREATE_CLUSTER_PLACEMENT_GROUP
          - UPDATE_CLUSTER_PLACEMENT_GROUP
          - DELETE_CLUSTER_PLACEMENT_GROUP
          - MOVE_CLUSTER_PLACEMENT_GROUP
          type: string
          x-obmcs-top-level-enum: '#/definitions/OperationType'
        percentComplete:
          description: The percentage of the work request that is complete.
          format: float
          type: number
        resources:
          description: The resources 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 request was created, as described in

            [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29.

            '
          format: date-time
          type: string
        timeFinished:
          description: 'The date and time the object was finished, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339).

            '
          format: date-time
          type: string
        timeStarted:
          description: 'The date and time the request was started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339),

            section 14.29.

            '
          format: date-time
          type: string
        timeUpdated:
          description: 'The date and time the object was updated, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339).

            '
          format: date-time
          type: string
      required:
      - operationType
      - status
      - id
      - compartmentId
      - resources
      - percentComplete
      - timeAccepted
      x-example: "{\n  \"operationType\" : \"CREATE_CLUSTER_PLACEMENT_GROUP\",\n  \"status\" : \"SUCCEEDED\",\n  \"id\" : \"ocid1.tenancy.oc1..exampleavr2ys75n2gcvbzdddm4fxlj5w6l5eged3pa5fauxp4375oem7mgq\",\n  \"compartmentId\" : \"ocid1.tenancy.oc1..exampleavr2ys75n2gcvbzdddm4fxlj5w6l5eged3pa5fauxp4375oem7mgq\",\n  \"resources\" : [\n    {\n      \"entityType\" : \"clusterplacementgroup\",\n      \"actionType\" : \"CREATED\",\n      \"identifier\" : \"ocid1.clusterplacementgroup.oc1.iad.examplet72sl22ycvbagpvq4lj52clrx4bwlkfauxuve5x7jaak46oijfata\",\n      \"entityUri\" : \"/clusterPlacementGroups/ocid1.clusterplacementgroup.oc1.iad.examplet72sl22ycvbagpvq4lj52clrx4bwlkfauxuve5x7jaak46oijfata\",\n      \"metadata\" : {\n        \"is_dry_run\" : \"false\"\n      }\n    }\n  ],\n  \"percentComplete\" : 100.0,\n  \"timeAccepted\" : \"2024-04-16T23:13:58.181Z\",\n  \"timeStarted\" : \"2024-04-16T23:13:58.217Z\",\n  \"timeFinished\" : \"2024-04-16T23:13:58.217Z\",\n  \"timeUpdated\" : \"2024-04-16T23:13:58.217Z\"\n}\n"
    WorkRequestError:
      description: An error encountered while executing a work request.
      properties:
        code:
          description: 'A machine-usable code for the error that occured. Error codes are listed on

            (https://docs.cloud.oracle.com/Content/API/References/apierrors.htm).

            '
          type: string
        message:
          description: A human-readable description of the issue encountered.
          type: string
        timestamp:
          description: The time the error occured, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.
          format: date-time
          type: string
      required:
      - code
      - message
      - timestamp
      x-example: "{\n  \"code\" : \"InternalError\",\n  \"message\" : \"CPG deletion failed, retrying failed to complete successfully after 5 attempts\",\n  \"timestamp\" : \"2024-04-16T02:16:23.225Z\"\n}\n"
    ClusterPlacementGroup:
      description: 'A cluster placement group, which is a logical grouping of resources that offer low latency within an availability domain by being placed in close physical proximity.

        '
      properties:
        availabilityDomain:
          description: The availability domain of the cluster placement group.
          type: string
        capabilities:
          $ref: '#/components/schemas/CapabilitiesCollection'
        clusterPlacementGroupType:
          description: The type of cluster placement group.
          enum:
          - STANDARD
          type: string
          x-obmcs-top-level-enum: '#/definitions/ClusterPlacementGroupType'
        compartmentId:
          description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the cluster placement group.

            '
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string type is supported.

                '
              type: object
            description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.

              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

            Example: `{"foo-namespace": {"bar-key": "value"}}`

            '
          type: object
        description:
          description: A description of the cluster placement group.
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only.

            Example: `{"bar-key": "value"}`

            '
          type: object
        id:
          description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the cluster placement group.

            '
          type: string
        lifecycleDetails:
          description: 'A message describing the current state in more detail. For example, lifecycle details for a resource in a Failed state might include information to act on.

            '
          type: string
        lifecycleState:
          description: The current state of the ClusterPlacementGroup.
          enum:
          - CREATING
          - UPDATING
          - ACTIVE
          - INACTIVE
          - DELETING
          - DELETED
          - FAILED
          type: string
        name:
          description: 'The user-friendly name of the cluster placement group. The display name for a cluster placement must be unique and you cannot change it. Avoid entering confidential information.

            '
          type: string
        placementInstruction:
          $ref: '#/components/schemas/PlacementInstructionDetails'
        systemTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string type is supported.

                '
              type: object
            description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.

              Example: `{"bar-key": "value"}`

              '
            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 time the cluster placement group was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.
          format: date-time
          type: string
        timeUpdated:
          description: The time the cluster placement group was updated, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.
          format: date-time
          type: string
      required:
      - id
      - compartmentId
      - availabilityDomain
      - clusterPlacementGroupType
      - lifecycleState
      - timeCreated
      - name
      - description
      - freeformTags
      - definedTags
      type: object
      x-example: "{\n  \"id\" : \"ocid1.clusterplacementgroup.oc1.iad.example7kwcej5cvbf23yyraup4uzr6fauxakv7ccyhjjoq\",\n  \"name\" : \"testclusterplacementgroup1\",\n  \"description\" : \"test cluster placement group 1\",\n  \"compartmentId\" : \"ocid1.tenancy.oc1..examplemyog6kcvbvq5dlzojpa7fauxila6fj4azxmethmwa\",\n  \"availabilityDomain\" : \"ABcd:US-ASHBURN-AD-1\",\n  \"clusterPlacementGroupType\" : \"STANDARD\",\n  \"timeCreated\" : \"2024-04-15T23:46:54.321Z\",\n  \"timeUpdated\" : \"2024-04-15T23:46:54.321Z\",\n  \"lifecycleState\" : \"ACTIVE\",\n  \"lifecycleDetails\" : null,\n  \"placementInstruction\" : null,\n  \"capabilities\" : {\n    \"items\" : [\n      {\n        \"service\" : \"block-storage\",\n        \"name\" : \"volume\"\n      }\n    ]\n  },\n  \"freeformTags\" : { },\n  \"definedTags\" : {\n    \"Oracle-Tags\" : {\n      \"CreatedBy\" : \"johndoe\",\n      \"CreatedOn\" : \"2024-04-15T23:46:54.060Z\"\n    }\n  },\n  \"systemTags\" : { }\n}\n"
    UpdateClusterPlacementGroupDetails:
      description: The information to update.
      properties:
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string type is supported.

                '
              type: object
            description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.

              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

            Example: `{"foo-namespace": {"bar-key": "value"}}`

            '
          type: object
        description:
          description: The description of the cluster placement group.
          maxLength: 500
          minLength: 1
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only.

            Example: `{"bar-key": "value"}`

            '
          type: object
      type: object
      x-example: "{\n  \"description\" : \"updated description of the cluster placement group\"\n}\n"
    WorkRequestLogEntry:
      description: A log message from the execution of a work request.
      properties:
        message:
          description: Human-readable log message.
          type: string
        timestamp:
          description: The time the log message was written, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.
          format: date-time
          type: string
      required:
      - message
      - timestamp
      x-example: "{\n  \"message\" : \"deleting cluster placement group references from compute instance\",\n  \"timestamp\" : \"2024-04-16T02:17:13.347Z\"\n}\n"
    CreateClusterPlacementGroupDetails:
      description: Detailed information about the new cluster placement group.
      properties:
        availabilityDomain:
          description: The availability domain where you want to create the cluster placement group.
          maxLength: 255
          minLength: 1
          type: string
        capabilities:
          $ref: '#/components/schemas/CapabilitiesCollection'
        clusterPlacementGroupType:
          description: ClusterPlacementGroup Identifier.
          enum:
          - STANDARD
          type: string
          x-obmcs-top-level-enum: '#/definitions/ClusterPlacementGroupType'
        compartmentId:
          description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want to create the cluster placement group.

            '
          maxLength: 255
          minLength: 1
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string type is supported.

                '
              type: object
            description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.

              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

            Example: `{"foo-namespace": {"bar-key": "value"}}`

            '
          type: object
        description:
          description: A description of the cluster placement group.
          maxLength: 500
          minLength: 1
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only.

            Example: `{"bar-key": "value"}`

            '
          type: object
        name:
          description: The friendly name of the cluster placement group.
          maxLength: 255
          minLength: 1
          type: string
        placementInstruction:
          $ref: '#/components/schemas/PlacementInstructionDetails'
      required:
      - clusterPlacementGroupType
      - compartmentId
      - availabilityDomain
      - name
      - description
      type: object
      x-example: "{\n  \"name\" : \"testclusterplacementgroup1\",\n  \"clusterPlacementGroupType\" : \"STANDARD\",\n  \"availabilityDomain\" : \"ABcd:US-ASHBURN-AD-1\",\n  \"description\" : \"test cluster placement group 1\",\n  \"compartmentId\" : \"ocid1.tenancy.oc1..examplemyog6kcvbvq5dlzojpa7fauxila6fj4azxmethmwa\",\n  \"placementInstruction\" : null,\n  \"capabilities\" : {\n    \"items\" : [\n      {\n        \"service\" : \"compute\",\n        \"name\" : \"general\"\n      },\n      {\n        \"service\" : \"block-storage\",\n        \"name\" : \"volume\"\n      {\n    ]\n  }\n}\n"
    CapabilitiesCollection:
      description: 'A list of resources that you can create in a cluster placement group.

        '
      properties:
        items:
          description: The supported resources.
          items:
            $ref: '#/components/schemas/CapabilityDetails'
          maxItems: 20
          type: array
      required:
      - items
      type: object
    WorkRequestLogEntryCollection:
      description: The results of a work request log search. Results contain both work request log items 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
      x-example: "{\n  \"items\" : [\n    {\n      \"message\" : \"deleting cluster placement group references from compute instance\",\n      \"timestamp\" : \"2024-04-16T02:17:13.347Z\"\n    },\n    {\n      \"message\" : \"deleting cluster placement group references from block volume\",\n      \"timestamp\" : \"2024-04-16T02:17:15.568Z\"\n    }\n  ]\n}\n"
    WorkRequest:
      description: The status of a work request.
      properties:
        compartmentId:
          description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the work request. Work requests are scoped to

            the same compartment as the resource that the work request affects. If the work request affects multiple resources

            and those resources are not in the same compartment, the OCID of the resource designated as the primary

            resource is used.

            '
          type: string
        id:
          description: The ID of the work request.
          type: string
        operationType:
          description: The type of work request.
          enum:
          - CREATE_CLUSTER_PLACEMENT_GROUP
          - UPDATE_CLUSTER_PLACEMENT_GROUP
          - DELETE_CLUSTER_PLACEMENT_GROUP
          - MOVE_CLUSTER_PLACEMENT_GROUP
          type: string
          x-obmcs-top-level-enum: '#/definitions/OperationType'
        percentComplete:
          description: The percentage of the work request that is complete.
          format: float
          type: number
        resources:
          description: The resources 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 request was created, as described in

            [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29.

            '
          format: date-time
          type: string
        timeFinished:
          description: 'The date and time the object was finished, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339).

            '
          format: date-time
          type: string
        timeStarted:
          description: 'The date and time the request was started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339),

            section 14.29.

            '
          format: date-time
          type: string
        timeUpdated:
          description: 'The date and time the object was updated, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339).

            '
          format: date-time
          type: string
      required:
      - operationType
      - status
      - id
      - compartmentId
      - resources
      - percentComplete
      - timeAccepted
      x-example: "{\n  \"operationType\" : \"UPDATE_CLUSTER_PLACEMENT_GROUP\",\n  \"status\" : \"SUCCEEDED\",\n  \"id\" : \"ocid1.clusterplacementgroupworkrequest.oc1.iad.examplea72sl22ya4v3oc3cvbgcxx6v4f3ldrzulk3ivfauxo4zwy6gsgdgq\",\n  \"compartmentId\" : \"ocid1.tenancy.oc1..exampleavr2ys75n2gcvbzdddm4fxlj5w6l5eged3pa5fauxp4375oem7mgq\",\n  \"resources\" : [\n    {\n      \"entityType\" : \"clusterplacementgroup\",\n      \"actionType\" : \"UPDATED\",\n      \"identifier\" : \"ocid1.clusterplacementgroup.oc1.iad.exampler72sl22yadoiacvbm2abqnwk64q3lljj5md3fauxzoeyt7edcfeoa\",\n      \"entityUri\" : \"/clusterPlacementGroups/ocid1.clusterplacementgroup.oc1.iad.exampler72sl22yadoiacvbm2abqnwk64q3lljj5md3fauxzoeyt7edcfeoa\",\n      \"metadata\" : {\n        \"is_dry_run\" : \"false\"\n      }\n    }\n  ],\n  \"percentComplete\" : 100.0,\n  \"timeAccepted\" : \"2024-04-16T00:40:17.434Z\",\n  \"timeStarted\" : \"2024-04-16T00:40:17.437Z\",\n  \"timeFinished\" : \"2024-04-16T00:40:17.437Z\",\n  \"timeUpdated\" : \"2024-04-16T00:40:17.437Z\"\n}\n"
  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'
    200OK_ClusterPlacementGroupDetails:
      description: Detailed information about the cluster placement group.
      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/ClusterPlacementGroup'
    204_ClusterPlacementGroupMoved:
      description: The cluster placement group was moved to 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
    202_ClusterPlacementGroupUpdated:
      description: The request was accepted. The cluster placement group is being updated.
      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: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status.

            '
          schema:
            type: string
x-anchors:
  x-headers:
    etag:
      description: 'For optimistic concurrency control. See `if-match`.

        '
      type: string
    opc-next-page:
      description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,

        then there are additional items to get. Include this value as the `page` parameter for the

        subsequent GET request to get the next batch of items. For information about pagination, see [List Pagination](/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: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status.

        '
      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 string type is supported.

            '
          type: object
        description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.

          Example: `{"bar-key": "value"}`

          '
        type: object
      description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

        Example: `{"foo-namespace": {"bar-key": "value"}}`

        '
      type: object
    freeformTags:
      additionalProperties:
        type: string
      description: 'Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only.

        Example: `{"bar-key": "value"}`

        '
      type: object
    systemTags:
      additionalProperties:
        additionalProperties:
          description: 'The value of the tag. Only string type is supported.

            '
          type: object
        description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.

          Example: `{"bar-key": "value"}`

          '
        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-obmcs-client-retries-enabled: true
x-oracle-package: com.oracle.oci.clusterplacementgroups