REST API - get

appliance vcenter settings v1 config components: get

Returns the list of desired component specification for the vCenter. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Request:

HTTP request

GET https://{server}/api/appliance/vcenter/settings/v1/config/components

Response:

HTTP Status Code: 200

Response Body Structure:

[
    {
        "component" : "obj-103",
        "description" : "string"
    },
    {
        "component" : "obj-103",
        "description" : "string"
    }
]

Headers:

None

Type:

Name	Type	Description
bold = required
-	info[]	list of components.
-[].component	string	Name of the component. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: `com.vmware.appliance.vcenter.settings.v1.config.component`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `com.vmware.appliance.vcenter.settings.v1.config.component`.
-[].description	string	Description of the component. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

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.
404	not_found	Error if no component is registered with service.
503	service_unavailable	if the service is not available.
401	unauthenticated	If the caller is not authenticated.