REST API - get

appliance configuration desired state: get

Returns the information about given profile. 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/configuration/desiredstate/{profile}

Path Parameters

Name	Type	Description
Required
profile	string	Identifier of the profile.

Response:

HTTP Status Code: 200

Response Body Structure:

{
    "config_spec" : "string",
    "component_info" : {
        "obj-103" : {
            "component" : "obj-103",
            "info" : "string"
        }
    },
    "profile_info" : {
        "creation_time" : "2015-01-01T22:13:05.651Z",
        "owner" : "string",
        "profile" : "obj-103",
        "name" : "string",
        "description" : "string",
        "version" : "obj-103"
    }
}

Headers:

None

Type:

Name	Type	Description
bold = required
-	profile_spec	Information about the profile configuration.
-.profile_info	profile_info	Details of the Profile. 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.
-.profile_info.profile	string	Unique Profile identifier. 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.configuration.profile`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `com.vmware.appliance.configuration.profile`.
-.profile_info.name	string	Name of the profile. 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.
-.profile_info.version	string	Unique working profile configuration identifier. 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.configuration.profile.version`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `com.vmware.appliance.configuration.profile.version`.
-.profile_info.creation_time	date_time	Creation time of the profile desired configuration. 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.
-.profile_info.owner	string	Owner of the profile, the one who created. 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.
-.profile_info.description	string	Custom description provided by the user. 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. Optional. If unset description will be empty.
-.config_spec	string	Config properties in JSON string format. 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.
-.component_info	object	Components information exported. 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 key in the field key/value pairs must be an identifier for the resource type: `com.vmware.appliance.configuration.component`. When operations return a value of this structure as a result, the key in the field key/value pairs will be an identifier for the resource type: `com.vmware.appliance.configuration.component`.Object with element values of type component_info.

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	If there is no profile associated with `profile`
503	service_unavailable	If the service is not available.
401	unauthenticated	If the caller is not authenticated.