Skip Headers
Oracle® Enterprise Manager Ops Center Cloud Infrastructure API and CLI Reference Guide
12c Release 1 (12.1.4.0.0)

Part Number E25150-06
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Index
Index
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
PDF · Mobi · ePub

4 Cloud Infrastructure API Reference

This chapter describes some characteristics of the cloud infrastructure API. It also presents a description of the information contained in a typical request to the cloud infrastructure API, and contains all actions and data types information.

The following topics are covered in this chapter:

4.1 Overview of the Cloud Infrastructure API

The cloud infrastructure API is a Web service API implemented in Oracle Enterprise Manager Ops Center that exposes its virtual datacenter management system. This Web service provides access to a subset of the virtual datacenter functionality available through the Oracle Enterprise Manager Ops Center user interface.

The functionality exposed by the Web service can then be accessed programmatically using the Java client API, the CLI, or by making calls directly to the Web service.

This functionality includes the management of vServers, server templates, network resources, and storage resources for an account.

4.2 Cloud Infrastructure API Requests

The Web service was developed as a simple query Web service. This Web service requires an SSL encrypted HTTP connection. A typical request to the Web service is made through HTTP using a GET or POST method that includes the request parameters for the desired action. The Web service returns the result of a request in XML format that conforms to the XML schema of the Web service.

The Web service implementation added the following servlets deployed into the Common Agent Container of Oracle Enterprise Manager Ops Center:

  • The AKM servlet – The AKM servlet handles all actions related to account authentication.

  • The IAAS servlet – The IAAS servlet handles all actions related to cloud computing management.

4.2.1 Required Web Service HTTP Request Parameters

All requests to the Web service share some required parameters. Other parameters are only required for requests to the specific servlet, AKM or IAAS. Table 4-1contains the common parameters that are required in an HTTP request to the Web service.

Table 4-1 Required Parameters for an HTTP Request

Servlet Parameter Description

AKM and IAAS

Action

Indicates the name of the IAAS or AKM action to perform

AKM and IAAS

Version

Version of the Web service

IAAS only

AccessKeyId

Access Key ID. This parameter identifies the user and the account. This is the value returned by the RegisterAccessKey action.

AKM and IAAS

Timestamp

Timestamp in milliseconds since January 1, 1970

AKM and IAAS

Expires

Time at which the request expires. Expiry date in milliseconds since January 1, 1970; it must be greater than the timestamp.

IAAS only

Signature

Encoded hash value of the data to be signed. Signature is used to authenticate the data.

IAAS only

SignatureMethod

Type of the signature

IAAS only

SignatureVersion

Version number of the signature


4.2.2 Signing a Web Service Request

Signing a request to the Web service involves applying the following algorithm.

  1. Collect all parameters for the Web service request ( see Table 4-1). The parameters and their values are UTF-8 strings. The signature is not yet included in these parameters because the aim of the algorithm is to calculate the value of this signature parameter.

  2. The URL encodes all parameter names and their values. The following characters are not URL encoded and remain as they are: A to Z, a to z, 0 to 9, minus (-), underscore (_), period (.), and asterisk (*) . All other characters are encoded as %XX (with XX being a hexadecimal number consisting of 0 to 9 and/or uppercase A to F). Extended UTF-8 characters are encoded with %XX%XX. Space is encoded as a plus sign (+). This is what Java's java.net.URLEncoder.encode() method does, using UTF-8 as encoding.

  3. Create a string by concatenating the next elements in the same order. A"\n" is required between every field.

    1. POST or GET, depending on request type. "\n"

    2. Host name as given in the HTTP host header field, all in lower case (for example, opscenter.com) "\n"

    3. Base URL of the Web service."\n"

    4. A sequence of the sorted, encoded parameter names, followed directly by the equal sign (=) and their corresponding encoded parameter value. The parameters are joined together with the ampersand (&)."\n"

Sign this string using the private key and the specified SignatureMethod and SignatureVersion parameters. The signature method must be SHA512withRSA.

The signing result is then used as the value of the signature parameter for the request.

Example 4-1 and Example 4-2 show a complete URL for an HTTP GET request to the IAAS and AKM servlet. For a detailed example of generating requests to the Web service, see Appendix A.

Example 4-1 URL for an HTTP GET request to the IAAS servlet:

https://<EnterpriseControllerHostname>/iaas/?Action=DescribeVnets&Version=1&AccessKeyId=AK_1&Timestamp=1331058169938&Expires=1331058469938&SignatureMethod=SHA512withRSA&SignatureVersion=1&Signature=bj8GfJCqvPZZPU2JoWAGzZdCF+N767rQejILMQwNdgKLfoGGqAwDPRYMr/ghUoBc6RB3nKYgAyPdmtCfhzRGTqECgUWy0jCrE99+utGeeJ0/XRQ9LxyYeBgzjO3lHP+hFhUo+gUtQaSYPhUHH7eTkxg/CrolMxibglypJM/rIf90yEqSeqhphQt7hWxlT0DNAy6/cZt8isT/Tu8V7ZFjBFkEpLfN97bIOJ2vIIpOeetmftuw4ObtqjbUp6+7dpVkhhCQnX0MAIDj+mjorEOzcwK+F1pYuzES0fjaW0MowG+cA/9gttDjg7r5H29i3qbbjIlvAt6fk1HPpSxQTSTOTg==

Example 4-2 URL for an HTTP GET request to the AKM servlet:

https://<<username>>:<<password>>@<EnterpriseControllerHostname>/akm/?Action= DescribeAccounts&Version=1&Timestamp=1330954619299&Expires=1330954919299

List of Actions

The following actions are described in this section:

Functionality Actions
Account access CreateAccessKeyAsObjectRequest, CreateAccessKeyToFileRequest, DeleteAccessKeyRequest, DescribeAccessKeysRequest, DescribeAccountsRequest, RegisterAccessKeyRequest
Server template management DeregisterServerTemplateRequest, DescribeServerTemplatesRequest, RegisterServerTemplateFromUrlRequest, RegisterServerTemplateFromVserverRequest, RegisterServerTemplatesFromAssemblyRequest
Virtual network management CreateVnetRequest, DeleteVnetRequest, DescribeVnetsRequest
vIP address management AllocateIpAddressesRequest, DescribeIpAddressesRequest, ReleaseIpAddressesRequest
Volume management AttachVolumesToVserverRequest, CreateVolumeRequest, DeleteVolumeRequest, DescribeVolumesRequest, DetachVolumesFromVserverRequest, ImportVolumeRequest
Snapshot management CreateSnapshotRequest, DeleteSnapshotRequest, DescribeSnapshotsRequest
Key pair management CreateKeyPairAsObjectRequest, CreateKeyPairToFileRequest, DeleteKeyPairRequest, DescribeKeyPairsRequest, ImportKeyPairRequest
vServer management DescribeVserversRequest, DescribeVserverTypesRequest, RebootVserversRequest, ReceiveMessageFromVserverRequest, RunVserverRequest, RunVserversRequest, SendMessagesToVserverRequest, StartVserversRequest, StopVserversRequest, TerminateVserversRequest
Distribution group management CreateDistributionGroupRequest, DeleteDistributionGroupRequest, DescribeDistributionGroupsRequest
Resource attribute management DescribeAttributesRequest, ModifyAttributesRequest
Tag management CreateTagsRequest, DeleteTagsRequest, DescribeTagsRequest
vDC capabilities DescribeVdcCapabilitiesRequest


AllocateIpAddressesRequest

Description

Action to allocate a number of IP addresses from a vNET.

Request Parameters

vnet

ID of the vNET.

Type: VnetIdType

Default: None

Required: Yes

num

Number of IP addresses to reserve.

Type: PositiveInteger

Default: 1

Required: No

Result Elements

The result elements are contained in AllocateIpAddressesResult.

requestId

ID of the request.

Type: xs:string

Required: Yes

ipAddresses

List of reserved IP addresses.

Type: xs:string

Minimum: 0

Maximum: Unbounded

Examples

Example 1   

The following example allocates an IP address from a vNET.

HTTP Request

https://<EnterpriseControllerHostname>/iaas/?Action=AllocateIpAddresses&Version=1&Timestamp=1320342206808&Expires=1320342506808&vnet=VNET-6ea466f5-6e6b-4159-adf3-8867473d4cf4&AccessKeyId=AK_32&Signature=SIGNATURE_HAS_BEEN_REMOVED_FOR_THE_READABILITY_OF_THE_REQUEST&SignatureMethod=SHA512withRSA&SignatureVersion=1

HTTP Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><result xmlns="http://www.oracle.com/xml/ns/iaas" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AllocateIpAddressesResult" requestId="403"><ipAddresses>10.6.0.13</ipAddresses></result>
Example 2   

The following example allocates two IP addresses from the specified vNET.

HTTP Request

https://<EnterpriseControllerHostname>/iaas/?Action=AllocateIpAddresses&Version=1&Timestamp=1320341343286&Expires=1320341643286&num=2&vnet=VNET-6ea466f5-6e6b-4159-adf3-8867473d4cf4&AccessKeyId=AK_32&Signature=SIGNATURE_HAS_BEEN_REMOVED_FOR_THE_READABILITY_OF_THE_REQUEST&SignatureMethod=SHA512withRSA&SignatureVersion=1

HTTP Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><result xmlns="http://www.oracle.com/xml/ns/iaas" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AllocateIpAddressesResult" requestId="399"><ipAddresses>10.6.0.1</ipAddresses><ipAddresses>10.6.0.2</ipAddresses></result>

AttachVolumesToVserverRequest

Description

Action to attach one or more volumes to a vServer.

Request Parameters

vserverId

ID of the vServer.

Type: VserverIdType

Default: None

Required: Yes

volumeIds

List of volume IDs.

Type: VolumeIdType

Default: None

Required: Yes

Minimum: 1

Maximum: Unbounded

Result Elements

The result elements are contained in AttachVolumesToVserverResult.

requestId

ID of the request.

Type: xs:string

Required: Yes

Examples

Example 1   

The following example attaches a volume to the specified vServer.

HTTP Request

https://<EnterpriseControllerHostname>/iaas/?Action=AttachVolumesToVserver&Version=1&Timestamp=1321384886152&Expires=1321385186152&volumeIds.1=VOL-052cb4b4-5e56-4303-8b3a-82d6ba743a15&vserverId=VSRV-8ae29df9-ccfe-4184-acb8-10080665d7f6&AccessKeyId=AK_1&Signature=SIGNATURE_HAS_BEEN_REMOVED_FOR_THE_READABILITY_OF_THE_REQUEST&SignatureMethod=SHA512withRSA&SignatureVersion=1

HTTP Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><result xmlns="http://www.oracle.com/xml/ns/iaas" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AttachVolumesToVserverResult" requestId="151"/>

CreateAccessKeyAsObjectRequest

Description

Action to create an access key for a cloud user for the specified account. This action also allows the creation of an access key on behalf of another user.

Request Parameters

account

ID of the account.Type: AccountIdType

Default: None

Required: Yes

forUser

User name of a different cloud user. A user can create an access key on behalf of another cloud user. This option requires cloud administrator privileges.Type: GenericString

Default: None

Required: No

Result Elements

The CreateAccessKeyAsObjectResult type is created by hand as it contains the AccessKey class and is only required on the client side.

Examples

No examples are provided for this action. See the RegisterAccessKeyRequest action for related examples.


CreateAccessKeyToFileRequest

Description

Action to create the access key file of a cloud user for the specified account. This action also allows the creation of an access key on behalf of another user.

Request Parameters

account

ID of the account.Type: AccountIdType

Default: None

Required: Yes

keyStoreFileName

Name of a file to store the private key of the access key.Type: GenericString

Default: None

Required: Yes

forUser

User name of a different cloud user. User using this option must have cloud administrator privileges.Type: GenericString

Default: None

Required: No

Result Elements

The CreateAccessKeyToFileResult structure contains:

requestId

ID of the request.Type: xs:string

Required: Yes

accessKeyId

ID of the access key.Type: xs:string

Examples

No examples are provided for this action. See the RegisterAccessKeyRequest action for related examples.


CreateDistributionGroupRequest

Description

Action to create a distribution group for an account.

Request Parameters

name

Name of the distribution group.Type: GenericString

Required: Yes

description

Description of the distribution group.Type: GenericString

Required: No

size

Size of the distribution group. The size is the maximum number of vServers that can be added to the distribution group.Type: PositiveInteger

Required: No

Default: 50000

Result Elements

The CreateDistributionGroupResult structure contains:

requestId

ID of the request.Type: xs:string

Required: Yes

distributionGroupId

ID of the distribution group.

Type: xs:string

Examples

Example 1   

The following example creates a distribution group for an account.

HTTP Request

https://<EnterpriseControllerHostname>/iaas/?Action=CreateDistributionGroup&Version=1&Timestamp=1324407098313&Expires=1324407398313&name=myDistributionGroup&AccessKeyId=AK_1&Signature=SIGNATURE_HAS_BEEN_REMOVED_FOR_THE_READABILITY_OF_THE_REQUEST&SignatureMethod=SHA512withRSA&SignatureVersion=1

HTTP Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><result xmlns="http://www.oracle.com/xml/ns/iaas" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CreateDistributionGroupResult" requestId="103"><distributionGroupId>DG-8f81381c-a559-4f5b-b45f-086e605a382b</distributionGroupId></result>
Example 2   

The following example creates a distribution group with a size of 10.

HTTP Request

https://<EnterpriseControllerHostname>/iaas/?Action=CreateDistributionGroup&Version=1&Timestamp=1324407098313&Expires=1324407398313&name=myDistributionGroup2&size=10&AccessKeyId=AK_1&Signature=SIGNATURE_HAS_BEEN_REMOVED_FOR_THE_READABILITY_OF_THE_REQUEST&SignatureMethod=SHA512withRSA&SignatureVersion=1

HTTP Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><result xmlns="http://www.oracle.com/xml/ns/iaas" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CreateDistributionGroupResult" requestId="103"><distributionGroupId>DG-9eb288c2-85e7-4392-80a6-d1c1709de4cd</distributionGroupId></result>

CreateKeyPairAsObjectRequest

Description

Action to create a key pair. This is a client-side action only, it does not travel through the network.

Request Parameters

keyName

Name of the key pair to create.Type: xs:stringDefault: None

Required: Yes

Result Elements

The CreateKeyPairAsObjectResult type is created by hand as it contains the KeyPair class and is only needed on the client side.

Examples

No examples are provided for this action. See the RegisterKeyPairRequest action for related examples.


CreateKeyPairToFileRequest

Description

Action to create the key pair file for an account.

Request Parameters

keyName

Name of the key pair to create.Type: GenericString

Default: None

Required: Yes

keyFileName

Name of the file to store the private key of the key pair.Type: GenericString

Default: None

Required: Yes

Result Elements

The CreateKeyPairToFileResult structure contains:

requestId

ID of the request.Type: xs:string

Required: Yes

keyName

Name of the key pair.Type: xs:string

keyFingerprint

Key pair fingerprint.Type: xs:string

Examples

No examples are provided for this action. See the RegisterKeyPairRequest action for related examples.


CreateSnapshotRequest

Description

Action to create a snapshot for an account based on an existing volume.

Request Parameters

name

Name of the snapshot.

Type: GenericString

Required: Yes

description

Description of the snapshot.

Type: GenericString

Required: No

volumeId

ID of the volume.

Type: VolumeIdType

Required: Yes

Result Elements

The result elements are contained in CreateSnapshotResult.

requestId

ID of the request.

Type: xs:string

Required: Yes

snapshotId

ID of the snapshot.

Type: SnapshotIdType

Examples

Example 1   

The following example creates a snapshot based on the specified volume ID.

HTTP Request

https://<EnterpriseControllerHostname>/iaas/?Action=CreateSnapshot&Version=1&Timestamp=1318466247111&Expires=1318466547111&volumeId=VOL-246b5c62-4072-41cf-885b-99d6c63583bd&name=mySnapshot&AccessKeyId=AK_2&Signature=SIGNATURE_HAS_BEEN_REMOVED_FOR_THE_READABILITY_OF_THE_REQUEST&SignatureMethod=SHA512withRSA&SignatureVersion=1

HTTP Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><result xmlns="http://www.oracle.com/xml/ns/iaas" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CreateSnapshotResult" requestId="118"><snapshotId>SNAP-d743e90c-53c5-4b01-a297-e2c944755c48</snapshotId></result>

CreateTagsRequest

Description

Action to create or overwrite one or more tags for an existing resource.

Request Parameters

resourceId

ID of the resource.

Type: ResourceIdType

Default: None

Required: Yes

tags

List of one or more tag names and values.

Type: TagType

Default: None

Required: Yes

Minimum: 1

Maximum: Unbounded

Result Elements

The result elements are contained in CreateTagsResult.

requestId

ID of the request.

Type: xs:string

Required: Yes

Examples

Example 1   

The following example creates a tag for the specified virtual network ID.

HTTP Request

https://<EnterpriseControllerHostname>/iaas/?Action=CreateTags&Version=1&Timestamp=1320101484395&Expires=1320101784395&resourceId=VNET-9ba968d5-e64f-4b54-a639-ee3d398e0d50&tags.1.name=myTag&tags.1.value=myTagValue&AccessKeyId=AK_3&Signature=SIGNATURE_HAS_BEEN_REMOVED_FOR_THE_READABILITY_OF_THE_REQUEST&SignatureMethod=SHA512withRSA&SignatureVersion=1

HTTP Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><result xmlns="http://www.oracle.com/xml/ns/iaas" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CreateTagsResult" requestId="269"/>

CreateVnetRequest

Description

Action to create a virtual network for an account.

Request Parameters

name

Name of the virtual network.

Type: GenericString

Default: None

Required: Yes

description

A description for the virtual network.

Type: GenericString

Default: None

Required: No

size

Size of the virtual network's subnet.

Type: PositiveInteger

Default: 16

Required: No

Result Elements

The result elements are contained in CreateVnetResult.

requestId

ID of the request.

Type: xs:string

Required: Yes

vnetId

ID of the virtual network.

Type: GenericString

Examples

Example 1   

The following example creates a virtual network for an account.

HTTP Request

https://<EnterpriseControllerHostname>/iaas/?Action=CreateVnet&Version=1&Timestamp=1318282423837&Expires=1318282723837&name=myVnet&AccessKeyId=AK_3&Signature=SIGNATURE_HAS_BEEN_REMOVED_FOR_THE_READABILITY_OF_THE_REQUEST&SignatureMethod=SHA512withRSA&SignatureVersion=1

HTTP Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><result xmlns="http://www.oracle.com/xml/ns/iaas" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CreateVnetResult" requestId="140"><vnetId>VNET-0a1b00f5-b87e-4dcc-9047-9d396a44b4d5</vnetId></result>
Example 2   

The following example creates a virtual network for an account and adds a description of it.

HTTP Request

https://<EnterpriseControllerHostname>/iaas/?Action=CreateVnet&Version=1&Timestamp=1318282726109&Expires=1318283026109&description=DescriptionofmyVnet2&name=myVnet2&AccessKeyId=AK_3&Signature=SIGNATURE_HAS_BEEN_REMOVED_FOR_THE_READABILITY_OF_THE_REQUEST&SignatureMethod=SHA512withRSA&SignatureVersion=1

HTTP Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><result xmlns="http://www.oracle.com/xml/ns/iaas" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CreateVnetResult" requestId="141"><vnetId>VNET-00cd848c-771a-4091-b3f4-195a090bbc01</vnetId></result>

CreateVolumeRequest

Description

Action to create a volume for an account.

Request Parameters

name

Name of the volume.

Type: GenericString

Default: None

Required: Yes

description

Description of the volume.

Type: GenericString

Default: None

Required: No

size

Size of the volume in gigabytes (GB). This option should not be used if a snapshot ID is given. An error is generated if both size and snapshotId parameters are used.

Type: PositiveInteger

Default: 16

Required: No

shared

Flag to indicate if the volume is shared with other accounts in a vDC.

Type: xs:boolean

Default: 0 (false)

Required: No

snapshotId

ID of a snapshot. This option should not be used if a size value is given. An error is generated if both size and snapshotId parameters are used.

Type: SnapshotIdType

Default: None

Required: No

Result Elements

The result elements are contained in CreateVolumeResult.

requestId

ID of the request.

Type: xs:string

Required: Yes

volumeId

ID of the volume.

Type: xs:string

Examples

Example 1   

The following example creates a volume of 2 GB.

HTTP Request

https://<EnterpriseControllerHostname>/iaas/?Action=CreateVolume&Version=1&Timestamp=1318462897126&Expires=1318463197126&name=myVol2&size=1&AccessKeyId=AK_2&Signature=SIGNATURE_HAS_BEEN_REMOVED_FOR_THE_READABILITY_OF_THE_REQUEST&SignatureMethod=SHA512withRSA&SignatureVersion=1

HTTP Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><result xmlns="http://www.oracle.com/xml/ns/iaas" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CreateVolumeResult" requestId="110"><volumeId>VOL-246b5c62-4072-41cf-885b-99d6c63583bd</volumeId></result>
Example 2   

The following example creates a volume base on the specified snapshot ID.

HTTP Request

https://<EnterpriseControllerHostname>/iaas/?Action=CreateVolume&Version=1&Timestamp=1320100009343&Expires=1320100309343&snapshotId=SNAP-7a717e39-fe67-4573-a93d-889b3446176b&name=myVol&AccessKeyId=AK_3&Signature=SIGNATURE_HAS_BEEN_REMOVED_FOR_THE_READABILITY_OF_THE_REQUEST&SignatureMethod=SHA512withRSA&SignatureVersion=1

HTTP Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><result xmlns="http://www.oracle.com/xml/ns/iaas" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CreateVolumeResult" requestId="263"><volumeId>VOL-7d4993d6-f7f0-4611-b1a6-aca218746e64</volumeId></result>

DeleteAccessKeyRequest

Description

Action to unregister an access key from an account.

Request Parameters

accessKeyId

ID of the access key.Type: xs:string

Default: None

Required: Yes

Result Elements

The result elements are contained in DeleteAccessKeyResult.

requestId

ID of the request.Type: xs:string

Required: Yes

Examples

Example 1   

The following example unregisters the specified access key of a cloud user.

HTTP Request

https://<EnterpriseControllerHostname>/akm/?Action=DeleteAccessKey&Version=1&Timestamp=1318278941862&Expires=1318279241862&accessKeyId=AK_2

HTTP Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><result xmlns="http://www.oracle.com/xml/ns/iaas" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="DeleteAccessKeyResult" requestId="134"/>

DeleteDistributionGroupRequest

Description

Action to delete a distribution group from an account.

Request Parameters

distributionGroupId

ID of the distribution group.Type: DistributionGroupIdType

Default: None

Required: Yes

Result Elements

The result elements are contained in DeleteDistributionGroupResult.

requestId

ID of the request.Type: xs:string

Required: Yes

Examples

Example 1   

The following example deletes a distribution group from an account.

HTTP Request

https://<EnterpriseControllerHostname>/iaas/?Action=DeleteDistributionGroup&Version=1&Timestamp=1324407269441&Expires=1324407569441&distributionGroupId=DG-8f81381c-a559-4f5b-b45f-086e605a382b&AccessKeyId=AK_1&Signature=SIGNATURE_HAS_BEEN_REMOVED_FOR_THE_READABILITY_OF_THE_REQUEST&SignatureMethod=SHA512withRSA&SignatureVersion=1

HTTP Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><result xmlns="http://www.oracle.com/xml/ns/iaas" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="DeleteDistributionGroupResult" requestId="106"/>

DeleteKeyPairRequest

Description

Action to delete a key pair from an account.

Request Parameters

keyName

Name of the key pair.Type: xs:string

Default: None

Required: Yes

Result Elements

The result elements are contained in DeleteKeyPairResult.

requestId

ID of the request.Type: xs:string

Required: Yes

Examples

Example 1   

The following example deletes a key pair from an account.

HTTP Request

https://<EnterpriseControllerHostname>/iaas/?Action=DeleteKeyPair&Version=1&Timestamp=1318281994430&Expires=1318282294430&keyName=myKeyPair&AccessKeyId=AK_3&Signature=SIGNATURE_HAS_BEEN_REMOVED_FOR_THE_READABILITY_OF_THE_REQUEST&SignatureMethod=SHA512withRSA&SignatureVersion=1

HTTP Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><result xmlns="http://www.oracle.com/xml/ns/iaas" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="DeleteKeyPairResult" requestId="139"/>

DeleteSnapshotRequest

Description

Action to delete an existing snapshot from an account.

Request Parameters

snapshotId

ID of the snapshot.

Type: SnapshotIdType

Default: None

Required: Yes

Result Elements

The result elements are contained in DeleteSnapshotResult.

requestId

ID of the request.

Type: xs:string

Required: Yes

Examples

Example 1   

The following example deletes the specified snapshot.

HTTP Request

https://<EnterpriseControllerHostname>/iaas/?Action=DeleteSnapshot&Version=1&Timestamp=1318624338550&Expires=1318624638550&snapshotId=SNAP-2f2039cd-943b-4072-9ded-e96b54b7ca79&AccessKeyId=AK_2&Signature=SIGNATURE_HAS_BEEN_REMOVED_FOR_THE_READABILITY_OF_THE_REQUEST&SignatureMethod=SHA512withRSA&SignatureVersion=1

HTTP Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><result xmlns="http://www.oracle.com/xml/ns/iaas" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="DeleteSnapshotResult" requestId="234"/>

DeleteTagsRequest

Description

Action to delete one or more existing tags from a resource.

Request Parameters

resourceId

ID of the resource.

Type: ResourceIdType

Default: None

Required: Yes

tags

List of one or more tag names.

Type: TagType

Default: None

Required: Yes

Result Elements

The result elements are contained in DeleteTagsResult.

requestId

ID of the request.

Type: xs:string

Required: Yes

Examples

Example 1   

The following example deletes the specified tag from a virtual network ID.

HTTP Request

https://<EnterpriseControllerHostname>/iaas/?Action=DeleteTags&Version=1&Timestamp=1320102752960&Expires=1320103052960&resourceId=VNET-9ba968d5-e64f-4b54-a639-ee3d398e0d50&tags.1.name=myTag&AccessKeyId=AK_3&Signature=SIGNATURE_HAS_BEEN_REMOVED_FOR_THE_READABILITY_OF_THE_REQUEST&SignatureMethod=SHA512withRSA&SignatureVersion=1

HTTP Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><result xmlns="http://www.oracle.com/xml/ns/iaas" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="DeleteTagsResult" requestId="273"/>

DeleteVnetRequest

Description

Action to delete a private virtual network from an account.

Request Parameters

vnet

ID of the virtual network.

Type: VnetIdType

Default: None

Required: Yes

Result Elements

The result elements are contained in DeleteVnetResult.

requestId

ID of the request.

Type: xs:string

Required: Yes

Examples

Example 1   

The following example deletes the specified private virtual network.

HTTP Request

https://<EnterpriseControllerHostname>/iaas/?Action=DeleteVnet&Version=1&Timestamp=1318283467620&Expires=1318283767620&vnet=VNET-00cd848c-771a-4091-b3f4-195a090bbc01&AccessKeyId=AK_3&Signature=SIGNATURE_HAS_BEEN_REMOVED_FOR_THE_READABILITY_OF_THE_REQUEST&SignatureMethod=SHA512withRSA&SignatureVersion=1

HTTP Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><result xmlns="http://www.oracle.com/xml/ns/iaas" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="DeleteVnetResult" requestId="142"/>

DeleteVolumeRequest

Description

Action to delete a volume from an account.

Request Parameters

volumeId

ID of the volume.

Type: VolumeIdType

Default: None

Required: Yes

Result Elements

The result elements are contained in DeleteVolumeResult.

requestId

ID of the request.

Type: xs:string

Required: Yes

Examples

Example 1   

The following example deletes the specified volume.

HTTP Request

https://<EnterpriseControllerHostname>/iaas/?Action=DeleteVolume&Version=1&Timestamp=1318463692509&Expires=1318463992509&volumeId=VOL-3bbc8f1c-bb4c-4a70-a370-4b6c06d990dc&AccessKeyId=AK_2&Signature=SIGNATURE_HAS_BEEN_REMOVED_FOR_THE_READABILITY_OF_THE_REQUEST&SignatureMethod=SHA512withRSA&SignatureVersion=1

HTTP Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><result xmlns="http://www.oracle.com/xml/ns/iaas" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="DeleteVolumeResult" requestId="113"/>

DeregisterServerTemplateRequest

Description

Action to delete a server template from an account.

Request Parameters

serverTemplateId

ID of the server template.

Type: ServerTemplateIdType

Default: None

Required: Yes

Result Elements

The result elements are contained in DeregisterServerTemplateResult.

requestId

ID of the request.

Type: xs:string

Required: Yes

Examples

Example 1   

The following example deletes the specified server template.

HTTP Request

https://<EnterpriseControllerHostname>/iaas/?Action=DeregisterServerTemplate&Version=1&Timestamp=1320098301701&Expires=1320098601701&serverTemplateId=TMPL-f089b985-f7fc-4b8a-a5f8-df8f44c95f3c&AccessKeyId=AK_3&Signature=SIGNATURE_HAS_BEEN_REMOVED_FOR_THE_READABILITY_OF_THE_REQUEST&SignatureMethod=SHA512withRSA&SignatureVersion=1

HTTP Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><result xmlns="http://www.oracle.com/xml/ns/iaas" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="DeregisterServerTemplateResult" requestId="256"/>

DescribeAccessKeysRequest

Description

Action to display the available access keys for a cloud user.

Request Parameters

forUser

User name of a different cloud user. User using this option must have cloud administrator privileges.Type: GenericString

Default: None

Required: No

Result Elements

The result elements are contained in DescribeAccessKeysResult.

requestId

ID of the request.Type: xs:string

Required: Yes

items

List of access keys and their attributes.Type: DescribeAccessKeysResultItem

Minimum: 0

Maximum: Unbounded

forUser

User name of the other cloud user.Type: GenericString

Examples

Example 1   

The following example displays the available access keys for a cloud user.

HTTP Request

https://<EnterpriseControllerHostname>/akm/?Action=DescribeAccessKeys&Version=1&Timestamp=1318278142966&Expires=1318278442966

HTTP Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><result xmlns="http://www.oracle.com/xml/ns/iaas" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="DescribeAccessKeysResult" requestId="133"><items><accessKeyId>AK_1</accessKeyId><account>ACC-f7fd508a-dad3-4866-a41a-bf8850163c3d</account></items><items><accessKeyId>AK_2</accessKeyId><account>ACC-f7fd508a-dad3-4866-a41a-bf8850163c3d</account></items><user>root</user></result>

DescribeAccountsRequest

Description

Action to display account attributes for a cloud user. This action also allows filtering the accounts displayed by account ID.

Request Parameters

account

List of account IDs.Type: AccountIdType

Default: None

Required: No

forUser

User name of a different cloud user. The user executing the action using this option must have cloud administrator privileges.Type: GenericString

Default: None

Required: No

Result Elements

The result elements are contained in DescribeAccountsResult.

requestId

ID of the request.Type: xs:string

Required: Yes

items

List of the accounts and their attributes.Type: DescribeAccountsResultItem

Minimum: 0

Maximum: Unbounded

forUser

User name of the other cloud user.Type: GenericString

Examples

Example 1   

The following example displays the attributes of all existing accounts for a cloud user.

HTTP Request

https://<EnterpriseControllerHostname>/akm/?
Action=DescribeAccounts&Version=1&Timestamp=1317054664930&Expires=1317054724930

HTTP Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><resultxmlns="http://www.oracle.com/xml/ns/iaas"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:type="DescribeAccountsResult" requestId="102"><items><account>ACC-f7fd508adad3-4866-a41a-bf8850163c3d</account><name>account0</name><description>Mockupaccount for user clouduser0</description></items><items><account>ACC-95adb073-d569-4a45-ac24-f14eba689a86</account><name>account1</name><description>Mockup account foruser clouduser1</description></items><items><account>ACC-ea564db9-c0ee-43de-bb17-55cfb9d105f2</account><name>account2</name><description>Mockup account foruser clouduser2</description></items><items><account>ACC-3e4a5732-1720-4348-b612-43460b1c493d</account><name>account3</name><description>Mockup account foruser clouduser3</description></items><items><account>ACC-2e2fdcb6-1568-435b-b40ce5418c20ab7b</account><name>account4</name><description>Mockup account foruser clouduser4</description></items><user>root</user></result>
Example 2   

The following example displays the attributes of the specified account.

HTTP Request

https://<EnterpriseControllerHostname>/akm/?Action=DescribeAccounts&Version=1&Timestamp=1317055081608&Expires=1317055141608&account=ACC-f7fd508a-dad3-4866-a41a-bf8850163c3d

HTTP Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><resultxmlns="http://www.oracle.com/xml/ns/iaas"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:type="DescribeAccountsResult" requestId="107"><items><account>ACC-f7fd508adad3-4866-a41a-bf8850163c3d</account><name>account0</name><description>Mockupaccount for user clouduser0</description></items><user>root</user></result>

DescribeAttributesRequest

Description

Action to display the value of one or more attributes of a resource.

This action is limited to the following resource types: server templates, snapshots, virtual networks, virtual servers, and volumes.

Request Parameters

resourceId

ID of a resource.Type: ResourceIdType

Default: None

Required: Yes

attrNames

List of one or more attribute names of the resource.Type: GenericString

Default: None

Required: Yes

Result Elements

The result elements are contained in DescribeAttributesResult.

requestId

ID of the request.Type: xs:string

Required: Yes

items

List of the resource attribute names and values.Type: ResourceAttribute

Minimum: 0

Maximum: Unbounded

Examples

Example 1   

The following example lists the values of the ID, size, status, and share attributes for the specified volume ID.

HTTP Request

https://<EnterpriseControllerHostname>/iaas/?Action=DescribeAttributes&Version=1&Timestamp=1318464041596&Expires=1318464341596&attrNames.4=shared&resourceId=VOL-246b5c62-4072-41cf-885b-99d6c63583bd&attrNames.3=size&attrNames.2=status&attrNames.1=id&AccessKeyId=AK_2&Signature=SIGNATURE_HAS_BEEN_REMOVED_FOR_THE_READABILITY_OF_THE_REQUEST&SignatureMethod=SHA512withRSA&SignatureVersion=1

HTTP Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><result xmlns="http://www.oracle.com/xml/ns/iaas" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="DescribeAttributesResult" requestId="115"><items><name>id</name><value>VOL-246b5c62-4072-41cf-885b-99d6c63583bd</value></items><items><name>status</name><value>OK</value></items><items><name>size</name><value>0</value></items><items><name>shared</name></items></result>

DescribeDistributionGroupsRequest

Description

Action to display the attributes of existing distribution groups for an account. This action allows filtering of distribution groups displayed by ID or by attribute names and values. Valid filter names are: id, name, description, status, vservers, and size.

Request Parameters

ids

List of distribution group IDs.Type: DistributionGroupIdType

Default: None

Required: No

filters

List of distribution group attribute names and values.

Type: FilterItem

Default: None

Required: No

Result Elements

The result elements are contained in DescribeDistributionGroupsResult.

requestId

ID of the request.Type: xs:string

Required: Yes

items

List of distribution groups and their attributes.

Type: DescribeDistributionGroupsResultItem

Minimum: 0

Maximum: Unbounded

Examples

Example 1   

The following example displays the available distribution groups for an account.

HTTP Request

https://<EnterpriseControllerHostname>/iaas/?Action=DescribeDistributionGroups&Version=1&Timestamp=1324407152926&Expires=1324407452926&AccessKeyId=AK_1&Signature=SIGNATURE_HAS_BEEN_REMOVED_FOR_THE_READABILITY_OF_THE_REQUEST&SignatureMethod=SHA512withRSA&SignatureVersion=1

HTTP Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><result xmlns="http://www.oracle.com/xml/ns/iaas" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="DescribeDistributionGroupsResult" requestId="105"><items><id>DG-8f81381c-a559-4f5b-b45f-086e605a382b</id><name>myDistributionGroup</name><status>OK</status><vservers>VSRV-062c548b-7346-4318-a802-a223288747e0</vservers><size>10</size></items><items><id>DG-9eb288c2-85e7-4392-80a6-d1c1709de4cd</id><name>myDistributionGroup2</name><status>OK</status><size>10</size></items></result>

DescribeIpAddressesRequest

Description

Action to display allocated IP addresses attributes for an account. This action also allows filtering of the IP addresses displayed.

Request Parameters

filters

List of IP address attribute names and values.Type: FilterItem

Default: None

Required: No

Result Elements

The result elements are contained in DescribeIpAddressesResult.

requestId

ID of the request.Type: xs:string

Required: Yes

items

List of allocated IP addresses and their attributes.

Type: DescribeIpAddressesResultItem

Minimum: 0

Maximum: Unbounded

Examples

Example 1   

The following example lists all allocated IP addresses for an account.

HTTP Request

https://<EnterpriseControllerHostname>/iaas/?Action=DescribeIpAddresses&Version=1&Timestamp=1320339663115&Expires=1320339963115&AccessKeyId=AK_32&Signature=SIGNATURE_HAS_BEEN_REMOVED_FOR_THE_READABILITY_OF_THE_REQUEST&SignatureMethod=SHA512withRSA&SignatureVersion=1

HTTP Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><result xmlns="http://www.oracle.com/xml/ns/iaas" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="DescribeIpAddressesResult" requestId="396"><items><ipAddress>10.6.0.3</ipAddress><vnet>VNET-6ea466f5-6e6b-4159-adf3-8867473d4cf4</vnet></items><items><ipAddress>10.1.0.10</ipAddress><vnet>VNET-aaaaaaa8-bbb4-ccc4-ddd4-ffffffffff02</vnet></items><items><ipAddress>10.1.0.1</ipAddress><vnet>VNET-aaaaaaa8-bbb4-ccc4-ddd4-ffffffffff02</vnet></items><items><ipAddress>10.1.0.0</ipAddress><vnet>VNET-aaaaaaa8-bbb4-ccc4-ddd4-ffffffffff02</vnet></items></result>
Example 2   

The following example displays the allocated IP address attributes for the specified virtual network ID.

HTTP Request

https://<EnterpriseControllerHostname>/iaas/?Action=DescribeIpAddresses&Version=1&Timestamp=1320339820989&Expires=1320340120989&filters.1.filterValue=VNET-6ea466f5-6e6b-4159-adf3-8867473d4cf4&filters.1.filterName=vnet&AccessKeyId=AK_32&Signature=SIGNATURE_HAS_BEEN_REMOVED_FOR_THE_READABILITY_OF_THE_REQUEST&SignatureMethod=SHA512withRSA&SignatureVersion=1

HTTP Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><result xmlns="http://www.oracle.com/xml/ns/iaas" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="DescribeIpAddressesResult" requestId="397"><items><ipAddress>10.6.0.3</ipAddress><vnet>VNET-6ea466f5-6e6b-4159-adf3-8867473d4cf4</vnet></items></result>

DescribeKeyPairsRequest

Description

Action to display attributes of existing key pairs for an account. This action allows filtering of key pairs displayed.

Request Parameters

keyNames

List of key pair names.Type: GenericString

Default: None

Required: No

filters

List of key pair attribute names and values.

Type: FilterItem

Default: None

Required: No

Result Elements

The result elements are contained in DescribeKeyPairsResult.

requestId

ID of the request.Type: xs:string

Required: Yes

items

List of key pairs and their attributes.

Type: DescribeKeyPairsResultItem

Minimum: 0

Maximum: Unbounded

Examples

Example 1   

The following example displays the available key pairs for an account.

HTTP Request

https://<EnterpriseControllerHostname>/iaas/?Action=DescribeKeyPairs&Version=1&Timestamp=1320361610130&Expires=1320361910130&AccessKeyId=AK_32&Signature=SIGNATURE_HAS_BEEN_REMOVED_FOR_THE_READABILITY_OF_THE_REQUEST&SignatureMethod=SHA512withRSA&SignatureVersion=1

HTTP Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><result xmlns="http://www.oracle.com/xml/ns/iaas" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="DescribeKeyPairsResult" requestId="437"><items><name>myKeyPairK</name><fingerprint>02:ed:56:e2:e4:a7:c9:ed:3f:e3:91:34:fc:c7:1a:3a</fingerprint></items><items><name>myKeyPair2</name><fingerprint>c1:0d:00:86:e9:99:1b:e3:43:62:71:0f:00:17:d4:50</fingerprint></items><items><name>myKeyPair3</name><fingerprint>b6:a3:41:2e:fa:f8:24:c2:f6:db:85:6f:e5:1f:8b:fb</fingerprint></items></result>

DescribeServerTemplatesRequest

Description

Action to display attributes of available server templates for an account. This action also allows filtering of server templates displayed.

Request Parameters

ids

List of one or more server template IDs.Type: ServerTemplateIdType

Default: None

Required: No

filters

List of server template attribute names and values.Type: FilterItem

Default: None

Required: No

Result Elements

The result elements are contained in DescribeServerTemplatesResult.

requestId

ID of the request.Type: xs:string

Required: Yes

items

List of server templates and their attributes.

Type: DescribeServerTemplatesResultItem

Examples

Example 1   

The following example lists all the available server templates for an account.

HTTP Request

https://<EnterpriseControllerHostname>/iaas/?Action=DescribeServerTemplates&Version=1&Timestamp=1320088801876&Expires=1320089101876&AccessKeyId=AK_3&Signature=SIGNATURE_HAS_BEEN_REMOVED_FOR_THE_READABILITY_OF_THE_REQUEST&SignatureMethod=SHA512withRSA&SignatureVersion=1

HTTP Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><result xmlns="http://www.oracle.com/xml/ns/iaas" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="DescribeServerTemplatesResult" requestId="245"><items><id>TMPL-e7df3178-12ea-48cc-8a1a-6b3f8256dd0f</id><name>SendReceiveImage.tar.gz</name><status>OK</status><size>-1</size><public>false</public><imageType>VMTemplate</imageType><readOnly>false</readOnly></items><items><id>TMPL-48cfe488-b93d-4085-aa2e-0a3b39d511cd</id><name>OVM_EL52_jeos_i386_PVM_WebLogic10gR3_v10.tar.gz</name><description>Import URLs: [http://example.oracle.com/vm-templates/OVM_EL52_jeos_i386_PVM_WebLogic10gR3_v10.tar.gz]</description><status>OK</status><size>1</size><public>false</public><imageType>VMTemplate</imageType><readOnly>false</readOnly></items></result>
Example 2   

The following example displays the attributes of the specified server template ID.

HTTP Request

https://<EnterpriseControllerHostname>/iaas/?Action=DescribeServerTemplates&Version=1&Timestamp=1320088942728&Expires=1320089242728&ids.1=TMPL-e7df3178-12ea-48cc-8a1a-6b3f8256dd0f&AccessKeyId=AK_3&Signature=SIGNATURE_HAS_BEEN_REMOVED_FOR_THE_READABILITY_OF_THE_REQUEST&SignatureMethod=SHA512withRSA&SignatureVersion=1

HTTP Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><result xmlns="http://www.oracle.com/xml/ns/iaas" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="DescribeServerTemplatesResult" requestId="246"><items><id>TMPL-e7df3178-12ea-48cc-8a1a-6b3f8256dd0f</id><name>SendReceiveImage.tar.gz</name><status>OK</status><size>1</size><public>false</public><imageType>VMTemplate</imageType><readOnly>false</readOnly></items></result>

DescribeSnapshotsRequest

Description

Action to display the attributes of the available snapshots for an account. This action also allows filtering of the snapshots displayed.

Request Parameters

ids

List of one or more snapshot IDs.Type: GenericString

Default: None

Required: No

filters

List of snapshot attribute names and values.Type: FilterItem

Default: None

Required: No

Result Elements

The result elements are contained in DescribeSnapshotsResult.

requestId

ID of the request.Type: xs:string

Required: Yes

items

List of the snapshots and their attributes.

Type: DescribeSnapshotsResultItem

Examples

Example 1   

The following example lists the attibutes of all the available snapshots for an account.

HTTP Request

https://<EnterpriseControllerHostname>/iaas/?Action=DescribeSnapshots&Version=1&Timestamp=1318467903784&Expires=1318468203784&AccessKeyId=AK_2&Signature=SIGNATURE_HAS_BEEN_REMOVED_FOR_THE_READABILITY_OF_THE_REQUEST&SignatureMethod=SHA512withRSA&SignatureVersion=1

HTTP Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><result xmlns="http://www.oracle.com/xml/ns/iaas" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="DescribeSnapshotsResult" requestId="121"><items><id>SNAP-2f2039cd-943b-4072-9ded-e96b54b7ca79</id><name>mySnapshot2</name><status>OK</status></items><items><id>SNAP-d743e90c-53c5-4b01-a297-e2c944755c48</id><name>mySnapshot</name><status>OK</status></items></result>
Example 2   

The following example displays the attributes for the specified snapshot ID.

HTTP Request

https://<EnterpriseControllerHostname>/iaas/?Action=DescribeSnapshots&Version=1&Timestamp=1318468567145&Expires=1318468867145&ids.1=SNAP-2f2039cd-943b-4072-9ded-e96b54b7ca79&AccessKeyId=AK_2&Signature=SIGNATURE_HAS_BEEN_REMOVED_FOR_THE_READABILITY_OF_THE_REQUEST&SignatureMethod=SHA512withRSA&SignatureVersion=1

HTTP Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><result xmlns="http://www.oracle.com/xml/ns/iaas" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="DescribeSnapshotsResult" requestId="122"><items><id>SNAP-2f2039cd-943b-4072-9ded-e96b54b7ca79</id><name>mySnapshot2</name><status>OK</status></items></result>

DescribeTagsRequest

Description

Action to display the tag attributes of the resources with an associated tag. This action also allows filtering of the tags or resources displayed.

Request Parameters

ids

List of one or more resource IDs.Type: ResourceIdType

Default: None

Required: No

filters

List of resource attributes or tag names and values.Type: FilterItem

Default: None

Required: No

Result Elements

The result elements are contained in DescribeTagsResult.

requestId

ID of the request.Type: xs:string

Required: Yes

items

List of the resource tags and their attributes.

Type: DescribeTagsResultItem

Examples

Example 1   

The following example lists all tags available for an account.

HTTP Request

https://<EnterpriseControllerHostname>/iaas/?Action=DescribeTags&Version=1&Timestamp=1320101837081&Expires=1320102137081&AccessKeyId=AK_3&Signature=SIGNATURE_HAS_BEEN_REMOVED_FOR_THE_READABILITY_OF_THE_REQUEST&SignatureMethod=SHA512withRSA&SignatureVersion=1

HTTP Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><result xmlns="http://www.oracle.com/xml/ns/iaas" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="DescribeTagsResult" requestId="270"><items><resourceId>VNET-9ba968d5-e64f-4b54-a639-ee3d398e0d50</resourceId><name>oc.internal.oracle.cloud.security.group.hidden</name><value>private</value></items><items><resourceId>VNET-9ba968d5-e64f-4b54-a639-ee3d398e0d50</resourceId><name>myTag</name><value>myTagValue</value></items><items><resourceId>VNET-2b8b6c91-065c-4645-9cdb-edb3afd92524</resourceId><name>oc.internal.oracle.cloud.security.group.hidden</name><value>private</value></items><items><resourceId>VNET-07e74ad3-1ab1-4188-915d-cbf6242a1eeb</resourceId><name>oc.internal.oracle.cloud.security.group.hidden</name><value>private</value></items></result>
Example 2   

The following example displays existing tag attributes for the specified virtual network ID.

HTTP Request

https://<EnterpriseControllerHostname>/iaas/?Action=DescribeTags&Version=1&Timestamp=1320102284357&Expires=1320102584357&ids.1=VNET-9ba968d5-e64f-4b54-a639-ee3d398e0d50&AccessKeyId=AK_3&Signature=SIGNATURE_HAS_BEEN_REMOVED_FOR_THE_READABILITY_OF_THE_REQUEST&SignatureMethod=SHA512withRSA&SignatureVersion=1

HTTP Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><result xmlns="http://www.oracle.com/xml/ns/iaas" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="DescribeTagsResult" requestId="272"><items><resourceId>VNET-9ba968d5-e64f-4b54-a639-ee3d398e0d50</resourceId><name>oc.internal.oracle.cloud.security.group.hidden</name><value>private</value></items><items><resourceId>VNET-9ba968d5-e64f-4b54-a639-ee3d398e0d50</resourceId><name>myTag</name><value>myTagValue</value></items></result>

DescribeVdcCapabilitiesRequest

Description

Action to display the vDC capabilities for an account. This action also allows filtering of the vDC capabilities displayed.

Request Parameters

filters

List of the virtual data center capability names and values.Type: FilterItem

Default: None

Required: No

Result Elements

The result elements are contained in DescribeVdcCapabilitiesResult.

requestId

ID of the request.Type: xs:string

Required: Yes

items

List of the vDC capabilities and their values.

Type: DescribeVdcCapabilitiesResultItem

Minimum: 1

Maximum: Unbounded

Examples

Example 1   

The following example lists the vDC capabilities for an account.

HTTP Request

https://<EnterpriseControllerHostname>/iaas/?Action=DescribeVdcCapabilities&Version=1&Timestamp=1320085185647&Expires=1320085485647&AccessKeyId=AK_3&Signature=SIGNATURE_HAS_BEEN_REMOVED_FOR_THE_READABILITY_OF_THE_REQUEST&SignatureMethod=SHA512withRSA&SignatureVersion=1

HTTP Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><result xmlns="http://www.oracle.com/xml/ns/iaas" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="DescribeVdcCapabilitiesResult" requestId="243"><items><name>VirtualizationType</name><value>OVM</value></items><items><name>VirtualizationVersion</name><value>3.0.2</value></items><items><name>ProcessorArch</name><value>Default_Intel_F6_M23</value></items><items><name>ProcessorVersion</name><value>Default_Intel_Family:6_Model:23</value></items><items><name>DistributionGroupSupport</name><value>disabled</value></items><items><name>HighAvailabilityUserControl</name><value>disabled</value></items><items><name>HighAvailabilityDefault</name><value>true</value></items></result>
Example 2   

The following example lists the virtualization type of the vDC for an account.

HTTP Request

https://<EnterpriseControllerHostname>/iaas/?Action=DescribeVdcCapabilities&Version=1&Timestamp=1320085633535&Expires=1320085933535&filters.1.filterName=VirtualizationType&AccessKeyId=AK_3&Signature=SIGNATURE_HAS_BEEN_REMOVED_FOR_THE_READABILITY_OF_THE_REQUEST&SignatureMethod=SHA512withRSA&SignatureVersion=1

HTTP Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><result xmlns="http://www.oracle.com/xml/ns/iaas" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="DescribeVdcCapabilitiesResult" requestId="244"><items><name>VirtualizationType</name><value>OVM</value></items></result>

DescribeVnetsRequest

Description

Action to display the attributes of the available virtual networks for an account. This action also allows filtering of the virtual networks displayed.

Request Parameters

ids

List of one or more virtual network IDs.Type: VnetIdType

Default: None

Required: No

filters

List of virtual network attribute names and values.Type: FilterItem

Default: None

Required: No

Result Elements

The result elements are contained in DescribeVnetsResult.

requestId

ID of the request.Type: xs:string

Required: Yes

items

List of the virtual networks and their attributes.

Type: DescribeVnetsResultItem

Minimum: 0

Maximum: Unbounded

Examples

Example 1   

The following example lists the available virtual networks for an account.

HTTP Request

https://<EnterpriseControllerHostname>/iaas/?Action=DescribeVnets&Version=1&Timestamp=1317048258687&Expires=1317048318687&AccessKeyId=AK_1&Signature=SIGNATURE_HAS_BEEN_REMOVED_FOR_READABILITY_OF_THE_REQUEST&SignatureMethod=SHA512withRSA&SignatureVersion=1

HTTP Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><resultxmlns="http://www.oracle.com/xml/ns/iaas" xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance"xsi:type="DescribeVnetsResult" requestId="256"><items><id>VNET-cbd75904-9d34-4ec8-86b9-d917712abaaa</id><name>stevennet</name><description>stevennet</description><status>OK</status><tags><name>oc.internal.oracle.cloud.security.group.hidden</name><value>private</value></tags><ipAddress>192.168.2.0/24</ipAddress></items><items><id>VNET-c41e4523-0578-4b48-a9f6-77d766b053d9</id><name>vnet46</name><description>vnet46</description><status>OK</status><tags><name>oc.internal.oracle.cloud.security.group.hidden</name><value>private</value></tags><ipAddress>192.168.4.0/24</ipAddress></items><items><id>VNET-77d2b71b-a5ff-4d76-bdc4-fbd9317bbdb8</id><name>vnet3</name><description>vnet3</description><status>OK</status><tags><name>oc.internal.oracle.cloud.security.group.hidden</name><value>private</value></tags><ipAddress>192.168.1.0/24</ipAddress></items><items><id>VNET-5d74972a-bcdd-4714-8c7fb67d8010f13c</id><name>vnet123</name><description>vnet1</description><status>OK</status><tags><name>oc.internal.oracle.cloud.security.group.hidden</name><value>private</value></tags><ipAddress>192.168.0.0/24</ipAddress></items><items><id>VNET-7b91f019-b50d-4051-8028-7ed2b0f5d767</id><name>vnet45</name><description>vnet45</description><status>OK</status><tags><name>oc.internal.oracle.cloud.security.group.hidden</name><value>private</value></tags><ipAddress>192.168.3.0/24</ipAddress></items><items><id>VNET-9058613f-efaa-42f4-bc96-9583ec39a481</id><name>vnet47</name><description>vnet47</description><status>OK</status><tags><name>oc.internal.oracle.cloud.security.group.hidden</name><value>private</value></tags><ipAddress>192.168.5.0/24</ipAddress></items></result>
Example 2   

The following example displays the attributes for the specified virtual network.

HTTP Request

https://<EnterpriseControllerHostname>/iaas/?Action=DescribeVnets&Version=1&Timestamp=1317049897108&Expires=1317049957108&ids.1=VNET-cbd75904-9d34-4ec8-86b9-d917712abaaa&AccessKeyId=AK_2&Signature=SIGNATURE_HAS_BEEN_REMOVED_FOR_READABILITY_OF_THE_REQUEST&SignatureMethod=SHA512withRSA&SignatureVersion=1

HTTP Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><resultxmlns="http://www.oracle.com/xml/ns/iaas"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:type="DescribeVnetsResult" requestId="262"><items><id>VNET-cbd75904-9d34-4ec8-86b9-d917712abaaa</id><name>stevennet</name><description>stevennet</description><status>OK</status><tags><name>oc.internal.oracle.cloud.security.group.hidden</name><value>private</value></tags><ipAddress>192.168.2.0/24</ipAddress></items></result>

DescribeVolumesRequest

Description

Action to display the attributes of the available volumes for an account. This action also allows filtering of volumes displayed. Valid filter names are: description, name, shared, status, id, and vservers.

Request Parameters

ids

List of one or more volume IDs.Type: VolumeIdType

Default: None

Required: No

filters

List of volume attribute names and values.Type: FilterItem

Default: None

Required: No

Result Elements

The result elements are contained in DescribeVolumesResult.

requestId

ID of the request.Type: xs:string

Required: Yes

items

List of volumes and their attributes.

Type: DescribeVolumesResultItem

Minimum: 0

Maximum: Unbounded

Examples

Example 1   

The following example displays the attributes of the available volumes for an account.

HTTP Request

https://<EnterpriseControllerHostname>/iaas/?Action=DescribeVolumes&Version=1&Timestamp=1318463287921&Expires=1318463587921&AccessKeyId=AK_2&Signature=SIGNATURE_HAS_BEEN_REMOVED_FOR_THE_READABILITY_OF_THE_REQUEST&SignatureMethod=SHA512withRSA&SignatureVersion=1

HTTP Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><result xmlns="http://www.oracle.com/xml/ns/iaas" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="DescribeVolumesResult" requestId="111"><items><id>VOL-246b5c62-4072-41cf-885b-99d6c63583bd</id><name>myVol2</name><status>OK</status><size>0</size><shared>false</shared><vservers>VSRV-76ed9c11-d5d5-4418-833d-b2025c7bfdeb</vservers></items><items><id>VOL-3bbc8f1c-bb4c-4a70-a370-4b6c06d990dc</id><name>myVol</name><status>OK</status><size>0</size><shared>false</shared><vservers>VSRV-5100c512-fc39-4a59-ade9-653a1e041c10</vservers></items></result>
Example 2   

The following example displays the attributes of the specified volume ID.

HTTP Request

https://<EnterpriseControllerHostname>/iaas/?Action=DescribeVolumes&Version=1&Timestamp=1318463504971&Expires=1318463804971&ids.1=VOL-3bbc8f1c-bb4c-4a70-a370-4b6c06d990dc&AccessKeyId=AK_2&Signature=SIGNATURE_HAS_BEEN_REMOVED_FOR_THE_READABILITY_OF_THE_REQUEST&SignatureMethod=SHA512withRSA&SignatureVersion=1

HTTP Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><result xmlns="http://www.oracle.com/xml/ns/iaas" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="DescribeVolumesResult" requestId="112"><items><id>VOL-3bbc8f1c-bb4c-4a70-a370-4b6c06d990dc</id><name>myVol</name><status>OK</status><size>0</size><shared>false</shared><vservers>VSRV-5100c512-fc39-4a59-ade9-653a1e041c10</vservers></items></result>

DescribeVserverMetricsRequest

Description

Action to display vServer metrics.

This action also allows filtering of the vServers displayed. Valid filter names are: description, name, status, id, and cpuUsage.

Request Parameters

ids

List of one or more vServer IDs.Type: VserverIdType

Default: None

Required: No

filters

List of vServer attribute names and values.Type: FilterItem

Default: None

Required: No

Result Elements

The result elements are contained in DescribeVserversResult.

requestId

ID of the request.Type: xs:string

Required: Yes

items

List of the vServers and their attributes.

Type: DescribeVserverMetricsResultItem

Minimum: 0

Maximum: Unbounded

Examples

Example 1   

The following example displays metrics of all vServers available for an account.

HTTP Request

https://<EnterpriseControllerHostname>/iaas/?Action=DescribeVserverMetrics&Version=1&Timestamp=1320105338731&Expires=1320105638731&AccessKeyId=AK_3&Signature=SIGNATURE_HAS_BEEN_REMOVED_FOR_THE_READABILITY_OF_THE_REQUEST&SignatureMethod=SHA512withRSA&SignatureVersion=1

HTTP Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><result xmlns="http://www.oracle.com/xml/ns/iaas" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="DescribeVserversResult" requestId="276"><items><id>VSRV-2e4f6688-2c57-4f41-8d3d-83d2d71d1a64</id><name>testvserver3</name><description>Oracle VM Virtual Machine</description><status>RUNNING</status><cpuUsage>0.1508</cpuUsage></items><items><id>VSRV-71f63b37-d61e-4900-a1a5-2b7d51b029c9</id><name>testvserver5</name><description>Oracle VM Virtual Machine</description><status>RUNNING</status><cpuUsage>0.067</cpuUsage></items></result>
Example 2   

The following example displays the vServer metrics for the specified vServer ID.

HTTP Request

https://<EnterpriseControllerHostname>/iaas/?Action=DescribeVservers&Version=1&Timestamp=1320105445075&Expires=1320105745075&ids.1=VSRV-2e4f6688-2c57-4f41-8d3d-83d2d71d1a64&AccessKeyId=AK_3&Signature=SIGNATURE_HAS_BEEN_REMOVED_FOR_THE_READABILITY_OF_THE_REQUEST&SignatureMethod=SHA512withRSA&SignatureVersion=1

HTTP Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><result xmlns="http://www.oracle.com/xml/ns/iaas" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="DescribeVserversResult" requestId="277"><items><id>VSRV-2e4f6688-2c57-4f41-8d3d-83d2d71d1a64</id><name>testvserver3</name><description>Oracle VM Virtual Machine</description><status>RUNNING</status><cpuUsage>0.1508</cpuUsage></items></result>

DescribeVserversRequest

Description

Action to display vServer attributes for an account.

This action also allows filtering of of vServers displayed. Valid filter names are: description, name, status, id, serverTemplateId, keyName, vserverType, distributionGroup, volumes, vcpu, memoryMb, dedicatedStorageMb, and attachedStorageMb.

Request Parameters

ids

List of one or more vServer IDs.Type: VserverIdType

Default: None

Required: No

filters

List of vServer attribute names and values.Type: FilterItem

Default: None

Required: No

Result Elements

The result elements are contained in DescribeVserversResult.

requestId

ID of the request.Type: xs:string

Required: Yes

items

List of the vServers and their attributes.

Type: DescribeVserversResultItem

Minimum: 0

Maximum: Unbounded

Examples

Example 1   

The following example displays attributes of all vServers available for an account.

HTTP Request

https://<EnterpriseControllerHostname>/iaas/?Action=DescribeVservers&Version=1&Timestamp=1320105338731&Expires=1320105638731&AccessKeyId=AK_3&Signature=SIGNATURE_HAS_BEEN_REMOVED_FOR_THE_READABILITY_OF_THE_REQUEST&SignatureMethod=SHA512withRSA&SignatureVersion=1

HTTP Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><result xmlns="http://www.oracle.com/xml/ns/iaas" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="DescribeVserversResult" requestId="276"><items><id>VSRV-2e4f6688-2c57-4f41-8d3d-83d2d71d1a64</id><name>testvserver3</name><description>Oracle VM Virtual Machine</description><status>RUNNING</status><vnets>VNET-025a35bf-828d-4e3f-a0f4-76f3d9a73c42</vnets><ipAddresses>192.168.0.18</ipAddresses><serverTemplateId>TMPL-557952b6-0b00-4a00-a2ca-ada480d99cc6598</serverTemplateId><ha>true</ha><volumes>VOL-dc80ef69-109d-4e7d-968d-2fa90b68db1b</volumes><vcpu>2</vcpu><memoryMb>8192</memoryMb><dedicatedStorageMb>6443499520</dedicatedStorageMb><attachedStorageMb>3221225472</attachedStorageMb></items><items><id>VSRV-71f63b37-d61e-4900-a1a5-2b7d51b029c9</id><name>testvserver5</name><description>Oracle VM Virtual Machine</description><status>RUNNING</status><vnets>VNET-025a35bf-828d-4e3f-a0f4-76f3d9a73c42</vnets><ipAddresses>192.168.0.19</ipAddresses><serverTemplateId>TMPL-557952b6-0b00-4a00-a2ca-ada480d99cc6597</serverTemplateId><ha>true</ha><vcpu>1</vcpu><memoryMb>4096</memoryMb><dedicatedStorageMb>6443499520</dedicatedStorageMb><attachedStorageMb>0</attachedStorageMb></items></result>
Example 2   

The following example displays the vServer attributes for the specified vServer ID.

HTTP Request

https://<EnterpriseControllerHostname>/iaas/?Action=DescribeVservers&Version=1&Timestamp=1320105445075&Expires=1320105745075&ids.1=VSRV-2e4f6688-2c57-4f41-8d3d-83d2d71d1a64&AccessKeyId=AK_3&Signature=SIGNATURE_HAS_BEEN_REMOVED_FOR_THE_READABILITY_OF_THE_REQUEST&SignatureMethod=SHA512withRSA&SignatureVersion=1

HTTP Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><result xmlns="http://www.oracle.com/xml/ns/iaas" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="DescribeVserversResult" requestId="277">items><id>VSRV-2e4f6688-2c57-4f41-8d3d-83d2d71d1a64</id><name>testvserver3</name><description>Oracle VM Virtual Machine</description><status>RUNNING</status><vnets>VNET-025a35bf-828d-4e3f-a0f4-76f3d9a73c42</vnets><ipAddresses>192.168.0.18</ipAddresses><serverTemplateId>TMPL-557952b6-0b00-4a00-a2ca-ada480d99cc6598</serverTemplateId><ha>true</ha><volumes>VOL-dc80ef69-109d-4e7d-968d-2fa90b68db1b</volumes><vcpu>2</vcpu><memoryMb>8192</memoryMb><dedicatedStorageMb>6443499520</dedicatedStorageMb><attachedStorageMb>3221225472</attachedStorageMb></items></result>

DescribeVserverTypesRequest

Description

Action to display the permitted vServer types for an account.

Request Parameters

There are no request parameters for this action.

Result Elements

The result elements are contained in DescribeVserverTypesResult. If the response is an empty list, contact your cloud administrator to verify your cloud user's privileges.

requestId

ID of the request.Type: xs:string

Required: Yes

items

List of vServer types and their attributes.

Type: DescribeVserverTypesResultItem

Minimum: 1

Examples

Example 1   

The following example lists all available vServer types for an account.

HTTP Request

https://<EnterpriseControllerHostname>/iaas/?Action=DescribeVserverTypes&Version=1&Timestamp=1318625453358&Expires=1318625753358&AccessKeyId=AK_2&Signature=SIGNATURE_HAS_BEEN_REMOVED_FOR_THE_READABILITY_OF_THE_REQUEST&SignatureMethod=SHA512withRSA&SignatureVersion=1

HTTP Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><result xmlns="http://www.oracle.com/xml/ns/iaas" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="DescribeVserverTypesResult"requestId="236"><items><id>small</id><name>small</name><description>small instance type</description><memorySize>1073741824</memorySize><storageSize>10737418240</storageSize><vcpu>1</vcpu></items><items><id>medium</id><name>medium</name><description>medium instance type</description><memorySize>4294967296</memorySize>
<storageSize>107374182400</storageSize><vcpu>2</vcpu></items><items><id>large</id><name>large</name><description>large instance type</description>
<memorySize>17179869184</memorySize><storageSize>1073741824000</storageSize><vcpu>4</vcpu></items></result>

DetachVolumesFromVserverRequest

Description

Action to detach one or more volumes from a vServer.

Request Parameters

vserverId

ID of the vServer.

Type: VserverIdType

Default: None

Required: Yes

volumeIds

List of one of more volume IDs.

Type: VolumeIdType

Default: None

Required: Yes

force

Option to force detach.

Type: xs:boolean

Default: 0 (false)

Required: No

Result Elements

The result elements are contained in DetachVolumesFromVserverResult.

requestId

ID of the request.

Type: xs:string

Required: Yes

Examples

Example 1   

The following example detaches the specified volumes from the vServer.

HTTP Request

https://<EnterpriseControllerHostname>/iaas/?Action=DetachVolumesFromVserver&Version=1&Timestamp=1321385229679&Expires=1321385529679&volumeIds.1=VOL-052cb4b4-5e56-4303-8b3a-82d6ba743a15&force=true&vserverId=VSRV-8ae29df9-ccfe-4184-acb8-10080665d7f6&AccessKeyId=AK_1&Signature=SIGNATURE_HAS_BEEN_REMOVED_FOR_THE_READABILITY_OF_THE_REQUEST&SignatureMethod=SHA512withRSA&SignatureVersion=1

HTTP Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><result xmlns="http://www.oracle.com/xml/ns/iaas" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="DetachVolumesFromVserverResult" requestId="156"/>

ImportKeyPairRequest

Description

Action to import an existing key pair to an account.

When importing a key pair, the cloud user supplies the file that stores the public key and then the public key is registered. The cloud user manages the private key himself.

ImportKeyPair is a client-side action, it internally makes a call to the RegisterKeyPair action.

Request Parameters

keyName

Name of the key pair.Type: xs:string

Default: None

Required: Yes

keyFileName

Name of the file that stores the public key of the key pair to import.Type: GenericString

Default: None

Required: Yes

Result Elements

The result elements are contained in ImportKeyPairResult.

requestId

ID of the request.Type: xs:string

Required: Yes

keyName

Name of the key pair.Type: xs:string

keyFingerprint

Key pair fingerprint.Type: xs:string

Examples

Example 1   

The following example imports and registers a key pair using the public key in the specified key file.

HTTP Request

https://<EnterpriseControllerHostname>/iaas/?Action=RegisterKeyPair&Version=1&Timestamp=1324421510757&Expires=1324421810757&publicKey=ssh-rsa+AAAAB3NzaC1yc2EAAAABIwAAAQEAtJnFD8INGLtM%2FQIlxkDjh4t2R4%2FtTMpUDzMIRP%0A&keyName=myKeyPair&AccessKeyId=AK_1&Signature=SIGNATURE_HAS_BEEN_REMOVED_FOR_THE_READABILITY_OF_THE_REQUEST&SignatureMethod=SHA512withRSA&SignatureVersion=1

HTTP Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><result xmlns="http://www.oracle.com/xml/ns/iaas" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="RegisterKeyPairResult" requestId="110"><keyName>myKeyPair</keyName><keyFingerprint>f4:20:bf:ad:ed:e7:0a:1a:a5:74:f9:80:72:bb:74:b4</keyFingerprint></result>

ImportVolumeRequest

Description

Action to import a volume to an account.

Request Parameters

name

Name of the volume.

Type: GenericString

Required: Yes

description

Description of the volume.

Type: GenericString

Required: No

url

URL of the volume to import.

Type: URLType

Required: No

shared

Flag to indicate if the volume is shared.

Type: xs:boolean

Default: 0 (false)

Required: No

Result Elements

The result elements are contained in ImportVolumeResult.

requestId

ID of the request.

Type: xs:string

Required: Yes

volumeId

ID of the volume.

Type: xs:string

Examples

Example 1   

The following example imports a shared volume for an account.

HTTP Request

https://<EnterpriseControllerHostname>/iaas/?Action=ImportVolume&Version=1&Timestamp=1324421943593&Expires=1324422243593&shared=true&name=myVolumeImported&url=http%3A%2F%2Foracle.com%2FES%2FOVM%2Fvolume%2Fvolume1.img&AccessKeyId=AK_1&Signature=SIGNATURE_HAS_BEEN_REMOVED_FOR_THE_READABILITY_OF_THE_REQUEST&SignatureMethod=SHA512withRSA&SignatureVersion=1

HTTP Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><result xmlns="http://www.oracle.com/xml/ns/iaas" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ImportVolumeResult" requestId="111"><volumeId>VOL-b71cb98a-52db-49cc-aba4-66a1dfb4d13f</volumeId></result>

ModifyAttributesRequest

Description

Action to modify one or more attribute values for a resource.

Request Parameters

resourceId

ID of a resource.Type: ResourceIdType

Default: None

Required: Yes

attributes

List of one or more attribute names and values of a resource.Type: ResourceAttribute

Required: Yes

Result Elements

The result elements are contained in ModifyAttributesResult.

requestId

ID of the request.Type: xs:string

Required: Yes

Examples

Example 1   

The following example modifies the name and description for the specified volume ID.

HTTP Request

https://<EnterpriseControllerHostname>/iaas/?Action=ModifyAttributes&Version=1&Timestamp=1318464546890&Expires=1318464846890&resourceId=VOL-246b5c62-4072-41cf-885b-99d6c63583bd&attributes.2.value=myNewDescription&attributes.2.name=description&attributes.1.name=name&attributes.1.value=myNewName&AccessKeyId=AK_2&Signature=SIGNATURE_HAS_BEEN_REMOVED_FOR_THE_READABILITY_OF_THE_REQUEST&SignatureMethod=SHA512withRSA&SignatureVersion=1

HTTP Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><result xmlns="http://www.oracle.com/xml/ns/iaas" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ModifyAttributesResult" requestId="116"/>

RebootVserversRequest

Description

Action to reboot one or more existing vServers.

Request Parameters

vserverIds

One or more vServer IDs.

Type: VserverIdType

Required: Yes

Result Elements

The result elements are contained in RebootVserversResult.

requestId

ID of the request.

Type: xs:string

Required: Yes

Examples

Example 1   

The following example reboots a vServer.

HTTP Request

https://<EnterpriseControllerHostname>/iaas/?Action=RebootVservers&Version=1&Timestamp=1321380470326&Expires=1321380770326&vserverIds.1=VSRV-0fb57293-347c-4717-96ef-6dd23154596f&AccessKeyId=AK_1&Signature=SIGNATURE_HAS_BEEN_REMOVED_FOR_THE_READABILITY_OF_THE_REQUEST&SignatureMethod=SHA512withRSA&SignatureVersion=1

HTTP Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><result xmlns="http://www.oracle.com/xml/ns/iaas" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="RebootVserversResult" requestId="121"/>

ReceiveMessageFromVserverRequest

Description

Action to read a message from a vServer.

This action reads a message by name from the common buffer in the virtualization layer. This action may return an error if the vServer is not in an appropriate state to receive messages.

Request Parameters

vserverId

ID of the vServer.

Type: VserverIdType

Required: Yes

key

Name of the key for the message to retrieve.

Type: GenericString

Required: Yes

Result Elements

The result elements are contained in ReceiveMessageFromVserverResult.

requestId

ID of the request.

Type: xs:string

Required: Yes

value

Value of the message.

Type: xs:string

Examples

Example 1   

The following example receives a message from a vServer.

HTTP Request

https://<EnterpriseControllerHostname>/iaas/?Action=ReceiveMessageFromVserver&Version=1&Timestamp=1321381585564&Expires=1321381885564&vserverId=VSRV-8ae29df9-ccfe-4184-acb8-10080665d7f6&key=myMessageKey&AccessKeyId=AK_1&Signature=SIGNATURE_HAS_BEEN_REMOVED_FOR_THE_READABILITY_OF_THE_REQUEST&SignatureMethod=SHA512withRSA&SignatureVersion=1

HTTP Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><result xmlns="http://www.oracle.com/xml/ns/iaas" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ReceiveMessageFromVserverResult" requestId="123"<value>myMessageFromVserver</value></result>

RegisterAccessKeyRequest

Description

Action to register an access key of a cloud user to the specified account. This action also allows the creation of an access key on behalf of another cloud user. In that case, the user running this action requires cloud administrator privileges.

Request Parameters

publicKey

Public key of the access key.Type: xs:string

Required: Yes

account

ID of the account.Type: AccountIdType

Required: Yes

forUser

Name of another cloud user.Type: GenericString

Required: No

Result Elements

The result elements are contained in RegisterAccessKeyResult.

requestId

ID of the request.Type: xs:string

Required: Yes

accessKeyId

ID of the access key.Type: xs:string

Examples

Example 1   

The following example registers an access key for an account.

HTTP Request

https://<EnterpriseControllerHostname>/akm/?Action=RegisterAccessKey&Version=1&Timestamp=1317055640451&Expires=1317055700451&publicKey=MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA3XtkY0aBtOSFZcmk%2FPjiMj7xyGCzRB2I%0AwQXV%2BQiY5La1Ppj8fSxrs1t85Hy2%2FUY8gfVYy3peGm1mkdo0xtFfP90ACxKAH7Z8%2B8LqgPT6wDxY%0AxlkOF9k80M9fHxXrfWNfxfw87yd%2FNZdeZOvgRxW8B%2BsuHmAV5HyRRFKuiQFko7EYVAijFIhRv7ez%0AThKNmP%2BSrOGvPuUoG035TDloSbdpQ08ZGurvIdGevcJpM3IfOEy5tqyfU%2FdvtaLh%2FyhabUjCZN6E%0AqGs2t9C75D9sgVy%2FykbDiXYOorRV3wUoatB43YDPpx5TjpJZIogeF1vCVETDGg6sKsvl%2FpqRU3FH%0AWTHCOwIDAQAB&account=ACC-f7fd508a-dad3-4866-a41a-bf8850163c3d

HTTP Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><resultxmlns="http://www.oracle.com/xml/ns/iaas"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:type="RegisterAccessKeyResult"requestId="110"><accessKeyId>AK_1</accessKeyId></result>

RegisterKeyPairRequest

Description

Action to register a key pair for an account.

Request Parameters

keyName

Name of the key pair.Type: xs:string

Required: Yes

publicKey

Public key of the key pair.Type: xs:string

Required: Yes

Result Elements

The result elements are contained in RegisterKeyPairResult.

requestId

ID of the request.Type: xs:string

Required: Yes

keyFingerprint

Key pair fingerprint.Type: xs:string

Examples

Example 1   

The following example registers a key pair for an account.

HTTP Request

https://<EnterpriseControllerHostname>/iaas/?Action=RegisterKeyPair&Version=1&Timestamp=1318279380444&Expires=1318279680444&publicKey=ssh-rsa+AAAAB3NzaC1yc2EAAAADAQABAAABAQDg2eienGE4vEMSMcVMbYbC8z2q%2Fvhz3H6AanlJ6B4udseK%0A8CpaHJ23eGWcjcgAmuZCJ%2FOoHUA2dN2PNPuK6g%2BZndR8wVaaQT89eWDZx9oaf0%2F2Eg%2FLeKJ3moVH%0AvIYvFB9aFCpa4H%2BOmLfM%2FmfQ4CYeDfo0r0jxCCB0YLo0876LQqK5X%2BtgRXwbAbPH2Mzbzp%2FzzdkQ%0ArsBqSgUQ%2B1V4LkN6TQe06P5a2QYIlUhRXwUorTnbXczGq9zEJJ7ef%2F74xIQZfAipkYkyGgktsXrM%0A%2F%2Bs789v9ipaDB5B26y3aqjIdvW4ZLDvuGXPs60aiUfj2WGIqx0KSVL%2FyB%2FtK1WbuZYwl+IaaS-Generated&keyName=myKeyPairK&AccessKeyId=AK_3&Signature=SIGNATURE_HAS_BEEN_REMOVED_FOR_THE_READABILITY_OF_THE_REQUEST&SignatureMethod=SHA512withRSA&SignatureVersion=1

HTTP Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><result xmlns="http://www.oracle.com/xml/ns/iaas" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="RegisterKeyPairResult" requestId="137"><keyFingerprint>65:3d:ac:81:90:21:2c:4e:65:78:99:b2:37:13:00:93</keyFingerprint></result>

RegisterServerTemplateFromUrlRequest

Description

Action to register a server template from a URL.

Request Parameters

name

Name of the server template.

Type: GenericString

Required: Yes

description

Description of the server template.

Type: GenericString

Required: No

url

URL of the server template.

Type: URLType

Required: Yes

Result Elements

The result elements are contained in RegisterServerTemplateFromUrlResult.

requestId

ID of the request.

Type: xs:string

Required: Yes

serverTemplateId

ID of the server template.

Type: xs:string

Examples

Example 1   

The following example registers a server template for an account.

HTTP Request

https://<EnterpriseControllerHostname>/iaas/?Action=RegisterServerTemplateFromUrl&Version=1&Timestamp=1320096741216&Expires=1320097041216&name=myST&url=http%3A%2F%2Fexample.oracle.com%2Fvm-templates%2FOVM_EL52_jeos_i386_PVM_WebLogic10gR3_v10.tar.gz&AccessKeyId=AK_3&Signature=SIGNATURE_HAS_BEEN_REMOVED_FOR_THE_READABILITY_OF_THE_REQUEST&SignatureMethod=SHA512withRSA&SignatureVersion=1

HTTP Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><result xmlns="http://www.oracle.com/xml/ns/iaas" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="RegisterServerTemplateFromUrlResult" requestId="248"><serverTemplateId>TMPL-f089b985-f7fc-4b8a-a5f8-df8f44c95f3c</serverTemplateId></result>

RegisterServerTemplateFromVserverRequest

Description

Action to register a server template from a vServer.

Request Parameters

name

Name of the server template.

Type: GenericString

Required: Yes

description

Description of the server template.

Type: GenericString

Required: No

vserverId

ID of the vServer.

Type: VserverIdType

Required: Yes

Result Elements

The result elements are contained in RegisterServerTemplateFromVserverResult.

requestId

ID of the request.

Type: xs:string

Required: Yes

serverTemplateId

ID of the server template.

Type: xs:string

Examples

Example 1   

The following example creates a server template for an account.

HTTP Request

https://<EnterpriseControllerHostname>/iaas/?Action=RegisterServerTemplateFromVserver&Version=1&Timestamp=1324422880552&Expires=1324423180552&name=mySTfromVserver&vserverId=VSRV-fdba0b48-6e1c-4f41-bde4-2c739dfeeb2f&AccessKeyId=AK_2&Signature=SIGNATURE_HAS_BEEN_REMOVED_FOR_THE_READABILITY_OF_THE_REQUEST&SignatureMethod=SHA512withRSA&SignatureVersion=1

HTTP Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><result xmlns="http://www.oracle.com/xml/ns/iaas" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="RegisterServerTemplateFromVserverResult" requestId="258"><serverTemplateId>TMPL-f047b985-f7fc-4b8a-a5f8-df8f44c95f5a</serverTemplateId></result>

RegisterServerTemplatesFromAssemblyRequest

Description

Action to register a set of server templates from an assembly. Names of the new server templates are taken from the assembly.

Request Parameters

description

Description of the assembly.

Type: GenericString

Required: No

url

URL of the assembly.

Type: URLType

Required: Yes

Result Elements

The result elements are contained in RegisterServerTemplatesFromAssemblyResult.

requestId

ID of the request.

Type: xs:string

Required: Yes

serverTemplateIds

IDs of the server templates.

Type: xs:string

Examples

Example 1   

The following example creates a set of server templates for an account.

HTTP Request

https://<EnterpriseControllerHostname>/iaas/?Action=RegisterServerTemplatesFromAssembly&Version=1&Timestamp=1320097901377&Expires=1320098201377&url=http%3A%2F%2Fadc4120293.us.oracle.com%3A8888%2FmyAssembly.ova&AccessKeyId=AK_3&Signature=SIGNATURE_HAS_BEEN_REMOVED_FOR_THE_READABILITY_OF_THE_REQUEST&SignatureMethod=SHA512withRSA&SignatureVersion=1

HTTP Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><result xmlns="http://www.oracle.com/xml/ns/iaas" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="RegisterServerTemplatesFromAssemblyResult" requestId="254"><serverTemplateIds>ASSM-fe68b60a-b28b-45fa-8115-0801e3df67d5</serverTemplateIds></result>

ReleaseIpAddressesRequest

Description

Action to release one or more allocated IP addresses from a virtual network.

Request Parameters

vnet

ID of the virtual network.

Type: VnetIdType

Required: Yes

ipAddresses

One or more allocated IP addresses.

Type: GenericString

Required: Yes

Result Elements

The result elements are contained in ReleaseIpAddressesResult.

requestId

ID of the request.

Type: xs:string

Required: Yes

Examples

Example 1   

The following example releases the specified IP addresses from the virtual network.

HTTP Request

https://<EnterpriseControllerHostname>/iaas/?Action=ReleaseIpAddresses&Version=1&Timestamp=1320341801846&Expires=1320342101846&ipAddresses.2=10.6.0.10&ipAddresses.1=10.6.0.13&vnet=VNET-6ea466f5-6e6b-4159-adf3-8867473d4cf4&AccessKeyId=AK_32&Signature=SIGNATURE_HAS_BEEN_REMOVED_FOR_THE_READABILITY_OF_THE_REQUEST&SignatureMethod=SHA512withRSA&SignatureVersion=1

HTTP Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><result xmlns="http://www.oracle.com/xml/ns/iaas" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ReleaseIpAddressesResult" requestId="402"/>

RunVserverRequest

Description

Action to create and start a vServer.

Request Parameters

name

Name of the vServer.

Type: GenericString

Required: Yes

description

Description of the vServer.

Type: GenericString

Required: No

serverTemplateId

ID of a server template.

Type: ServerTemplateIdType

Required: Yes

ipAddresses

List of one or more reserved IP addresses.

Type: GenericString

Required: Yes

keyName

Name of a key pair.

Type: GenericString

Required: No

vserverType

ID of the vServer type.

Type: GenericString

Required: Yes

vnets

List of one or more virtual network IDs.

Type: VnetIdType

Required: Yes

volumes

List of one or more volume IDs.

Type: VolumeIdType

Required: No

distGroup

ID of the distribution group.

Type: DistributionGroupIdType

Required: No

ha

Flag to indicate if high availability is enabled for the vServer. The flag is boolean; possible values are true or false.

Type: GenericString

Required: No

messages

List of messages sent as key-value pairs to the vServer.

Type: Message

Required: No

hostname

A host name to set or override the internal host name for the vServer. It must be RFC 1123 compliant.

Type: HostnameType

Required: No

rootPassword

A password to set or override the root password for the vServer.

Type: GenericString

Required: No

Result Elements

The result elements are contained in RunVserverResult.

requestId

ID of the request.

Type: xs:string

Required: Yes

vserverId

ID of the vServer.

Type: xs:string

Examples

Example 1   

The following example creates and starts a vServer.

HTTP Request

https://<EnterpriseControllerHostname>/iaas/?Action=RunVserver&Version=1&Timestamp=1321379615665&Expires=1321379915665&vserverType=457&keyName=myKeyPair&vnets.1=VNET-84ada392-1c13-4f86-8365-1cf7f9c8aadf&name=myVserver&ipAddresses.1=192.168.0.2&serverTemplateId=TMPL-9e4a9ed3-e675-45f1-9d7c-b21c25a55632&AccessKeyId=AK_1&Signature=SIGNATURE_HAS_BEEN_REMOVED_FOR_THE_READABILITY_OF_THE_REQUEST&SignatureMethod=SHA512withRSA&SignatureVersion=1

HTTP Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><result xmlns="http://www.oracle.com/xml/ns/iaas" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="RunVserverResult" requestId="120"><vserverId>VSRV-8ae29df9-ccfe-4184-acb8-10080665d7f6</vserverId></result>

RunVserversRequest

Description

Action to create and start multiple vServers.

Request Parameters

name

Name of the vServers.

Type: GenericString

Required: Yes

description

Description of the vServers.

Type: GenericString

Required: No

serverTemplateId

ID of the server template.

Type: ServerTemplateIdType

Required: Yes

num

Number of vServers.

Type: PositiveInteger

Default: 1

Required: No

vnets

List of one or more virtual network IDs.

Type: VnetIdType

Required: Yes

keyName

Name of the key pair.

Type: GenericString

Required: No

vserverType

ID of the vServer type.

Type: GenericString

Required: Yes

volumes

List of one or more volume IDs.

Type: VolumeIdType

Required: No

distGroup

ID of the distribution group.

Type: DistributionGroupIdType

Required: No

ha

Flag to indicate if high availability is enabled for the vServers. The flag is boolean; possible values are true or false.

Type: GenericString

Required: No

messages

List of messages sent as key-value pairs to the vServers.

Type: Message

Required: No

hostname

A host name to set or override the host name for the vServers. It must be RFC 1123 compliant.

Type: HostnameType

Required: No

rootPassword

A password to set or override the root password for the vServesr.

Type: GenericString

Required: No

Result Elements

The result elements are contained in RunVserversResult.

requestId

ID of the request.

Type: xs:string

Required: Yes

vserverIds

List of one or more vServer IDs.

Type: xs:string

Examples

Example 1   

The following example creates and starts two vServers.

HTTP Request

https://<EnterpriseControllerHostname>/iaas/?Action=RunVservers&Version=1&Timestamp=1320343596868&Expires=1320343896868&vserverType=457&num=2&keyName=myKeyPair&vnets.1=VNET-6ea466f5-6e6b-4159-adf3-8867473d4cf4&name=myVserver&serverTemplateId=TMPL-2f313208-433c-4b92-aae6-6373c38b795e&AccessKeyId=AK_32&Signature=SIGNATURE_HAS_BEEN_REMOVED_FOR_THE_READABILITY_OF_THE_REQUEST&SignatureMethod=SHA512withRSA&SignatureVersion=1

HTTP Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><result xmlns="http://www.oracle.com/xml/ns/iaas" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="RunVserversResult" requestId="409"><vserverIds>VSRV-d6800889-f59b-4798-a57d-3f9f31b0cf1c</vserverIds><vserverIds>VSRV-d6500889-f59b-4567-a65g-3f9f31b0se1d</vserverIds></result>

SendMessagesToVserverRequest

Description

Action to send a list of messages to a vServer. These messages can be read from the guest operating system.

Request Parameters

vserverId

ID of the vServer.

Type: VserverIdType

Required: Yes

messages

List of one or more message key names and values.

Type: Message

Required: Yes

Result Elements

The result elements are contained in SendMessagesToVserverResult.

requestId

ID of the request.

Type: xs:string

Required: Yes

Examples

Example 1   

The following example sends a message to a vServer.

HTTP Request

https://<EnterpriseControllerHostname>/iaas/?Action=SendMessagesToVserver&Version=1&Timestamp=1321381585564&Expires=1321381885564&messages.1.value=Running&messages.1.key=myStatus&vserverId=VSRV-8ae29df9-ccfe-4184-acb8-10080665d7f6&AccessKeyId=AK_1&Signature=SIGNATURE_HAS_BEEN_REMOVED_FOR_THE_READABILITY_OF_THE_REQUEST&SignatureMethod=SHA512withRSA&SignatureVersion=1

HTTP Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><result xmlns="http://www.oracle.com/xml/ns/iaas" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="SendMessagesToVserverResult" requestId="123"/>

StartVserversRequest

Description

Action to start one or more stopped or shutdown vServers.

Request Parameters

vserverIds

One or more vServer IDs.

Type: VserverIdType

Required: Yes

Result Elements

The result elements are contained in StartVserversResult.

requestId

ID of the request.

Type: xs:string

Required: Yes

Examples

Example 1   

The following example starts a vServer.

HTTP Request

https://<EnterpriseControllerHostname>/iaas/?Action=StartVservers&Version=1&Timestamp=1320104759496&Expires=1320105059496&vserverIds.1=VSRV-c1e236e6-ef4d-4936-911a-97923dfbc291&AccessKeyId=AK_3&Signature=SIGNATURE_HAS_BEEN_REMOVED_FOR_THE_READABILITY_OF_THE_REQUEST&SignatureMethod=SHA512withRSA&SignatureVersion=1

HTTP Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><result xmlns="http://www.oracle.com/xml/ns/iaas" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="StartVserversResult" requestId="275"/>

StopVserversRequest

Description

Action to stop one or more running vServers.

Request Parameters

vserverIds

List of one or more vServer IDs.

Type: VserverIdType

Required: Yes

force

Flag to force the action.

Type: xs:boolean

Default: 0 (false)

Required: No

Result Elements

The result elements are contained in StopVserversResult.

requestId

ID of the request.

Type: xs:string

Required: Yes

Examples

Example 1   

The following example stops a vServer.

HTTP Request

https://<EnterpriseControllerHostname>/iaas/?Action=StopVservers&Version=1&Timestamp=1320105610783&Expires=1320105910783&vserverIds.1=VSRV-c1e236e6-ef4d-4936-911a-97923dfbc291&AccessKeyId=AK_3&Signature=SIGNATURE_HAS_BEEN_REMOVED_FOR_THE_READABILITY_OF_THE_REQUEST&SignatureMethod=SHA512withRSA&SignatureVersion=1

HTTP Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><result xmlns="http://www.oracle.com/xml/ns/iaas" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="StopVserversResult" requestId="278"/>

TerminateVserversRequest

Description

Action to delete one or more vServers.

Request Parameters

vserverIds

List of one or more vServer IDs.

Type: VserverIdType

Required: Yes

force

Flag to force the action.

Type: xs:boolean

Default: 0 (false)

Required: No

Result Elements

The result elements are contained in TerminateVserversResult.

requestId

ID of the request.

Type: xs:string

Required: Yes

Examples

Example 1   

The following example deletes a vServer.

HTTP Request

https://<EnterpriseControllerHostname>/iaas/?Action=TerminateVservers&Version=1&Timestamp=1321385662260&Expires=1321385962260&vserverIds.1=VSRV-0fb57293-347c-4717-96ef-6dd23154596f&force=true&AccessKeyId=AK_1&Signature=SIGNATURE_HAS_BEEN_REMOVED_FOR_THE_READABILITY_OF_THE_REQUEST&SignatureMethod=SHA512withRSA&SignatureVersion=1

HTTP Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><result xmlns="http://www.oracle.com/xml/ns/iaas" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="TerminateVserversResult" requestId="160"/>

Data Types

The following data types are described in this section:


AccountIdType

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


DescribeAccessKeysResultItem

Data Type Elements

accessKeyID

ID of the access key.

Type: xs:string

account

Name of the account.

Type: xs:string

Ancestors

None


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


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


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


DescribeKeyPairsResultItem

Data Type Elements

name

Name of the key pair.

Type: xs:string

fingerprint

Fingerprint of the key pair.

Type: xs:string

Ancestors

None


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


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


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


DescribeVdcCapabilitiesResultItem

Data Type Elements

name

Name of vDC capability.

Type: GenericString

value

Value of the vDC capability.

Type: GenericString

Ancestors

None


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


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


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


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


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


DistributionGroupIdType

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


FilterItem

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


HostnameType

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


Message

Data Type Elements

key

Key associated with the message.

Type: GenericString

value

The value of the message.

Type: GenericString

Ancestors

None


PositiveInteger

Data Type Elements

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

Type: xs:integer

minInclusive value: 1

Ancestors

None


ResourceAttribute

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


ResourceIdType

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


SnapshotIdType

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


ServerTemplateIdType

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}


URLType

Data Type Elements

This data type defines the pattern value of a URL.

Type: xs:string

Ancestors

None


VnetIdType

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}


VolumeIdType

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


VserverIdType

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}