{ "opencollection": "1.0.0", "info": { "name": "Oracle Cloud VMware Solution Cluster API", "version": "20230701" }, "items": [ { "info": { "name": "cluster", "type": "folder" }, "items": [ { "info": { "name": "Lists the Clusters in the specified SDDC.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20230701/clusters", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "sddcId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the SDDC.\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The lifecycle state of the resource." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment as optional parameter." } ] }, "docs": "Lists the Clusters in the specified compartment.\n" }, { "info": { "name": "Create a Cluster", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20230701/clusters", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a vSphere Cluster in software-defined data center (SDDC).\n\nUse the [WorkRequest](#/en/vmware/20230701/WorkRequest/) operations to track the\ncreation of the Cluster.\n\n**Important:** You must configure the Cluster's networking resources with the security rules detailed in [Security Rules for Oracle Cloud VMware Solution SDDCs](/iaas/Content/VMware/Reference/ocvssecurityrules.htm). Otherwise, provisioning the SDDC will fail. The rules are based on the requirements set by VMware.\n" }, { "info": { "name": "Get Cluster", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20230701/clusters/:clusterId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the SDDC Cluster.\n" } ] }, "docs": "Gets the specified Cluster's information." }, { "info": { "name": "Updates the specified Cluster", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20230701/clusters/:clusterId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the SDDC Cluster.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified Cluster.\n\n**Important:** Updating a Cluster affects only certain attributes in the `Cluster`\nobject and does not affect the VMware environment currently running in\nthe Cluster.\n" }, { "info": { "name": "Deletes the specified Cluster", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20230701/clusters/:clusterId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the SDDC Cluster.\n" } ] }, "docs": "Deletes the specified Cluster, along with the other resources that were\ncreated with the Cluster. For example: the Compute instances, DNS records,\nand so on.\n\nUse the [WorkRequest](#/en/vmware/20230701/WorkRequest/) operations to track the\ndeletion of the Cluster.\n" } ] } ], "bundled": true }