REST API - get

esx settings clusters software solutions: get

Returns components registered for the given solution in the desired software specification.

Request:

HTTP request

GET https://{server}/api/esx/settings/clusters/{cluster}/software/solutions/{solution}

Path Parameters

Name	Type	Description
Required
cluster	string	Identifier of the cluster.
solution	string	Identifier of the solution.

Response:

HTTP Status Code: 200

Response Body Structure:

{
    "components" : [
        {
            "component" : "obj-103"
        },
        {
            "component" : "obj-103"
        }
    ],
    "details" : {
        "components" : [
            {
                "component" : "obj-103",
                "display_version" : "string",
                "vendor" : "string",
                "display_name" : "string"
            },
            {
                "component" : "obj-103",
                "display_version" : "string",
                "vendor" : "string",
                "display_name" : "string"
            }
        ],
        "display_version" : "string",
        "display_name" : "string"
    },
    "version" : "string"
}

Headers:

None

Type:

Name	Type	Description
bold = required
-	solution_info	Specification of components registered by the solution.
-.details	solution_details	Details about the solution from the depot. Optional. unset if solution is not present in the depot.
-.details.display_name	string	Display name of the solution.
-.details.display_version	string	Display version of the solution.
-.details.components	solution_component_details[]	Components registered by the solution. If the component is not present in the depot, then corresponding details are absent from the list.
-.details.components[].component	string	Identifier of the component. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: `com.vmware.esx.settings.component`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `com.vmware.esx.settings.component`.
-.details.components[].display_name	string	Display name of the component.
-.details.components[].display_version	string	Human readable version of the component. Optional. unset if no version is provided for the component.
-.version	string	Version of the solution.
-.components	solution_component_spec[]	Components registered by the solution.

Errors:

HTTP Status Code	Type	Description
500	error	If there is unknown internal error. The accompanying error message will give more details about the failure.
400	invalid_argument	If invalid component name is provided.
404	not_found	If there is no cluster associated with `cluster` in the system or or no solution associated with `solution` in the system.
503	service_unavailable	If the service is not available.
401	unauthenticated	If the caller is not authenticated.