Control Environments

#340070

Description

A Control Environment represents a collection of Infrastructure Groups, which are hosting venues to route workloads. The term Control Environment refers to all three environment types, for the purpose of this guide, of either full control hosting venues, non-control hosting venues or guest-level hosting venues.

With this API, the details of Control Environments can be obtained so that Workloads can be routed appropriately. The API provides stats at each defined timeframe of the timeline.

Hosting Venues

This API supports all environments, of either full control hosting venues, non-control hosting venues or guest-level hosting venues. For details on these types of venues, see Hosting Venues (Help Topic ID 290200).

With respect to this API, the difference between these venues is as follows:

Supported Operations—all operations are supported for all three
Resource Elements—only elements that are applicable to the environment is returned in the response. Specifically:

for non-control and guest-level environments, elements cei, total_guests, total_hosts, required_hosts, outbound_guest_bookings, inbound_host_bookings and outbound_host_bookings are not returned
for non-control environments, element last_refreshed_time is not returned

Resource

/control-environments

Supported Operations

Table: Control Environment Supported Operations

Operation	HTTP Method	Input	Output	Description
Get Collection	GET /control-environments	None	Control Environment collection of [id, name, platform, platform_category, control_type, href, icon]	Default Sort By is defined as: ?sort_by=name. Example: Getting a Collection of Control Environments
Get Individual	GET /control-environments/<id>	None	Control Environments: Resource Elements	Retrieve the Control Environment elements of the specified id. Example: Getting an Individual Control Environment

Operation

HTTP Method

Input

Output

Description

Get Collection

GET /control-environments

None

Control Environment collection of [id, name, platform, platform_category, control_type, href, icon]

Default Sort By is defined as:
?sort_by=name.

Example: Getting a Collection of Control Environments

Get Individual

GET /control-environments/<id>

None

Control Environments: Resource Elements

Retrieve the Control Environment elements of the specified id.

Example: Getting an Individual Control Environment

Resource Elements

Table: Control Environment Resource Elements

Element	Type	Sort By	Filter	Description
id, name, href	strings	S by name	F by name	See ID, Name and Self Reference (id, name, href).
availability_status	string	S	F	Whether or not the Control Environment is available or not for routing. "AVAILABLE"−when all Infrastructure Groups of the Control Environment are either "AVAILABLE" or "BLOCKED_BY_USER", when the Control Environment has been refreshed at least once "UNAVAILABLE"−when the Control Environment has never been refreshed, the last_refreshed_time is older in number of hours than rest.api.WithinHoursFromLastRefreshOfCluster, an Infrastructure Groups is "UNAVAILABLE"
control_type	string		F	The type of control analysis support. "FULL"—fully supported, e.g. for VMware environments "GUEST_LEVEL"—guest-level hosting venue "NONE"—no support, e.g. for external cloud
creation_time	number	S	F	The UTC date and time the Control Environment was created.
icon	href			Link to the icon associated with this Control Environment.
infrastructure_groups	[id, name, platform, platform_category, href, hardware_name, hardware_icon, control_type, color_code_selected, color_code_unselected]			Links to all Infrastructure Groups associated with this Control Environment (including disqualified ones).
last_refreshed_time	number	S sort by last_refresh_time	F filter by last_refresh_time with UTC values	The UTC date and time the Control Environment itself was last refreshed. If the Control Environment has never been refreshed, the following is returned: "last_refreshed_time": 0 Filtering by range with a value of 0 is not supported. e.g. the following does not return all Control Environments that have never been refreshed: ?last_refresh_time_from=0& last_refresh_time_to=0
platform	string		F	The system type being analyzed. For examples: "IBM" "HYPERV" "VMWARE" "XENSERVER" "X86"
platform_category	string		F	The type of platform. Possible categories are: "Internal Virtual"—for control environments, e.g. for a VMware environment whether or not fully controlled through analytics "Internal Physical"—for physical environments, e.g. a Bare Metal "External Cloud"—for external cloud environments, e.g. an AWS environment "External Physical"—for external physical environments, e.g. SoftLayer Bare Metal
stats	Complex, as specified in the Description			The overall statistics of the Control Environment at each timeframe. For each timeframe that has data: cei timeline_name—same as long_name of the Timeline Tags date—same as date of the Timeline Tags total_guests total_hosts required_hosts inbound_guest_bookings outbound_guest_bookings inbound_host_bookings outbound_host_bookings If the Control Environment has never been refreshed or is currently being refreshed (even for a specific timeframe or specific Infrastructure Group), the following is returned: "stats": {} Note: The above counts do not include Infrastructure Groups that have been disqualified.

Examples

Example: Getting a Collection of Control Environments

The following example shows you how to obtain the collection of current Control Console environments:

Example: Getting an Individual Control Environment

The following example shows you how to retrieve a single Control Console environment:

Example: Getting an Individual Control Environment

Request:

GET /control-environments/56fee3a1-f327-46e4-9ff1-9d365964b824

Response:

{

"id": "56fee3a1-f327-46e4-9ff1-9d365964b824",

"name": "Boston",

"platform": "VMWARE",

"platform_category": "Internal Virtual",

"control_type": "FULL"

"stats": {

"TO": {

"cei": 0.79,

"timeline_name": "Today",

"date": 1365480000000,

"total_guests": 273,

"total_hosts": 28,

"required_hosts": 17,

"inbound_guest_bookings": 0,

"outbound_guest_bookings": 0,

"inbound_host_bookings": 0,

"outbound_host_bookings": 0

"90D": {

"cei": 0.89,

"timeline_name": "90 Days",

"date": 1373256000000,

"total_guests": 294,

"total_hosts": 28,

"required_hosts": 0,

"inbound_guest_bookings": 31,

"outbound_guest_bookings": 10,

"inbound_host_bookings": 0,

"outbound_host_bookings": 0

"30D": {

"cei": 0.86,

"timeline_name": "30 Days",

"date": 1368072000000,

"total_guests": 291,

"total_hosts": 28,

"required_hosts": 0,

"inbound_guest_bookings": 18,

"outbound_guest_bookings": 0,

"inbound_host_bookings": 0,

"outbound_host_bookings": 0

"60D": {

"cei": 0.93,

"timeline_name": "60 Days",

"date": 1370664000000,

"total_guests": 304,

"total_hosts": 28,

"required_hosts": 0,

"inbound_guest_bookings": 31,

"outbound_guest_bookings": 0,

"inbound_host_bookings": 0,

"outbound_host_bookings": 0

"7D": {

"cei": 0.79,

"timeline_name": "7 Days",

"date": 1366084800000,

"total_guests": 273,

"total_hosts": 28,

"required_hosts": 0,

"inbound_guest_bookings": 0,

"outbound_guest_bookings": 0,

"inbound_host_bookings": 0,

"outbound_host_bookings": 0

}

"href": "/control-environments/56fee3a1-f327-46e4-9ff1-9d365964b824",

"availability_status": "AVAILABLE",

"creation_time": 1365777303697,

"last_refreshed_time": 1371232491487,

"infrastructure_groups": [

{

"id": "11673bee-6e02-436c-afc5-64692a517e08",

"name": "Bos-Eng&Dev",

"platform": "VMWARE",

"platform_category": "Internal Virtual",

"href": "/infrastructure-groups/11673bee-6e02-436c-afc5-64692a517e08",

"hardware_name": "PowerEdge",

"hardware_icon": http://thedocs1:8086/CIRBA/images/serverModelIcon/Dell_small.png

"control_type": "FULL"

"color_code_selected": "#AACBEC"

"color_code_unselected": "#DCE5F4"

{

"id": "2f29ee1f-0039-47cd-ac34-da927c12705d",

"name": "Bos-ProdApps2",

"platform": "VMWARE",

"platform_category": "Internal Virtual",

"href": "/infrastructure-groups/2f29ee1f-0039-47cd-ac34-da927c12705d",

"hardware_name": "PowerEdge",

"hardware_icon": http://thedocs1:8086/CIRBA/images/serverModelIcon/Dell_small.png

"control_type": "FULL"

"color_code_selected": "#AACBEC"

"color_code_unselected": "#DCE5F4"

{

"id": "5f46fd3f-2df3-4bb6-9a90-f1f245023bc4",

"name": "Bos-ProdApps1",

"platform": "VMWARE",

"platform_category": "Internal Virtual",

"href": "/infrastructure-groups/5f46fd3f-2df3-4bb6-9a90-f1f245023bc4",

"hardware_name": "PowerEdge",

"hardware_icon": http://thedocs1:8086/CIRBA/images/serverModelIcon/Dell_small.png

"control_type": "FULL"

"color_code_selected": "#AACBEC"

"color_code_unselected": "#DCE5F4"

{

"id": "eabe7ff5-bc8a-4b84-8417-cabf8f3209ac",

"name": "Bos-GenApps",

"platform": "VMWARE",

"platform_category": "Internal Virtual",

"href": "/infrastructure-groups/eabe7ff5-bc8a-4b84-8417-cabf8f3209ac",

"hardware_name": "PowerEdge",

"hardware_icon": http://thedocs1:8086/CIRBA/images/serverModelIcon/Dell_small.png

"control_type": "FULL"

"color_code_selected": "#AACBEC"

"color_code_unselected": "#DCE5F4"

}

"icon": "/control-environments/e6cf1672-77ff-4e7d-9dda-5387b0bc95cc/icon"

}