{
  "opencollection": "1.0.0",
  "info": {
    "name": "Cluster Placement Groups Cluster Placement Groups CP API",
    "version": "20230801"
  },
  "items": [
    {
      "info": {
        "name": "ClusterPlacementGroupsCP",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Gets a list of all cluster placement groups.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://127.0.0.1/20230801/clusterPlacementGroups",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "compartmentId",
                "value": "",
                "type": "query",
                "description": "A filter to return only the resources that match the specified compartment [OCID](/iaas/Content/General/Concepts/identifiers.htm).\n"
              },
              {
                "name": "lifecycleState",
                "value": "",
                "type": "query",
                "description": "A filter to return only the resources that match the specified lifecycle state."
              },
              {
                "name": "name",
                "value": "",
                "type": "query",
                "description": "A filter to return only the resources that match the entire display name specified."
              },
              {
                "name": "ad",
                "value": "",
                "type": "query",
                "description": "A filter to return only the resources that match the specified availability domain."
              },
              {
                "name": "id",
                "value": "",
                "type": "query",
                "description": "A filter to return only the resources that match the specified unique cluster placement group identifier."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of items to return."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "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."
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query",
                "description": "The sort order to use, either 'ASC' or 'DESC'."
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "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.\n"
              },
              {
                "name": "compartmentIdInSubtree",
                "value": "",
                "type": "query",
                "description": "When set to `true`, cluster placement groups in all compartments under the specified compartment are returned. The default is set to `false`.\n"
              }
            ]
          },
          "docs": "Gets a list of all cluster placement groups in the specified compartment.\n"
        },
        {
          "info": {
            "name": "Creates a new cluster placement group.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://127.0.0.1/20230801/clusterPlacementGroups",
            "headers": [
              {
                "name": "opc-retry-token",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              },
              {
                "name": "opc-dry-run",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new cluster placement group in the specified compartment.\n"
        },
        {
          "info": {
            "name": "Get a cluster placement group.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://127.0.0.1/20230801/clusterPlacementGroups/:clusterPlacementGroupId",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "clusterPlacementGroupId",
                "value": "",
                "type": "path",
                "description": "A unique cluster placement group identifier."
              }
            ]
          },
          "docs": "Gets the specified cluster placement group."
        },
        {
          "info": {
            "name": "Update a cluster placement group.",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "http://127.0.0.1/20230801/clusterPlacementGroups/:clusterPlacementGroupId",
            "headers": [
              {
                "name": "if-match",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "clusterPlacementGroupId",
                "value": "",
                "type": "path",
                "description": "A unique cluster placement group identifier."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the specified cluster placement group."
        },
        {
          "info": {
            "name": "Delete a provisioned cluster placement group.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "http://127.0.0.1/20230801/clusterPlacementGroups/:clusterPlacementGroupId",
            "headers": [
              {
                "name": "if-match",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "clusterPlacementGroupId",
                "value": "",
                "type": "path",
                "description": "A unique cluster placement group identifier."
              }
            ]
          },
          "docs": "Deletes the specified cluster placement group."
        },
        {
          "info": {
            "name": "Activate a cluster placement group.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://127.0.0.1/20230801/clusterPlacementGroups/:clusterPlacementGroupId/actions/activate",
            "headers": [
              {
                "name": "if-match",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              },
              {
                "name": "opc-retry-token",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "clusterPlacementGroupId",
                "value": "",
                "type": "path",
                "description": "A unique cluster placement group identifier."
              }
            ]
          },
          "docs": "Activates the specified, previously deactivated cluster placement group to let resources be created in it.\n"
        },
        {
          "info": {
            "name": "Move a cluster placement group to a different compartment.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://127.0.0.1/20230801/clusterPlacementGroups/:clusterPlacementGroupId/actions/changeCompartment",
            "headers": [
              {
                "name": "if-match",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              },
              {
                "name": "opc-retry-token",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "clusterPlacementGroupId",
                "value": "",
                "type": "path",
                "description": "A unique cluster placement group identifier."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Moves a cluster placement group resource from one compartment to another in the same tenancy. For information about\nmoving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n\nWhen provided, If-Match is checked against ETag values of the resource.\n"
        },
        {
          "info": {
            "name": "Deactivate a cluster placement group.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://127.0.0.1/20230801/clusterPlacementGroups/:clusterPlacementGroupId/actions/deactivate",
            "headers": [
              {
                "name": "if-match",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              },
              {
                "name": "opc-retry-token",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "clusterPlacementGroupId",
                "value": "",
                "type": "path",
                "description": "A unique cluster placement group identifier."
              }
            ]
          },
          "docs": "Deactivates the specified cluster placement group to prevent new resources from being created in it."
        },
        {
          "info": {
            "name": "List work requests.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://127.0.0.1/20230801/workRequests",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "compartmentId",
                "value": "",
                "type": "query",
                "description": "A filter to return only the resources that match the specified compartment [OCID](/iaas/Content/General/Concepts/identifiers.htm).\n"
              },
              {
                "name": "workRequestId",
                "value": "",
                "type": "query",
                "description": "The ID of the asynchronous work request."
              },
              {
                "name": "status",
                "value": "",
                "type": "query",
                "description": "A filter to return only resources with a lifecycle state that matches the specified operation status."
              },
              {
                "name": "resourceId",
                "value": "",
                "type": "query",
                "description": "The ID of the resource affected by the work request."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "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."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of items to return."
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query",
                "description": "The sort order to use, either 'ASC' or 'DESC'."
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "description": "The field to sort by. You can specify only one sort order. The default order for `timeAccepted` is descending.\n"
              }
            ]
          },
          "docs": "Lists all work requests in the specified compartment.\n"
        },
        {
          "info": {
            "name": "Get work request status.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://127.0.0.1/20230801/workRequests/:workRequestId",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "workRequestId",
                "value": "",
                "type": "path",
                "description": "The ID of the asynchronous work request."
              }
            ]
          },
          "docs": "Gets details of the work request with the specified ID."
        },
        {
          "info": {
            "name": "Cancel work request.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "http://127.0.0.1/20230801/workRequests/:workRequestId",
            "headers": [
              {
                "name": "if-match",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "workRequestId",
                "value": "",
                "type": "path",
                "description": "The ID of the asynchronous work request."
              }
            ]
          },
          "docs": "Cancels the work request with the specified ID."
        },
        {
          "info": {
            "name": "List work request errors.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://127.0.0.1/20230801/workRequests/:workRequestId/errors",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "workRequestId",
                "value": "",
                "type": "path",
                "description": "The ID of the asynchronous work request."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "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."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of items to return."
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "description": "The field to sort by. You can specify only one sort order. The default order for `timestamp` is descending.\n"
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query",
                "description": "The sort order to use, either 'ASC' or 'DESC'."
              }
            ]
          },
          "docs": "Returns a (paginated) list of errors for the work request with the specified ID.\n"
        },
        {
          "info": {
            "name": "List work request logs.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://127.0.0.1/20230801/workRequests/:workRequestId/logs",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "workRequestId",
                "value": "",
                "type": "path",
                "description": "The ID of the asynchronous work request."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "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."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of items to return."
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "description": "The field to sort by. You can specify only one sort order. The default order for `timestamp` is descending.\n"
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query",
                "description": "The sort order to use, either 'ASC' or 'DESC'."
              }
            ]
          },
          "docs": "Returns a (paginated) list of logs for the work request with the specified ID.\n"
        }
      ]
    }
  ],
  "bundled": true
}