InstanceType

Element:
Instance
Type:
InstanceType
Namespace:
http://www.vmware.com/vchs/sc/instance/v1
Description:
Provides the details of the instance. Includes details like id of the instance, Api endpoint of the instance, service group id of the instance, service plan id used to create the instance, etc.
Since:
5.7
Schema:
instance.xsd
Media type(s):
None
Extends:
ResourceType
XML Representation:
<Instance xmlns="http://www.vmware.com/vchs/sc/instance/v1" xmlns:common_v1="http://www.vmware.com/vchs/sc/common/v1">
    <common_v1:description> common_v1:NonEmptyString </common_v1:description>
    <common_v1:region> common_v1:NonEmptyString </common_v1:region>
    <common_v1:instanceVersion> common_v1:NonEmptyString </common_v1:instanceVersion>
    <common_v1:planId> common_v1:NonEmptyString </common_v1:planId>
    <common_v1:serviceGroupId> common_v1:NonEmptyString </common_v1:serviceGroupId>
    <apiUrl> xs:anyURI </apiUrl>
    <dashboardUrl> xs:anyURI </dashboardUrl>
    <common_v1:instanceAttributes> common_v1:NonEmptyString </common_v1:instanceAttributes>
</Instance>

Elements

Element Type Required Modifiable Since Deprecated Description
apiUrl anyURI Yes none 5.7 The apiUrl endpoint of the instance.
dashboardUrl anyURI Yes none 5.7 The dashboardurl of the instance.
description NonEmptyString No always 5.7 The description of the instance.
instanceAttributes NonEmptyString No none 5.7 This is an optional field used by service to provide additional information about the instance.
instanceVersion NonEmptyString No none 5.7 The version of the instance.
planId NonEmptyString Yes none 5.7 The plan id with which the instance is created.
region NonEmptyString Yes none 5.7 The region in which the instance is present.
serviceGroupId NonEmptyString Yes none 5.7 The service group id with which the instance is created.