Developer Documentation
Get Clusters Software Drafts Software Components
Released in v7.0.0Returns the component version for the given component in the software draft. 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/drafts/{draft}/software/components/{component}
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 working copy document. The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft. |
| required |
|
string | Identifier of the component. The parameter must be an identifier for the resource type: com.vmware.esx.settings.component. |
Response
Response
Response BodyResponse Body
200 OK returns
Settings_ComponentInfo
of type application/json
Information about component version. If unset then version will be chosen based on the constraints in the system.
Errors
| Code | Returns | Description |
|---|---|---|
| 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 or no draft associated with draft or no component associated with component in the system. |
| 503 | Error | com.vmware.vapi.std.errors.service_unavailable : If the service is not available. |
| default | Error | Not available |
| 401 | Error | com.vmware.vapi.std.errors.unauthenticated : if the caller is not authenticated. |
