Developer Documentation
Get Clusters Software Solutions
Released in v7.0.0Returns components registered for the given solution in the desired software specification. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Read. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read.
Request
URLURL
https://{api_host}/api/esx/settings/clusters/{cluster}/software/solutions/{solution}
Path Parameters
Path Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource. |
| required |
|
string | Identifier of the solution. The parameter must be an identifier for the resource type: com.vmware.esx.settings.solution. |
Response
Response
Response BodyResponse Body
200 OK returns
SettingsSolutionInfo
of type application/json
Specification of components registered by the solution.
{
"components": [
{
"component": "string"
}
],
"details": {
"components": [
{
"component": "string",
"display_name": "string",
"display_version": "string",
"vendor": "string"
}
],
"display_name": "string",
"display_version": "string"
},
"version": "string"
}| Property Name | Type | Description |
|---|---|---|
| components | array of SettingsSolutionComponentSpec |
Components registered by the solution. |
| version | string |
Version of the solution. |
| details | SettingsSolutionDetails |
Details about the solution from the depot. unset if solution is not present in the depot. |
Errors
| Code | Returns | Description |
|---|---|---|
| default | Error | Not available |
| 400 | Error | com.vmware.vapi.std.errors.invalid_argument : If invalid component name is provided. |
| 401 | Error | com.vmware.vapi.std.errors.unauthenticated : If the caller is not authenticated. |
| 404 | Error | com.vmware.vapi.std.errors.error : If there is unknown internal error. The accompanying error message will give more details about the failure. | com.vmware.vapi.std.errors.not_found : If there is no cluster associated with cluster in the system or or no solution associated with solution in the system. |
| 503 | Error | com.vmware.vapi.std.errors.service_unavailable : If the service is not available. |
