Contents

List of Tables

Title and Copyright Information

Preface

• Audience
• Related Documents
• Conventions

1 Get Started With Cloud API and CLI

• About the APIs and CLI
• Overview of Virtual Datacenter Management
• How APIs and CLI Work
• Comparison of Functionality

2 Install Cloud API and CLI

• Prerequisites
• Installation of Cloud Infrastructure API
• Installing Cloud Infrastructure Java Client API
• Installing the Cloud Infrastructure CLI
• Preparing to Use the APIs and CLI

3 Manage Resources

• Overview of Cloud Resources
• Status of a Cloud Resource
• Managing Account Access
  • About Access Keys
  • Creating an Access Key
  • Viewing Access Key Information
  • Deleting an Access Key
• Viewing vDC Capabilities
• Managing Virtual Networks
  • About vNets
  • Creating a vNet
  • Viewing vNet Information
  • Connecting a vNet
  • Deleting a vNet
• Managing vIP Addresses
  • About vIP Addresses
  • Allocating a vIP Address
  • Viewing vIP Addresses
  • Deallocating a vIP Address
  • Blacklisting a vIP Address
  • Displaying Blacklisted vIP Addresses
  • Removing a vIP Address From the Blacklist
• Managing Server Templates
  • About Server Templates
  • Uploading a Server Template from a vServer
  • Uploading a Server Template from a URL
  • Uploading a Server Template from an Assembly
  • Viewing Server Template Information
  • Deleting a Server Template
• Managing Storage
  • About Volumes and Snapshots
  • Creating a Volume
  • Deleting a Volume
  • Viewing Volume Information
  • Attaching a Volume to a vServer
  • Detaching a Volume from a vServer
  • Importing a Volume
  • Creating a Snapshot
  • Deleting a Snapshot
  • Viewing Snapshot Information
• Managing Distribution Groups
  • About Distribution Groups
  • Creating a Distribution Group
  • Deleting a Distribution Group
  • Viewing Distribution Group Information
• Managing vServers
  • About vServers
  • Viewing vServer Types
  • Creating a vServer
  • Deleting a vServer
  • Viewing vServer Information
  • Viewing vServer Metrics
  • Stopping a vServer
  • Starting a vServer
  • Rebooting a vServer
  • Sending a Message to a vServer
  • Receiving a Message from a vServer
• Managing Key Pairs
  • About Key Pairs
  • Creating a Key Pair
  • Importing a Key Pair
  • Deleting a Key Pair
  • Viewing Key Pair Information
• Managing Attributes of an Account Resource
  • About Account Resource Attributes
  • Viewing Attributes of an Account Resource
  • Modifying Attributes of an Account Resource
• Managing Tags
  • About Tags
  • Creating a Tag
  • Removing a Tag
  • Viewing Tag Information

4 Cloud Infrastructure CLI Reference

• Common Command Options
• List of Commands
  • akm-create-access-key
  • akm-delete-access-key
  • akm-describe-access-keys
  • akm-describe-accounts
  • iaas-allocate-ip-addresses
  • iaas-attach-volumes-to-vserver
  • iaas-blacklist-ip-addresses
  • iaas-clear-blacklisted-ip-addresses
  • iaas-connect-vnet
  • iaas-create-distribution-group
  • iaas-create-key-pair
  • iaas-create-server-template-from-assembly
  • iaas-create-server-template-from-url
  • iaas-create-server-template-from-vserver
  • iaas-create-snapshot
  • iaas-create-tags
  • iaas-create-vnet
  • iaas-create-volume
  • iaas-delete-distribution-group
  • iaas-delete-key-pair
  • iaas-delete-server-template
  • iaas-delete-snapshot
  • iaas-delete-tags
  • iaas-delete-vnet
  • iaas-delete-volume
  • iaas-describe-attributes
  • iaas-describe-blacklisted-ip-addresses
  • iaas-describe-distribution-groups
  • iaas-describe-ip-addresses
  • iaas-describe-key-pairs
  • iaas-describe-server-templates
  • iaas-describe-snapshots
  • iaas-describe-tags
  • iaas-describe-vdc-capabilities
  • iaas-describe-vnets
  • iaas-describe-volumes
  • iaas-describe-vserver-metrics
  • iaas-describe-vservers
  • iaas-describe-vserver-types
  • iaas-detach-volumes-from-vserver
  • iaas-import-key-pair
  • iaas-import-volume
  • iaas-modify-attributes
  • iaas-reboot-vservers
  • iaas-receive-message-from-vserver
  • iaas-release-ip-addresses
  • iaas-run-vserver
  • iaas-run-vservers
  • iaas-send-messages-to-vserver
  • iaas-start-vservers
  • iaas-stop-vservers
  • iaas-terminate-vservers

5 Cloud Infrastructure API Reference

• Overview of the Cloud Infrastructure API
• Cloud Infrastructure API Requests
  • Required Web Service HTTP Request Parameters
  • Signing a Web Service Request
• List of Actions
  • AllocateIpAddressesRequest
  • AttachVolumesToVserverRequest
  • BlacklistIpAddressesRequest
  • ClearBlacklistIpAddressesRequest
  • ConnectVnetRequest
  • CreateAccessKeyAsObjectRequest
  • CreateAccessKeyToFileRequest
  • CreateDistributionGroupRequest
  • CreateKeyPairAsObjectRequest
  • CreateKeyPairToFileRequest
  • CreateSnapshotRequest
  • CreateTagsRequest
  • CreateVnetRequest
  • CreateVolumeRequest
  • DeleteAccessKeyRequest
  • DeleteDistributionGroupRequest
  • DeleteKeyPairRequest
  • DeleteSnapshotRequest
  • DeleteTagsRequest
  • DeleteVnetRequest
  • DeleteVolumeRequest
  • DeregisterServerTemplateRequest
  • DescribeAccessKeysRequest
  • DescribeAccountsRequest
  • DescribeAttributesRequest
  • DescribeBlacklistedIpAddressesRequest
  • DescribeDistributionGroupsRequest
  • DescribeIpAddressesRequest
  • DescribeKeyPairsRequest
  • DescribeServerTemplatesRequest
  • DescribeSnapshotsRequest
  • DescribeTagsRequest
  • DescribeVdcCapabilitiesRequest
  • DescribeVnetsRequest
  • DescribeVolumesRequest
  • DescribeVserverMetricsRequest
  • DescribeVserversRequest
  • DescribeVserverTypesRequest
  • DetachVolumesFromVserverRequest
  • ImportKeyPairRequest
  • ImportVolumeRequest
  • ModifyAttributesRequest
  • RebootVserversRequest
  • ReceiveMessageFromVserverRequest
  • RegisterAccessKeyRequest
  • RegisterKeyPairRequest
  • RegisterServerTemplateFromUrlRequest
  • RegisterServerTemplateFromVserverRequest
  • RegisterServerTemplatesFromAssemblyRequest
  • ReleaseIpAddressesRequest
  • RunVserverRequest
  • RunVserversRequest
  • SendMessagesToVserverRequest
  • StartVserversRequest
  • StopVserversRequest
  • TerminateVserversRequest
• Data Types
  • AccountIdType
  • DescribeAccessKeysResultItem
  • DescribeAccountsResultItem
  • DescribeDistributionGroupsResultItem
  • DescribeIpAddressesResultItem
  • DescribeKeyPairsResultItem
  • DescribeServerTemplatesResultItem
  • DescribeSnapshotsResultItem
  • DescribeTagsResultItem
  • DescribeVdcCapabilitiesResultItem
  • DescribeVnetsResultItem
  • DescribeVolumesResultItem
  • DescribeVserverMetricsResultItem
  • DescribeVserversResultItem
  • DescribeVserverTypesResultItem
  • DistributionGroupIdType
  • FilterItem
  • GenericString
  • HostnameType
  • Message
  • PositiveInteger
  • ResourceAttribute
  • ResourceIdType
  • SnapshotIdType
  • ServerTemplateIdType
  • TagType
  • URLType
  • VnetIdType
  • VolumeIdType
  • VserverIdType

A Web Service Client Example

• Description of Web Service API Requests
  • AKM Request
    • REQUEST_DATA Specification
  • IAAS Request
    • REQUEST_IAAS_DATA Specification
    • SIGNATURE_BLOCK Specification
    • IAAS Data Used for Signature
• Sending a Web Service Request
  • Using the Web Browser
  • Using WGET Utility
• Creating Public and Private Keys
  • Private Key
  • Public Key
• Overview of the WebUtil Application
  • How the WebUtil Application Works
• Examples of Web Service Requests
  • Creating an Access Key
  • Executing actions for an account
    • Viewing All Available Virtual Networks
    • Viewing Specific Virtual Networks by Using IDs
    • Viewing Specific Virtual Networks by Using Filters
    • Creating a Private Virtual Network

Index