The vCloud Air Platform APIs are designed to work with the service-oriented architecture on which Virtual Private Cloud OnDemand is built.

Understanding the service-oriented architecture is essential to creating API clients to automate operations.

The extensibility of the service-oriented architecture supports the discovery and consumption of services through public APIs, allowing for a common framework, and loosely-coupled services based on a common message bus.

Components of the Service-Oriented Architecture
Components of the Service-Oriented Architecture

API Surfaces for Virtual Private Cloud OnDemand

Component

Capabilities

API URI

Identify Management

■

Authentication and single sign on between services

■

User identity lifecycle management

■

Authorization, such as access control

For information about the APIs for authentication and authorization, see Hello vCloud Air: A Simplified RESTful Workflow.

For information about the APIs for user management, see Managing Users.

/api/iam/login

/api/iam/Users

Service Controller

■

vCloud Air plan and instance management, including the instance lifecycle

■

Exposure of the service-oriented architecture that is available for consumption

■

Discovery of plans and instances by customers

■

Registry for information related to plans and instances

For information about the APIs for the Service Controller, see Hello vCloud Air: A Simplified RESTful Workflow.

/api/sc/plans

/api/sc/instances

Metering Service

Metering data collection and aggregation with an interface to your My VMware account for billing data

For information about the APIs for the Metering Service, see Metering and Billing for Resource Usage.

/api/metering

/api/billing

Compute Service

Exposure of compute (vRAM and vCPU resources for virtual machines), storage, and networking functionality in the public cloud on a pay-as-you-go basis

For information about the APIs for the vCloud Compute Service, see vCloud Air Compute Service Programming Guide (API Version 9.0).

/api/compute

For the list of API surfaces for provisioning within the vCloud Compute Service, see Summary of vCloud API Provisioning Requests in the vCloud Air Compute Service Programming Guide (API Version 9.0).

Networking Service

The pay-as-you-go network services—gateways, networks, vApp/VM networks, firewall and NAT rules

For information about the APIs for the Networking Service, see Network Administration in the vCloud Air Compute Service Programming Guide.

Note

External networks and network pools are system resources managed by vCloud Air administrators with VMware or your authorized service provider.

/api/admin/edgeGateway

/api/admin/vdc/id/networks