Data Types

The following data types are described in this section:

• AccountIdType

• DescribeAccessKeysResultItem

• DescribeAccountsResultItem

• DescribeDistributionGroupsResultItem

• DescribeIpAddressesResultItem

• DescribeKeyPairsResultItem

• DescribeServerTemplatesResultItem

• DescribeSnapshotsResultItem

• DescribeTagsResultItem

• DescribeVdcCapabilitiesResultItem

• DescribeVnetsResultItem

• DescribeVolumesResultItem

• DescribeVserverMetricsResultItem

• DescribeVserverTypesResultItem

• DistributionGroupIdType

• FilterItem

• GenericString

• Message

• PositiveInteger

• ResourceAttribute

• ResourceIdType

• SnapshotIdType

• ServerTemplateIdType

• TagType

• URLType

• VnetIdType

• VolumeIdType

• VserverIdType

AccountIdType

Attributes of the AccountID data type.

Data Type Elements

This data type defines the pattern value of an account ID.

Type: xs:string

Pattern value: ACC-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Ancestors

None

Actions

• CreateAccessKeyAsObjectRequest

• CreateAccessKeyToFileRequest

• DescribeAccountsRequest

• RegisterAccessKeyRequest

DescribeAccessKeysResultItem

Data Type Elements

accessKeyID

ID of the access key.

Type: xs:string

account

Name of the account.

Type: xs:string

Ancestors

None

Actions

DescribeAccessKeysRequest

DescribeAccountsResultItem

Data Type Elements

account

Account ID.

Type: xs:string

name

Name of the account.

Type: xs:string

description

Description of the account.

Type: xs:string

Ancestors

None

Actions

DescribeAccountsRequest

DescribeDistributionGroupsResultItem

Data Type Elements

id

ID of the distribution group.

Type: xs:string

name

Name of the distribution group.

Type: xs:string

description

Description of the distribution group.

Type: xs:string

status

Status of the distribution group.

Type: xs:string

tags

List of tags associated with the distribution group.

Type: TagType

vservers

List of vServer IDs associated with the distribution group.

Type: VserverIdType

size

Size of the distribution group.

Type: xs:int

Ancestors

None

Actions

DescribeDistributionGroupsRequest

DescribeIpAddressesResultItem

Data Type Elements

ipAddress

Reserved IP address.

Type: xs:string

vnet

ID of the virtual network.

Type: VnetIdType

vserver

ID of the vServer associated with the IP address.

Type: VserverIdType

Ancestors

None

Actions

DescribeIpAddressesRequest

DescribeKeyPairsResultItem

Data Type Elements

name

Name of the key pair.

Type: xs:string

fingerprint

Fingerprint of the key pair.

Type: xs:string

Ancestors

None

Actions

DescribeKeyPairsRequest

DescribeServerTemplatesResultItem

Data Type Elements

id

ID of the server template.

Type: xs:string

name

Name of the server template.

Type: xs:string

description

Description of the server template.

Type: xs:string

status

Status of the server template.

Type: xs:string

tags

List of none or more tags for the server template.

Type: TagType

size

Size of the server template in GB.

Type: xs:long

public

Flag to indicate if the server template is available for other accounts.

Type: xs:boolean

imageType

Type of the image, VM template or assembly.

Type: GenericString

readOnly

Flag to indicate if the server template is read only.

Type: xs:boolean

Ancestors

None

Actions

DescribeServerTemplatesRequest

DescribeSnapshotsResultItem

Data Type Elements

id

ID of the snapshot.

Type: xs:string

name

Name of the snapshot.

Type: xs:string

description

Description of the snapshot.

Type: xs:string

status

Status of the snapshot.

Type: xs:string

tags

List of none or more tags for the snapshot.

Type: TagType

Ancestors

None

Actions

DescribeSnapshotsRequest

DescribeTagsResultItem

Data Type Elements

resourceId

ID of the resource.

Type: xs:string

name

Name of the tag.

Type: xs:string

value

Value of the tag.

Type: xs:string

Ancestors

None

Actions

DescribeTagsRequest

DescribeVdcCapabilitiesResultItem

Data Type Elements

name

Name of vDC capability.

Type: GenericString

value

Value of the vDC capability.

Type: GenericString

Ancestors

None

Actions

DescribeVdcCapabilitiesRequest

DescribeVnetsResultItem

Data Type Elements

id

ID of the virtual network.

Type: xs:string

name

Name of the virtual network.

Type: xs:string

description

Description of the virtual network.

Type: xs:string

status

Status of the virtual network.

Type: xs:string

tags

List of none or more tags for the virtual network.

Type: TagType

ipAddress

Subnet of the virtual network.

Type: GenericString

Ancestors

None

Actions

DeleteVnetRequest

DescribeVolumesResultItem

Data Type Elements

id

ID of the volume.

Type: xs:string

name

Name of the volume.

Type: xs:string

description

Description of the volume.

Type: xs:string

status

Status of the volume.

Type: xs:string

tags

List of none or more tags for the volume.

Type: TagType

size

Size of the volume in GB.

Type: xs:double

shared

Flag to indicate if the volume is shared.

Type: xs:boolean

vServers

List of vServer IDs associated with the volume.

Type: VserverIdType

Ancestors

None

Actions

DescribeVolumesRequest

DescribeVserverMetricsResultItem

Data Type Elements

id

ID of the vServer.

Type: xs:string

name

Name of the vServer.

Type: xs:string

description

Description of the vServer.

Type: xs:string

status

Status of the vServer.

Type: xs:string

tags

List of tags associated with the vServer.

Type: TagType

cpuUsage

vServer CPU usage.

Type: xs:float

Ancestors

None

Actions

DescribeVserverMetricsRequest

DescribeVserversResultItem

Data Type Elements

id

ID of the vServer.

Type: xs:string

name

Name of the vServer.

Type: xs:string

description

Description of the vServer.

Type: xs:string

status

Status of the vServer.

Type: xs:string

tags

List of tags associated with the vServer.

Type: TagType

vnets

List of virtual network IDs to which the vServer belongs to.

Type: VnetIdType

ipAddresses

List of IP addresses associated with the vServer.

Type: xs:string

serverTemplateId

ID of the server template associated with the vServer.

Type: ServerTemplateIdType

keyName

Name of the key pair associated with the vServer.

Type: GenericString

vserverType

ID of the vServer type associated with the vServer.

Type: GenericString

ha

Flag to indicate whether automatic recovery is enabled for the vServer. Flag is boolean, possible values are true or false.

Type: GenericString

distributionGroup

ID of the distribution group associated with the vServer.

Type: GenericString

volumes

List of volume IDs associated with the vServer.

Type: xs:string

vcpu

Number of vCPUs of the vServer.

Type: xs:integer

memoryMb

Total memory allocated for the vServer.

Type: xs:long

dedicatedStorageMb

Total storage dedicated to the vServer.

Type: xs:long

attachedStorageMb

Total storage of the volumes attached to the vServer.

Type: xs:long

Ancestors

None

Actions

DescribeVserversRequest

DescribeVserverTypesResultItem

Data Type Elements

id

ID of the vServer type.

Type: xs:string

name

Name of the vServer type.

Type: xs:string

description

Description of the vServer type.

Type: xs:string

tags

List of none or more tags of the vServer type.

Type: TagType

memorySize

Memory size of the vServer type in GB.

Type: xs:long

storageSize

Storage size of the vServer type in GB.

Type: xs:long

vcpu

Number of virtual CPUs of the vServer type.

Type: xs:integer

Ancestors

None

Actions

DescribeVserverTypesRequest

DistributionGroupIdType

Attributes of the DistributionGroupID data type.

Data Type Elements

This data type defines the pattern value of a distribution group ID.

Type: xs:string

Pattern value: DG-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Ancestors

None

Actions

• DeleteDistributionGroupRequest

• DescribeDistributionGroupsRequest

• RunVserverRequest

• RunVserversRequest

FilterItem

Attributes of the FilterItem data type.

Data Type Elements

filterName

Name of the filter. The name of an attribute for specified resource.

Type: GenericString

filterValue

Value of the filter. The value for the specified resource's attribute.

Type: GenericString

Ancestors

None

Actions

• DescribeIpAddressesRequest

• DescribeKeyPairsRequest

• DescribeServerTemplatesRequest

• DescribeSnapshotsRequest

• DescribeTagsRequest

• DescribeVdcCapabilitiesRequest

• DescribeVnetsRequest

• DescribeVolumesRequest

• DescribeVserversRequest

GenericString

Attributes of the GenericString data type.

Data Type Elements

Simple data type with the following definition.

Type: xs:string

maxLength value: 256

enumeration value: 200

Ancestors

• FilterItem

• Message

• TagType

Actions

• CreateAccessKeyAsObjectRequest

• CreateAccessKeyToFileRequest

• CreateKeyPairAsObjectRequest

• CreateKeyPairToFileRequest

• DescribeAccessKeysRequest

• DescribeAccountsRequest

• DescribeKeyPairsRequest

• ImportKeyPairRequest

• RegisterAccessKeyRequest

• RegisterKeyPairRequest

HostnameType

Attributes of the Hostname data type.

Data Type Elements

Simple data type for a host name with the following definition.

Type: xs:string

pattern value: [A-Za-z\\d]|([A-Za-z\\d][A-Za-z\\d\\-]{0,253}[A-Za-z\\d])

Ancestors

None

Actions

• RunVserverRequest

• RunVserversRequest

Message

Attributes of the Message data type.

Data Type Elements

key

Key associated with the message.

Type: GenericString

value

The value of the message.

Type: GenericString

Ancestors

None

Actions

SendMessagesToVserverRequest

PositiveInteger

Attributes of the PositiveInteger data type.

Data Type Elements

This data type defines the pattern value of a PositiveInteger data type.

Type: xs:integer

minInclusive value: 1

Ancestors

None

Actions

• AllocateIpAddressesRequest

• CreateVnetRequest

• CreateVolumeRequest

• RunVserversRequest

ResourceAttribute

Attributes of the ResourceAttribute data type.

Data Type Elements

name

Name of an attribute for a resource.

Type: xs:string

value

Value for the specified resource's attribute.

Type: xs:string

Ancestors

None

Actions

• DescribeAttributesRequest

• ModifyAttributesRequest

ResourceIdType

Attributes of the ResourceID data type.

Data Type Elements

This data type defines the pattern value of a resource ID.

Type: xs:string

Pattern value: [A-Z]{1,4}-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Ancestors

None

Actions

• CreateTagsRequest

• DeleteTagsRequest

• DescribeAttributesRequest

• ModifyAttributesRequest

SnapshotIdType

Attributes of the SnapshotID data type.

Data Type Elements

This data type defines the pattern value of a snapshot ID.

Type: xs:string

Pattern value: SNAP-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Ancestors

None

Actions

• CreateSnapshotRequest

• CreateVolumeRequest

• DeleteSnapshotRequest

ServerTemplateIdType

Attributes of the ServerTemplateID data type.

Data Type Elements

This data type defines the pattern value of a server template ID.

Type: xs:string

Pattern value: TMPL-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Ancestors

DescribeServerTemplatesRequest

Actions

• DeregisterServerTemplateRequest

• DescribeServerTemplatesRequest

• RunVserverRequest

• RunVserversRequest

TagType

Attributes of the Tag data type.

Data Type Elements

name

The name of the tag.

Type: GenericString

value

The value of the tag.

Type: GenericString

Ancestors

• DescribeServerTemplatesResultItem

• DescribeSnapshotsRequest

• DescribeVnetsResultItem

• DescribeVolumesResultItem

• DescribeVserverMetricsResultItem

• DescribeVserverTypesResultItem

Actions

• CreateTagsRequest

• DeleteTagsRequest

• DescribeServerTemplatesRequest

• DescribeSnapshotsRequest

• DescribeVnetsRequest

• DescribeVolumesRequest

• DescribeVserversRequest

• DescribeVserverTypesRequest

URLType

Attributes of the URL data type.

Data Type Elements

This data type defines the pattern value of a URL.

Type: xs:string

Ancestors

None

Actions

• ImportVolumeRequest

• RegisterServerTemplateFromUrlRequest

• RegisterServerTemplatesFromAssemblyRequest

VnetIdType

Attributes of the vNet data type.

Data Type Elements

This data type defines the pattern value of a virtual network ID.

Type: xs:string

Pattern value: VNET-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Ancestors

• DescribeIpAddressesResultItem

• DescribeVserverMetricsResultItem

Actions

• AllocateIpAddressesRequest

• DeleteVnetRequest

• DescribeIpAddressesRequest

• DescribeVnetsRequest

• DescribeVserversRequest

• ReleaseIpAddressesRequest

• RunVserverRequest

• RunVserversRequest

VolumeIdType

Attributes of the volume ID data type.

Data Type Elements

This data type defines the pattern value of a volume ID.

Type: xs:string

Pattern value: VOL-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Ancestors

None

Actions

• AttachVolumesToVserverRequest

• CreateSnapshotRequest

• DeleteVolumeRequest

• DescribeVolumesRequest

• DetachVolumesFromVserverRequest

• RunVserverRequest

• RunVserversRequest

VserverIdType

Attributes of the vServerID data type.

Data Type Elements

This data type defines the pattern value of a vServer ID.

Type: xs:string

Pattern value: VSRV-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Ancestors

DescribeIpAddressesRequest

Actions

• AttachVolumesToVserverRequest

• DescribeIpAddressesRequest

• DescribeVserversRequest

• DetachVolumesFromVserverRequest

• RebootVserversRequest

• RegisterServerTemplateFromVserverRequest

• SendMessagesToVserverRequest

• StartVserversRequest

• StopVserversRequest

• ReceiveMessageFromVserverRequest

• TerminateVserversRequest