{ "opencollection": "1.0.0", "info": { "name": "Oracle Sddc API", "version": "1.0" }, "items": [ { "info": { "name": "sddc", "type": "folder" }, "items": [ { "info": { "name": "Lists the SDDCs in the specified compartment", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220518/sddcs", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "computeAvailabilityDomain", "value": "", "type": "query", "description": "The name of the availability domain that the Compute instances are running in.\n\nExample: `Uocm:PHX-AD-1`\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." } ] }, "docs": "Lists the SDDCs in the specified compartment. The list can be\nfiltered by display name or availability domain.\n" }, { "info": { "name": "Creates an SDDC", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220518/sddcs", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates an Oracle Cloud VMware Solution software-defined data center (SDDC).\n\nUse the [WorkRequest](#/en/vmware/20200501/WorkRequest/) operations to track the\ncreation of the SDDC.\n\n**Important:** You must configure the SDDC'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 SDDC", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220518/sddcs/:sddcId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "sddcId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the SDDC.\n" } ] }, "docs": "Gets the specified SDDC's information." }, { "info": { "name": "Updates the specified SDDC", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20220518/sddcs/:sddcId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "sddcId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the SDDC.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified SDDC.\n\n**Important:** Updating an SDDC affects only certain attributes in the `Sddc`\nobject and does not affect the VMware environment currently running in\nthe SDDC. For more information, see\n[UpdateSddcDetails](#/en/vmware/20200501/datatypes/UpdateSddcDetails).\n" }, { "info": { "name": "Deletes the specified SDDC", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20220518/sddcs/:sddcId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "sddcId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the SDDC.\n" } ] }, "docs": "Deletes the specified SDDC, along with the other resources that were\ncreated with the SDDC. For example: the Compute instances, DNS records,\nand so on.\n\nUse the [WorkRequest](#/en/vmware/20200501/WorkRequest/) operations to track the\ndeletion of the SDDC.\n" }, { "info": { "name": "Acknowledge the replacement of SDDC licenses.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220518/sddcs/:sddcId/actions/acknowledgeLicenseReplacement", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "sddcId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the SDDC.\n" } ] }, "docs": "Acknowledge the replacement of SDDC licenses." }, { "info": { "name": "Cancel the pending SDDC downgrade from HCX Enterprise to HCX Advanced", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220518/sddcs/:sddcId/actions/cancelDowngradeHcx", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "sddcId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the SDDC.\n" } ] }, "docs": "Cancel the pending SDDC downgrade from HCX Enterprise to HCX Advanced.\n" }, { "info": { "name": "Moves an SDDC into a different compartment within the same tenancy", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220518/sddcs/:sddcId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "sddcId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the SDDC.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves an SDDC into a different compartment within the same tenancy. For information\nabout moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n" }, { "info": { "name": "Downgrade the specified SDDC from HCX Enterprise to HCX Advanced", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220518/sddcs/:sddcId/actions/downgradeHcx", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "sddcId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the SDDC.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Downgrade the specified SDDC from HCX Enterprise to HCX Advanced. \nSDDC with standard compute shapes will always use HCX Enterprise if HCX is enabled and cannot be downgraded.\nDowngrading from HCX Enterprise to HCX Advanced reduces the number of provided license keys from 10 to 3.\nDowngrade remains in a `PENDING` state until the end of the current billing cycle. You can use [cancelDowngradeHcx](#/en/vmware/20200501/Sddc/CancelDowngradeHcx/) \nto cancel the downgrade while it's still in a `PENDING" }, { "info": { "name": "Refresh HCX on-premise licenses status of the specified SDDC", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220518/sddcs/:sddcId/actions/refreshHcxLicenses", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "sddcId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the SDDC.\n" } ] }, "docs": "Refresh HCX on-premise licenses status of the specified SDDC." }, { "info": { "name": "Upgrade the specified SDDC from HCX Advanced to HCX Enterprise", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220518/sddcs/:sddcId/actions/upgradeHcx", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "sddcId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the SDDC.\n" } ] }, "docs": "Upgrade the specified SDDC from HCX Advanced to HCX Enterprise.\n" }, { "info": { "name": "Lists supported compute shapes.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220518/supportedHostShapes", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment." }, { "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": "name", "value": "", "type": "query", "description": "A filter to return only resources that match the given name exactly." }, { "name": "sddcType", "value": "", "type": "query", "description": "A filter to return only resources that match the given SDDC type exactly." } ] }, "docs": "Lists supported compute shapes for ESXi hosts.\n" }, { "info": { "name": "Lists supported SKUs. HOUR, MONTH, ONE_YEAR and THREE_YEARS", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220518/supportedSkus", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment." }, { "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": "hostShapeName", "value": "", "type": "query", "description": "A filter to return only resources that match or support the given ESXi host shape." } ] }, "docs": "Lists supported SKUs.\n" }, { "info": { "name": "Lists the supported VMware software bundle versions", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220518/supportedVmwareSoftwareVersions", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment." }, { "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" } ] }, "docs": "Lists the versions of bundled VMware software supported by the Oracle Cloud\nVMware Solution.\n" }, { "info": { "name": "Retrieve the SDDC password.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220518/sddcs/:sddcId/actions/retrievePassword", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "sddcId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the SDDC.\n" }, { "name": "type", "value": "", "type": "query", "description": "The SDDC password type." } ] }, "docs": "Retrieve the SDDC password.\n" }, { "info": { "name": "Lists supported Commitments. HOUR, MONTH, ONE_YEAR and THREE_YEARS", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220518/supportedCommitments", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment." }, { "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": "hostShapeName", "value": "", "type": "query", "description": "A filter to return only resources that match or support the given ESXi host shape." } ] }, "docs": "Lists supported Commitments.\n" } ] } ], "bundled": true }