Oracle Cluster Placement Groups CP API

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: cluster

# --- truncated at 32 KB (72 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/oracle/refs/heads/main/openapi/oracle-clusterplacementgroupscp-api-openapi.yml