Obtain Server Information

Description

Use this request to obtain information about the specified server. The {ve-name} part of the request URL must contain the server name.

Syntax

GET baseURL/ve/{ve-name}

Request Parameters

None

Response

Element	Attribute	Description
`ve`		Container for server information.
`id`		Server database ID (used internally). Type: int
`previous-id`		Previous server database ID. This element is optional and is only included for servers that were recreated in the past.
`uuid`		Server UUID. Type: string
`hnId`		ID of the hardware node on which this server resides. Type: string
`customer-id`		ID of the customer account to which the server belongs. Type: int
`name`		Server name. Type: string
`description`		Server description. Type: string
`subscription-id`		ID of the subscription to which the server belongs. Type: int
`cpu`		Container for CPU information.
	`number`	Number of CPU cores. Type: int
	`power`	CPU clock speed in megahertz. Type: int
`ram-size`		RAM size in megabytes. Type: int
`bandwidth`		Network bandwidth in kbps. Type: int
`ve-disk`		Container for hard disk information. At the time of writing, a server can have only one hard disk. This will change in the future.
	`id`	Disk database ID (used internally) Type: int
	`local`	Specifies whether this is a local or a network disk. Only local disks are supported at the time of writing. Type: boolean
	`size`	Disk size in gigabytes. Type: int
	`created`	Disk status. Type: boolean Possible values: `true` is the disk creation process completed. `false` is the disk is being created and is not available for use.
`platform`		Container for the operating system template and related information.
`template-info`		Container for OS template information.
	`name`	Template name. Type: string
	`vendorId`	Template vendor ID. Type: string
	`c2uId`	Cloud Infrastructure Automation template ID (used internally). Type: string
`os-info`		Container for operating system information. This information is a part of the OS template info.
	`type`	OS type (Linux, Windows, etc.) Type: string
	`technology`	Virtualization technology used. Type: string Possible values: `CT` – container, `VM` – virtual machine.
`network`		Container for network information.
	`private_ip`	Private IP address and mask. Type: string
`public-ip`		Container for public IPv4 address info. This element may appear more than once (one for each IP address).
	`id`	Database ID (used internally). Type: int
	`address`	IP address and mask. Type: string
	`gateway`	Gateway IP address. Type: string
	`chunk-ref`	Used internally. Type: int
`public-ipv6`		Container for public IPv6 address info. This element may appear more than once (one for each IPv6 address).
	`id`	Database ID (used internally). Type: int
	`address`	IPv6 address and mask. Type: string
	`gateway`	Gateway IPv6 address. Type: string
`backup-schedule`		Container for backup schedule info. A backup schedule is created and configured by the system administrator. The user can select one of the existing backup schedules when a server is created.
	`name`	Backup schedule name. Type: string
`state`		A string describing the server state or transition. Type: string
`primary-disk-id`		Used internally. Type: int
`template-id`		Used internally. Type: int
`admin`		Container for the server administrator credentials.
	`login`	Server administrator login name. Type: string
	`password`	Password. Type: string
`last-operation-rc`		The returned code of the last operation. Type: int
`app-info`		Container for installed application template information. This element may appear more than once (one for each installed template).
	`app-template`	Application template name. Type: string
	`for-os`	The name of the OS template for which this application is designed. Type: string
	`c2u-version`	The template Cloud Infrastructure Automation version. Type: string
	`installed-at`	Template location. Type: string
	`installed-ok`	Specifies whether the template was installed properly. Type: boolean
	`uninstalled-at`	The previous template's location. Type: string
	`uninstalled-ok`	Specifies whether the template uninstallation was completed successfully. Type: boolean
	`app-template-id`	Application template ID (used internally). Type: int
`load-balancer`		Name of the load balancer attached to this server. If no load balancer is used, the element will be absent. Type: string
`steady-state`		A string describing the server steady state. This parameter normally never contains transition states that change quickly. When monitoring transitions, look at the `state` parameter above. Type: string

Example

Request

GET https://c2u-web:4465/paci/v1.0/ve/Web60

Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ve>
    <id>4</id>
    <uuid>6733915.132fd360949._7ffe</uuid>
    <hnId>5</hnId>
    <customer-id>1</customer-id>
    <name>server1</name>
    <description></description>
    <subscription-id>1</subscription-id>
    <cpu power="1000" number="1"/>
    <ram-size>128</ram-size>
    <bandwidth>100</bandwidth>
    <ve-disk created="true" size="1" local="true" id="0"/>
    <platform>
        <template-info c2uId="1" vendorId="5" name="centos-5-x86"/>
        <os-info technology="CT" type="linux-free"/>
    </platform>
    <network private-ip="10.40.119.201/8">
        <public-ip chunk-ref="1" gateway="10.30.0.1" address="10.30.119.201/16" id="3"/>
    </network>
    <backup-schedule name="hourly"/>
    <state>STOPPED</state>
    <primary-disk-id>0</primary-disk-id>
    <template-id>1</template-id>
    <admin password="[hidden]" login="root"/>
    <steady-state>STOPPED</steady-state>
</ve>