Cisco Elastic Service Controller 2.1
REST API Guide
Cisco Systems, Inc.
www.cisco.com
Cisco has more than 200 offices worldwide.
Addresses, phone numbers, and fax numbers
are listed on the Cisco website at
www.cisco.com/go/offices.
Cisco Elastic Service Controller 2.1 REST API Guide
© 1999–2016 Cisco Systems, Inc. All rights reserved.
ESC REST Northbound API Documentation
Introduction
Resources managed by ESC: Tenants, Networks, Subnets, Users, ServiceCatalog, Deployments
GET operations are synchronous the request/response parameters are described with an example of a
request/response
OST, DELETE, PUT operations are asynchronous. The asynchronous design use the “web hooks” approach
using two independent "one-way" invocations - one to start a long-running operation (Client to ESC) and
the other one to notify a requester that it is completed (ESC to client)
The inbound representation of the operation request will contain a callback field, whose value is a URI
where the client expects a callback. If this field is not present, no callback will be performed.
When the operation has completed (either successfully or unsuccessfully), ESC will perform a POST
request to the callback URI, with an entity body containing the final status resource for this operation.
Client can match a completion report back to the original request by comparing the internal transaction ID
field value to the one returned in the initial status response
ESC Clients are expected to provide a REST implementation for all the callbacks.
All POST,DELETE,PUT operations that require request and/or response body must provide a header
parameter for media type. Note, that ESC is currently tested to accept and return XML.
Some string parameters, such as id, name, are restricted by the underlying cloud provider, such as
Openstack. The allowable range for these parameters is included in the Create section for each resource,
in this notation: String minimum-length . . maximum length, for example, for Tenant name: String 1 . . 64
Generally, names are either 1..64 (for Tenant/User) or 1..255 (Network/Subnet/Flavor/Image/VM) Id (such
as uuid) are restricted to 64 characters, such internal_id 1..64, external_id 1..64
ESC imposes this limitation / restriction concerning internal ids:
internal id naming must conform the standards stated in RFC 3986 Uniform Resource Identifier (URI):
Generic Syntax. See sections related to URI encoding, sections 2.2 Reserved Characters and 2.3
Unreserved Characters. ESC will accept an internal id specified in the request URL form the unreserved
character set: unreserved = ALPHA / DIGIT / "-" / "." / "_”
NOTE: the tilde “~” is not supported in the internal id character set
the internal id received in a request must be unique within the scope of all the domain resources
(tenant, network, subnet, service catalog, deployment ) For example, you cannot create 2 networks
with the same internal_network_id, even if the networks are created in different tenants
It is recommended that the ESC north bound client generate internal ids within the scope of the ESC.
NOTE: Reusing ( recycling ) of internal ids is not recommended. This practice can lead to confusion in
trouble shooting.
ESC does not support Use Cases where Resources managed by ESC are modified directly in Openstack, that
is, created/delete/updated out-of-band of ESC. The behavior for out-of-band modifications to Openstack
of resources tenant/user/network/subnet/vm is as follows:
Out-of-Band Action
Result of ESC API call
create
create tenant/user/network/subnet with matching name will fail, with
tenant/user/network/subnet
callback POST 409 conflict
in Openstack
delete of tenant/user/network/subnet, previously created through ESC
delete
tenant/user/network/subnet
in Openstack
update resource in
Openstack
delete vm in Openstack
reboot or shutdown vm in
Openstack
will fail, with callback POST 404 not found
get of tenant/user/network/subnet will return details stored in
esc_database
create of tenant/user/network/subnet will fail, with callback POST 409
conflict
tenant/user/network/subnet in esc database remains unmodified. The result
is a mismatch between esc and Openstack
this will trigger ESC statemachine to perform recovery – a new VM will be
deploy
this will trigger ESC statemachine to perform recovery – VM hard reboot will
be attempted, followed by undeploy/deploy (if required)
Access
Methods
[ Jump to Models ]
Table of Contents
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.
18.
19.
20.
21.
22.
23.
24.
25.
26.
27.
28.
29.
GET /v0/deployments
GET /v0/deployments/{internal_deployment_id}
PUT /v0/deployments/{internal_deployment_id}
POST /v0/deployments/{internal_deployment_id}
DELETE /v0/deployments/{internal_deployment_id}
GET /v0/flavors
GET /v0/flavors/{internalFlavorId}
POST /v0/flavors/{internalFlavorId}
DELETE /v0/flavors/{internalFlavorId}
GET /v0/images
GET /v0/images/{internalImageId}
POST /v0/images/{internalImageId}
DELETE /v0/images/{internalImageId}
GET /v0/reports/requests
GET /v0/reports/resources
GET /v0/tenants
GET /v0/tenants/{internal_tenant_id}
POST /v0/tenants/{internal_tenant_id}
DELETE /v0/tenants/{internal_tenant_id}
GET /v0/{internalTenantId}/networks
GET /v0/{internalTenantId}/networks/{internalNetworkId}
POST /v0/{internalTenantId}/networks/{internalNetworkId}
DELETE /v0/{internalTenantId}/networks/{internalNetworkId}
GET /v0/{internalTenantId}/subnets
GET /v0/{internalTenantId}/subnets/{internalSubnetId}
POST /v0/{internalTenantId}/subnets/{internalSubnetId}
DELETE /v0/{internalTenantId}/subnets/{internalSubnetId}
POST /v0/{internal_tenant_id}/deployments/service/{internal_deployment_id}
POST /v0/{internal_tenant_id}/deployments/vm/{vm_name}
GET /v0/deployments
GET /v0/deployments
Find all deployments (getDeployments)
Up
All deployments created in ESC will be returned as a List
Produces
This API call produces the following media types according to the Accept request header; the media type
will be conveyed by the Content-Type response header.
application/xml
application/json
Responses
200
successful operation
">GET /v0/deployments/{internal_deployment_id}
GET /v0/deployments/{internal_deployment_id}
Up
Find a deployment by its internal ID (getDeployment)
A deployment will be returned if found in ESC
Path parameters
internalDeploymentId (required)
Path Parameter — Internal ID of the deployment (max length 72 characters)
Produces
This API call produces the following media types according to the Accept request header; the media type
will be conveyed by the Content-Type response header.
application/xml
application/json
Responses
200
successful operation
PUT /v0/deployments/{internal_deployment_id}
PUT /v0/deployments/{internal_deployment_id}
Update an existing deployment in ESC (updateUnifiedDeployedService)
Update an existing deployment in ESC
Path parameters
internalDeploymentId (required)
Path Parameter — Internal ID of the deployment (max length 72 characters)
Consumes
This API call consumes the following media types via the Content-Type request header:
application/xml
application/json
Request body
body (optional)
Body Parameter —
Up
Produces
This API call produces the following media types according to the Accept request header; the media type
will be conveyed by the Content-Type response header.
application/xml
application/json
Responses
0
successful operation
POST /v0/deployments/{internal_deployment_id}
POST /v0/deployments/{internal_deployment_id}
Up
Created a deployment (deployUnifiedService)
Create a deployment in ESC
Path parameters
internalDeploymentId (required)
Path Parameter — Internal ID of the deployment (max length 72 characters)
Consumes
This API call consumes the following media types via the Content-Type request header:
application/xml
Request body
body (required)
Body Parameter — ESC datamodel to deploy
Produces
This API call produces the following media types according to the Accept request header; the media type
will be conveyed by the Content-Type response header.
application/xml
Responses
0
successful operation
DELETE /v0/deployments/{internal_deployment_id}
DELETE /v0/deployments/{internal_deployment_id}
Delete a deployment from ESC (unDeployUnifiedService)
Delete a deployment from ESC
Path parameters
internalDeploymentId (required)
Path Parameter — Internal ID of the deployment (max length 72 characters)
Up
Consumes
This API call consumes the following media types via the Content-Type request header:
application/xml
application/json
Produces
This API call produces the following media types according to the Accept request header; the media type
will be conveyed by the Content-Type response header.
application/xml
application/json
Responses
0
successful operation
GET /v0/flavors
GET /v0/flavors
Up
Get all flavors (getFlavors)
All flavors created in ESC will be returned as a List
Produces
This API call produces the following media types according to the Accept request header; the media type
will be conveyed by the Content-Type response header.
application/xml
application/json
Responses
200
successful operation
GET /v0/flavors/{internalFlavorId}
GET /v0/flavors/{internalFlavorId}
Up
Get the flavor by the internal flavor ID (getFlavor)
Flavors not created by ESC will not be checked
Path parameters
internalFlavorId (required)
Path Parameter — Internal flavor ID (max length 72 characters)
Produces
This API call produces the following media types according to the Accept request header; the media type
will be conveyed by the Content-Type response header.
application/xml
application/json
Responses
200
successful operation
POST /v0/flavors/{internalFlavorId}
POST /v0/flavors/{internalFlavorId}
Up
Create a flavor in ESC (createFlavor)
Create a flavor in ESC
Path parameters
internalFlavorId (required)
Path Parameter — Internal flavor ID (max length 72 characters)
Consumes
This API call consumes the following media types via the Content-Type request header:
application/xml
application/json
Request body
body (required)
Body Parameter — ESC datamodel with the flavor to create
Produces
This API call produces the following media types according to the Accept request header; the media type
will be conveyed by the Content-Type response header.
application/xml
application/json
Responses
200
successful operation
DELETE /v0/flavors/{internalFlavorId}
DELETE /v0/flavors/{internalFlavorId}
Delete a flavor from ESC (deleteFlavor)
Delete a flavor from ESC
Path parameters
internalFlavorId (required)
Path Parameter — Internal flavor ID (max length 72 characters)
Consumes
This API call consumes the following media types via the Content-Type request header:
application/xml
application/json
Responses
0
successful operation
GET /v0/images
Up
GET /v0/images
Up
Get all images (getImages)
All images created in ESC will be returned as a List
Produces
This API call produces the following media types according to the Accept request header; the media type
will be conveyed by the Content-Type response header.
application/xml
application/json
Responses
200
successful operation
GET /v0/images/{internalImageId}
GET /v0/images/{internalImageId}
Up
Get the image by the internal image ID (getImage)
Images not created by ESC will not be checked
Path parameters
internalImageId (required)
Path Parameter — Internal image ID (max length 72 characters)
Produces
This API call produces the following media types according to the Accept request header; the media type
will be conveyed by the Content-Type response header.
application/xml
application/json
Responses
200
successful operation
POST /v0/images/{internalImageId}
POST /v0/images/{internalImageId}
Create an image in ESC (createImage)
Create an image in ESC
Path parameters
internalImageId (required)
Path Parameter — Internal image ID (max length 72 characters)
Consumes
This API call consumes the following media types via the Content-Type request header:
application/xml
application/json
Up
Request body
body (required)
Body Parameter — ESC datamodel with the image to create
Produces
This API call produces the following media types according to the Accept request header; the media type
will be conveyed by the Content-Type response header.
application/xml
application/json
Responses
200
successful operation
DELETE /v0/images/{internalImageId}
DELETE /v0/images/{internalImageId}
Up
Delete an image from ESC (deleteImage)
Delete an image from ESC
Path parameters
internalImageId (required)
Path Parameter — Internal image ID (max length 72 characters)
Consumes
This API call consumes the following media types via the Content-Type request header:
application/xml
application/json
Responses
0
successful operation
GET /v0/reports/requests
GET /v0/reports/requests
Up
Get all request details (getRequests)
All request details will be returned
Query parameters
pageNumber (optional)
Query Parameter — default: 0
pageSize (optional)
Query Parameter — default: 0
Produces
This API call produces the following media types according to the Accept request header; the media type
will be conveyed by the Content-Type response header.
application/xml
application/json
Responses
200
successful operation
GET /v0/reports/resources
GET /v0/reports/resources
Up
Get the statistics of resources in ESC (getResourceStat)
All counts of resources in ESC will be returned
Produces
This API call produces the following media types according to the Accept request header; the media type
will be conveyed by the Content-Type response header.
application/xml
application/json
Responses
200
Request accepted and stats are returned successfully
500
Server error happened when getting stats
GET /v0/tenants
GET /v0/tenants
Up
Get all tenants (getTenants)
All tenants in ESC will be returned as a List
Produces
This API call produces the following media types according to the Accept request header; the media type
will be conveyed by the Content-Type response header.
application/xml
application/json
Responses
200
successful operation
GET /v0/tenants/{internal_tenant_id}
GET /v0/tenants/{internal_tenant_id}
Get a tenant by its name (getTenant)
Only tenants created using ESC will be checked
Path parameters
internalTenantId (required)
Path Parameter — Internal tenant ID (max length 72 characters)
Up
Produces
This API call produces the following media types according to the Accept request header; the media type
will be conveyed by the Content-Type response header.
application/xml
application/json
Responses
200
successful operation
POST /v0/tenants/{internal_tenant_id}
POST /v0/tenants/{internal_tenant_id}
Up
Create a tenant in ESC (createTenant)
Create a tenant in ESC
Path parameters
internalTenantId (required)
Path Parameter — Internal tenant ID (max length 72 characters)
Consumes
This API call consumes the following media types via the Content-Type request header:
application/xml
application/json
Request body
body (required)
Body Parameter — Tenant configuration payload
Produces
This API call produces the following media types according to the Accept request header; the media type
will be conveyed by the Content-Type response header.
application/xml
application/json
Responses
200
successful operation
DELETE /v0/tenants/{internal_tenant_id}
DELETE /v0/tenants/{internal_tenant_id}
Delete a tenant from ESC (deleteTenant)
Delete a tenant from ESC
Path parameters
internalTenantId (required)
Path Parameter — Internal tenant ID (max length 72 characters)
Up
Consumes
This API call consumes the following media types via the Content-Type request header:
application/xml
application/json
Responses
0
successful operation
GET /v0/{internalTenantId}/networks
GET /v0/{internalTenantId}/networks
Up
Get all networks under a tenant (getNetworks)
All networks under that tenant in ESC will be returned as a List
Path parameters
internalTenantId (required)
Path Parameter — Internal tenant ID of the network
Produces
This API call produces the following media types according to the Accept request header; the media type
will be conveyed by the Content-Type response header.
application/xml
application/json
Responses
200
successful operation
GET /v0/{internalTenantId}/networks/{internalNetworkId}
Up
GET
/v0/{internalTenantId}/networks/{internalNetworkId}
Get a network by its tenant and internal network ID (getNetwork)
Only networks created using ESC will be checked
Path parameters
internalTenantId (required)
Path Parameter — Internal tenant ID of the network (max length 72 characters)
internalNetworkId (required)
Path Parameter — Internal network ID (max length 72 characters)
Produces
This API call produces the following media types according to the Accept request header; the media type
will be conveyed by the Content-Type response header.
application/xml
application/json
Responses
200
successful operation
POST /v0/{internalTenantId}/networks/{internalNetworkId}
Up
POST
/v0/{internalTenantId}/networks/{internalNetworkId}
Create a network under an existing tenant in ESC (createNetwork)
Create a network in ESC
Path parameters
internalTenantId (required)
Path Parameter — Internal tenant ID of the network (max length 72 characters)
internalNetworkId (required)
Path Parameter — Internal network ID (max length 72 characters)
Consumes
This API call consumes the following media types via the Content-Type request header:
application/xml
application/json
Request body
body (required)
Body Parameter — Network configuration payload
Produces
This API call produces the following media types according to the Accept request header; the media type
will be conveyed by the Content-Type response header.
application/xml
application/json
Responses
200
successful operation
DELETE /v0/{internalTenantId}/networks/{internalNetworkId}
Up
DELETE
/v0/{internalTenantId}/networks/{internalNetworkId}
Delete a network from an existing tenant in ESC (deleteNetwork)
Delete a network from ESC
Path parameters
internalNetworkId (required)
Path Parameter — Internal network ID (max length 72 characters)
internalTenantId (required)
Path Parameter — Internal tenant ID of the network (max length 72 characters)
Consumes
This API call consumes the following media types via the Content-Type request header:
application/xml
application/json
Responses
0
successful operation
GET /v0/{internalTenantId}/subnets
GET /v0/{internalTenantId}/subnets
Up
Get all subnets under a network (getSubnets)
All subnet under that network in ESC will be returned as a List
Path parameters
internalTenantId (required)
Path Parameter — Internal tenant ID of the subnet (max length 72 characters)
Produces
This API call produces the following media types according to the Accept request header; the media type
will be conveyed by the Content-Type response header.
application/xml
application/json
Responses
200
successful operation
GET /v0/{internalTenantId}/subnets/{internalSubnetId}
Up
GET
/v0/{internalTenantId}/subnets/{internalSubnetId}
Get a subnet by its tenant and internal subnet ID (getSubnet)
Only subnets created using ESC will be checked
Path parameters
internalTenantId (required)
Path Parameter — Internal tenant ID of the subnet (max length 72 characters)
internalSubnetId (required)
Path Parameter — Internal subnet ID (max length 72 characters)
Produces
This API call produces the following media types according to the Accept request header; the media type
will be conveyed by the Content-Type response header.
application/xml
application/json
Responses
200
successful operation
POST /v0/{internalTenantId}/subnets/{internalSubnetId}
Up
POST
/v0/{internalTenantId}/subnets/{internalSubnetId}
Create a subnet under an existing tenant in ESC (createSubnet)
Create a subnet in ESC
Path parameters
internalTenantId (required)
Path Parameter — Internal tenant ID of the subnet (max length 72 characters)
internalSubnetId (required)
Path Parameter — Internal subnet ID (max length 72 characters)
Consumes
This API call consumes the following media types via the Content-Type request header:
application/xml
application/json
Request body
body (required)
Body Parameter — Subnet configuration payload
Produces
This API call produces the following media types according to the Accept request header; the media type
will be conveyed by the Content-Type response header.
application/xml
application/json
Responses
200
successful operation
DELETE /v0/{internalTenantId}/subnets/{internalSubnetId}
Up
DELETE
/v0/{internalTenantId}/subnets/{internalSubnetId}
Delete a subnet from an existing tenant in ESC (deleteSubnet)
Delete a subnet from ESC
Path parameters
internalTenantId (required)
Path Parameter — Internal tenant ID of the subnet (max length 72 characters)
internalSubnetId (required)
Path Parameter — Internal subnet ID (max length 72 characters)
Consumes
This API call consumes the following media types via the Content-Type request header:
application/xml
application/json
Responses
0
successful operation
POST /v0/{internal_tenant_id}/deployments/service/{internal_deployment_id}
Up
POST
/v0/{internal_tenant_id}/deployments/service/{internal_
Handle deployment operation request with the operation type as payload (handleOperation)
Path parameters
internalTenantId (required)
Path Parameter — Internal tenant ID (max length 72 characters)
internalDeploymentId (required)
Path Parameter — Internal deployment ID (max length 72 characters)
Consumes
This API call consumes the following media types via the Content-Type request header:
application/xml
application/json
Request body
body (required)
Body Parameter — Deployment operation payload specifying the type of operation
Produces
This API call produces the following media types according to the Accept request header; the media type
will be conveyed by the Content-Type response header.
application/xml
application/json
Responses
200
Deployment operation request accepted
400
Missing callback
404
Deployment or tenant not found
POST /v0/{internal_tenant_id}/deployments/vm/{vm_name}
Up
POST
/v0/{internal_tenant_id}/deployments/vm/{vm_name}
Handle VM operation request with the operation type as payload (handleOperation_1)
Path parameters
internalTenantId (required)
Path Parameter — Internal tenant ID (max length 72 characters)
vmName (required)
Path Parameter — VM name
Consumes
This API call consumes the following media types via the Content-Type request header:
application/xml
application/json
Request body
body (required)
Body Parameter — VM operation payload specifying the type of operation
Produces
This API call produces the following media types according to the Accept request header; the media type
will be conveyed by the Content-Type response header.
application/xml
application/json
Responses
200
VM operation request accepted
400
Missing callback
404
VM or tenant not found
Models
[ Jump to Methods ]
Table of Contents
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.
18.
19.
20.
21.
22.
23.
ClassMetadata
Networks
PortForwards
Opdata
Policies
Address
Configuration
ExternalPortRange
Memory
Deployments
EscVersion
License
SharedIp
Image
AdminRules
Network
RecoveryPolicy
Tenant
Netif
Load
Images
Misc
Flavor
Up
24.
25.
26.
27.
28.
29.
30.
31.
32.
33.
34.
35.
36.
37.
38.
39.
40.
41.
42.
43.
44.
45.
46.
47.
48.
49.
50.
51.
52.
53.
54.
55.
56.
57.
58.
59.
60.
61.
62.
63.
64.
65.
66.
67.
68.
69.
70.
71.
72.
73.
74.
75.
76.
77.
78.
79.
80.
81.
82.
83.
KpiData
UserRules
Volume
Rule
Subnet
Esc_datamodel
Vm_operation
SecurityGroups
UserTenantRole
Containers
PortForward
VmInstance
Request_details
ExternalDependencies
Property
ServiceDefinition
Deployment
VmFlavor
NetworkDependency
Rules
StaticIpAddressPool
Services
Subnets
Type
SubnetAllocationPools
Watchdog
ConfigData
VmStateMachine
StaticMacAddressPool
MetricCollector
Scaling
Interface
Startup
Subnet
Kpi
Resource_stat
Port
Cpu
Deployment
Service_operation
Copyright
Container
Volumes
Placement
Deployment_details
Disk
PortForwarding
VmGroup
Image
Flavor
Flavors
Stats
Disks
ServiceDependency
DeploymentDao
Variable
StateMachine
Tenants
Extensions
Properties
84.
85.
86.
87.
88.
89.
90.
91.
92.
93.
94.
95.
96.
97.
98.
99.
IpAddressRange
Network
Tenant
Bandwidth
Service
UserTenantRoleContainer
Datacenter
Info
Extension
Interfaces
DependsOn
MacAddressRange
AllowedAddressPairs
VmStateMachines
User
StaticLicensePool
ClassMetadata
Up
propertyNames
array[String]
entityName
String
naturalIdentifierProperties
array[Integer]
identifierType
Type
identifierPropertyName
String
propertyTypes
array[Type]
mutable
Boolean
versioned
Boolean
propertyNullability
array[Boolean]
versionProperty
Integer
propertyLaziness
array[Boolean]
inherited
Boolean
Networks
Up
network
array[Network]
PortForwards
port_forward
array[PortForward]
Up
Opdata
Up
status
String
stats
Stats
networks
Networks
images
Images
flavors
Flavors
tenants
Tenants
Policies
Up
external_dependencies
ExternalDependencies
placement
array[Placement]
startup
array[Startup]
Address
Up
ip_address
String
netmask
String
Configuration
Up
dst
String
file
String
data
String
variable
array[Variable]
ExternalPortRange
start
Integer
end
Integer
Up
Memory
Up
mem_total
String
mem_free
String
memory_cached
String
mem_buffered
String
mem_shared
String
swap_total
String
swap_free
String
Deployments
Up
deployment_name
String
service_name
String
service_version
String
deployment_id
String
service_id
String
vm_group
array[VmGroup]
state_machine
StateMachine
EscVersion
major
String
minor
String
sprint
String
release
String
yang_model
String
timestamp
String
Up
License
Up
license_key_value
String
license_key_type
String
license_file
String
license_data
String
SharedIp
Up
nic_id
Integer
shared_ip
String
Image
Up
name
String
image_id
String
public
Boolean
image_name
String
state
String
AdminRules
Up
rule
array[Rule]
Network
name
String
netid
String
shared
Boolean
admin_state
Boolean
router_external
Boolean
provider_physical_network
String
Up
provider_network_type
String
provider_segmentation_id
Long
switch_name
String
vlan_id
Long
number_of_ports
Long
status
String
subnets
Subnets
RecoveryPolicy
Up
action_on_recovery
String
Tenant
Up
external_tenant_id
String
name
String
enabled
Boolean
description
String
tenant_id
String
event_type
String
internal_tenant_id
String
Netif
Up
interfaces
array[Interfaces]
Load
loadone
String
loadfive
String
loadfifteen
Up
String
Images
Up
image
array[Image]
Misc
Up
watchdog
Watchdog
Flavor
Up
name
String
flavor_id
String
public
Boolean
flavor_name
String
state
String
KpiData
Up
enabled
Boolean
kpi
array[Kpi]
UserRules
Up
rule
array[Rule]
Volume
external_volume_id
String
internal_volume_id
String
size
String
sizeunit
String
bus
String
type
String
Up
outOfBand
Boolean
Rule
Up
event_name
String
action
array[String]
Subnet
Up
name
String
subnetid
String
cidr
String
gateway
String
dhcp
Boolean
ipversion
String
Esc_datamodel
Up
version
String
services
Services
tenants
Tenants
networks
Networks
images
Images
flavors
Flavors
opdata
Opdata
info
Info
Vm_operation
operation
String
Up
SecurityGroups
Up
security_group
array[String]
UserTenantRole
Up
internal_tenant_id
String
external_tenant_id
String
role
String
Containers
Up
container
array[Container]
PortForward
Up
port_forwarding_type
String
port_number
String
VmInstance
Up
vm_id
String
name
String
host_id
String
hostname
String
interfaces
Interfaces
volumes
Volumes
Request_details
escTransactionId
String
escTransactionIdOriginal
String
callbackURL
String
callbackEscEvents
String
Up
externalUserId
String
externalTenantId
String
requestType
String
user
user
action
String
resource
String
timestamp
Date
requestPath
String
payLoad
String
ExternalDependencies
Up
service_dependency
ServiceDependency
network_dependency
NetworkDependency
Property
Up
name
String
value
String
ServiceDefinition
deployment_name
String
name
String
version
String
policies
Policies
networks
Networks
vm_group
array[VmGroup]
datacenter
Up
String
Deployment
Up
dbDatamodel
esc_datamodel
dbDeployment
DeploymentDao
deployment_details
array[deployment_details]
internal_tenant_id
String
external_tenant_id
String
internal_service_registration_id
String
internal_deployment_id
String
external_service_registration_id
String
external_deployment_id
String
deployment_stage
String
deployment_name
String
service_name
String
service_version
String
service_state_machine_state
String
datacenter
datacenter
VmFlavor
description
String
vcpus
Integer
sockets
Integer
cores
Integer
threads
Integer
Up
memory_mb
Integer
root_disk_mb
Integer
ephemeral_disk_mb
Integer
swap_disk_mb
Integer
properties
Properties
NetworkDependency
Up
network
array[String]
Rules
Up
admin_rules
AdminRules
user_rules
UserRules
StaticIpAddressPool
Up
network
String
gateway
String
netmask
String
ip_address_range
array[IpAddressRange]
ip_address
array[String]
Services
Up
service_definition
array[ServiceDefinition]
Subnets
Up
subnet
array[Subnet]
Type
collectionType
Boolean
entityType
Up
Boolean
anyType
Boolean
componentType
Boolean
xmlelement
Boolean
mutable
Boolean
associationType
Boolean
name
String
SubnetAllocationPools
Up
start
String
end
String
Watchdog
Up
hardware
String
action
String
ConfigData
Up
configuration
array[Configuration]
VmStateMachine
Up
vm_name
String
state
String
StaticMacAddressPool
Up
network
String
mac_address_range
array[MacAddressRange]
mac_address
array[String]
MetricCollector
Up
type
String
nicid
Integer
proxy
String
poll_frequency
Integer
polling_unit
String
continuous_alarm
Boolean
Scaling
Up
min_active
Integer
min_standby
Integer
max_active
Integer
max_standby
Integer
standby_ratio
String
elastic
Boolean
static_mac_address_pool
array[StaticMacAddressPool]
static_license_pool
StaticLicensePool
static_ip_address_pool
array[StaticIpAddressPool]
Interface
network_uuid
String
subnet_uuid
String
ip_address
String
mac_address
String
security_group
array[String]
port_uuid
Up
String
port_forward
array[PortForward]
type
String
nic_id
Integer
anycast_ip
String
shared_ip
String
netmask
String
gateway
String
Startup
Up
target_vm_group_ref
String
depends_on
array[DependsOn]
Subnet
external_tenant_id
String
external_network_id
String
external_subnet_id
String
name
String
allocation_pools
array[SubnetAllocationPools]
gateway_ip
String
ip_version
Integer
cidr
String
enable_dhcp
Boolean
network_id
String
tenant_id
String
Up
event_type
String
internal_tenant_id
String
subnet_id
String
internal_network_id
String
internal_subnet_id
String
Kpi
Up
event_name
String
metric_value
String
metric_cond
String
metric_type
String
metric_occurrences_true
Integer
metric_occurrences_false
Integer
metric_proxy
String
metric_collector
MetricCollector
Resource_stat
total_vm_count
Integer
active_vm_count
Integer
processing_vm_count
Integer
error_vm_count
Integer
tenant_count
Integer
network_count
Integer
image_count
Integer
flavor_count
Integer
Up
Port
Up
type
String
protocol
String
vnf_port
Integer
external_port_range
array[ExternalPortRange]
Cpu
Up
sockets
Integer
cores
Integer
threads
Integer
cpu_num
Long
cpu_wio
String
cpu_speed
Long
cpu_idle
String
cpu_user
String
cpu_system
String
cpu_aidle
String
Deployment
name
String
policies
Policies
networks
Networks
vm_group
array[VmGroup]
datacenter
String
Up
Service_operation
Up
operation
String
Copyright
Up
company
String
homepage
String
Container
Up
name
String
properties
Properties
Volumes
Up
volume
array[Volume]
Placement
Up
type
String
enforcement
String
host
String
zone
String
Deployment_details
sharedIps
array[SharedIp]
vm_uuid
String
host_uuid
String
host_name
String
vm_name
String
vm_group_name
String
volume
array[Volume]
Up
interface
array[Interface]
vm_state_machine_state
String
Disk
Up
disks
array[Disks]
PortForwarding
Up
port
array[Port]
VmGroup
Up
name
String
vm_instance
array[VmInstance]
shared_ip
array[SharedIp]
Image
serviceRegistrationId
String
imageCheckSum
String
imageIsEnabled
Boolean
external_image_id
String
external_tenant_id
String
name
String
src
String
disk_format
String
container_format
String
e1000_net
Boolean
virtio_net
Boolean
disk_bus
Up
String
size
Integer
sizeunit
String
event_type
String
internal_tenant_id
String
public
Boolean
internal_image_id
String
serial_console
Boolean
cloud_init_support
String
Flavor
Up
properties
map[String, String]
name
String
vcpus
Integer
memory_mb
Integer
root_disk_mb
Integer
ephemeral_disk_mb
Integer
swap_disk_mb
Integer
service_registration_id
String
event_type
String
external_flavor_id
String
internal_flavor_id
String
public
Boolean
Flavors
Up
flavor
array[Flavor]
Stats
Up
hostname
String
os_name
String
os_release
String
arch
String
uptime
Integer
load
Load
cpu
Cpu
memory
Memory
disk
Disk
netif
Netif
Disks
Up
device
String
mount
String
disk_total
Long
disk_used
Long
ServiceDependency
Up
service
array[Service]
DeploymentDao
deploymentId
String
deploymentName
String
tenantId
Up
String
serviceRegistrationId
String
eventTime
String
eventNotificationContentType
Integer
eventNotificationType
Integer
eventNotificationUrl
String
dataModel
String
datacenter
String
classMetadata
ClassMetadata
cardinality
Integer
id
String
Variable
Up
name
String
val
array[String]
StateMachine
Up
state
String
vm_state_machines
VmStateMachines
Tenants
Up
tenant
array[Tenant]
Extensions
Up
extension
array[Extension]
Properties
property
array[Property]
Up
IpAddressRange
Up
start
String
end
String
Network
datacenter
datacenter
status
String
name
String
shared
Boolean
network_id
String
tenant_id
String
external_tenant_id
String
external_network_id
String
subnet
array[String]
admin_state_up
Boolean
event_type
String
internal_tenant_id
String
internal_network_id
String
provider_segmentation_id
String
router_external
Boolean
provider_physical_network
String
provider_network_type
String
vlan_id
Integer
switch_name
String
Up
number_of_ports
Integer
Tenant
Up
name
String
tenant_id
String
networks
Networks
deployments
array[Deployments]
Bandwidth
Up
min
Integer
max
Integer
Service
Up
service_name
String
service_version
String
UserTenantRoleContainer
Up
tenant_role
array[UserTenantRole]
Datacenter
Up
name
String
default
Boolean
Info
Up
product_name
String
esc_version
EscVersion
copyright
Copyright
Extension
Up
name
String
properties
Properties
containers
Containers
Interfaces
Up
interface
array[Interface]
DependsOn
Up
vm_group_ref
String
kpi_event_ref
String
MacAddressRange
Up
start
String
end
String
AllowedAddressPairs
Up
network
array[Network]
address
array[Address]
VmStateMachines
Up
vm_state_machine
array[VmStateMachine]
User
external_user_id
String
name
String
password
String
email
String
enabled
Boolean
description
Up
String
default_tenant_id
String
tenants_roles
UserTenantRoleContainer
event_type
String
user_id
String
tenant_id
String
internal_user_id
String
StaticLicensePool
license
array[License]
Up