Workload Profiles

#340210

Description

A Workload Profile is a model of the workload behavior of a machine for various workload types.

This resource object is used to retrieve the Workload Profiles and associated representative utilization values/charts. It also includes the representative workloads created from transform scenarios (i.e. see /workload-profiles/Transform).

When you create a Workload, you specify the Workload Profile or the expected workload behavior using element workload_profile.

Resource

/workload-profiles

Supported Operations

Table: Workload Profile Supported Operations

Operation	HTTP Method	Input	Output	Description
Get Collection	GET /workload-profiles	None	Workload Profile Type collection of [name, href]	Returns the Representative Workload types. Collection Details, Sort By and Filters are not supported. Example: Getting a Collection of Workload Profile Types
Get Collection	GET /workload-profiles/<workload-profile type>	None	Workload Profile collection of [name, id, href]	Returns the Workload Profiles for the specified type. Collection Details is supported. Sort By and Filters are not supported. Example: Getting a Collection of Workload Profiles of Type Booking
Get Individual	GET /workload-profiles/<workload-profile type>/<workload-profile name>	None	Workload Profiles: Resource Elements (A)	Returns the utilization patterns for the specified Workload Profile. Example: Getting Workload Types for an Individual Booking Workload Profile
Get Individual	GET /workload-profiles/<workload-profile type>/<workload-profile name>/<utilization>/values	None	Workload Profiles: Resource Elements (B)	Returns the values for the specified utilization for the specified Workload Profile. Example: Getting an Individual Workload Type for an Individual Booking Workload Profile

Resource Elements

Table: Workload Profile Resource Elements (A)

Element	Type	Description
name, id, href	strings	See ID, Name and Self Reference (id, name, href).
utilization_values	[name, values, image]	The utilization types for the Workload Profile: name−name of the workload type values−link to return the values image−link to return the graphical chart of the values

Element

Type

Description

name, id, href

strings

See ID, Name and Self Reference (id, name, href).

utilization_values

[name, values, image]

The utilization types for the Workload Profile:

name−name of the workload type
values−link to return the values
image−link to return the graphical chart of the values

Table: Workload Profile Utilization Resource Elements (B)

Element	Type	Description
name, href	strings	See ID, Name and Self Reference (id, name, href).
values	hour [key, value]	The representative workload of the utilization in hourly quartiles. The following is returned: key−represents the hour, from 1..24 value−value for that hour

Element

Type

Description

name, href

strings

See ID, Name and Self Reference (id, name, href).

values

hour [key, value]

The representative workload of the utilization in hourly quartiles. The following is returned:

key−represents the hour, from 1..24
value−value for that hour

Examples

Example: Getting a Collection of Workload Profile Types

The following example shows you how to obtain the collection of workload profile types:

Example: Getting a Collection of Workload Profiles of Type Booking

The following example shows you how to obtain the collection of workload profiles for bookings:

Example: Getting a Collection of Workload Profiles of Type Booking

Request:

GET /workload-profiles/Booking

Response:

[

{

"name": "Low_Utilization",

"id": "Low_Utilization",

"href": "/workload-profiles/Booking/Low_Utilization"

{

"name": "Medium_Utilization",

"id": "Medium_Utilization",

"href": "/workload-profiles/Booking/Medium_Utilization"

{

"name": "Memory_Intensive",

"id": "Memory_Intensive",

"href": "/workload-profiles/Booking/Memory_Intensive"

{

"name": "cluster-avg-system-(vc51v -cluster 4)",

"id": "48232385-45d5-4f51-8543-b05a99bc773c",

"href": "/workload-profiles/Booking/48232385-45d5-4f51-8543-b05a99bc773c"

// ... *SNIP* of Booking Workload Profiles...

]

Example: Getting Workload Types for an Individual Booking Workload Profile

The following example shows you how to get a collection of workload types for a single bookings workload profile:

Example: Getting Workload Types for an Individual Booking Workload Profile

Request:

GET /workload-profiles/Booking/Low_Utilization

Response:

[

{

"name": "Low_Utilization",

"id": "Low_Utilization",

"href": "/workload-profiles/Low_Utilization",

"utilization_values": [

{

"name": "Actual_Mem_Utilization_As_Pct",

"values": "/workload-profiles/Booking/Low_Utilization/Actual_Mem_Utilization_As_Pct/values",

"image": "/workload-profiles/Booking/Low_Utilization/Actual_Mem_Utilization_As_Pct/image"

{

"name": "CPU_Utilization",

"values": "/workload-profiles/Booking/Low_Utilization/CPU_Utilization/values",

"image": "/workload-profiles/Booking/Low_Utilization/CPU_Utilization/image"

// ... *SNIP* of utilization_values ...

]

}

]

Example: Getting an Individual Workload Type for an Individual Booking Workload Profile

Request:

GET /workload-profiles/Booking/Low_Utilization/CPU_Utilization/values

Response:

{

"name": "CPU_Utilization",

"href": "/workload-profiles/booking/Low_Utilization/CPU_Utilization/values",

"values": {

"hour": [

{

"key": 1,

"value": "[1.0, 2.0, 2.0, 20.0, 3.0]"

{

"key": 2,

"value": "[1.0, 2.0, 2.0, 20.0, 3.0]"

// ... *SNIP* ...

{

"key": 24,

"value": "[1.0, 2.0, 2.0, 20.0, 3.0]"

}

]

}