analysisId

string

The unique referenced ID of the Azure analysis.

When the account grouping feature is enabled and you are working through the Densify API, with the cloud accounts that are part of a group, the workspace ID is replaced by the grouped account's primary key or a unique value that is used as the analysisId or as the ID in the href, that is used to obtain the Impact Analysis and Recommendation Report.

Element Filters

string

You can use element filters to return a targeted subset of the recommendations. See the "F" (filter) designation in the Response schema table for a list of elements that support filtering. Refer to Filters for a complete description of this common operation feature.

Usage example:

../results?recommendationType=Upsize

includeAttributes

• true
• false

Indicate whether or not to return system attributes:

• true—returns all the system attributes;
• false—(default) suppress system attributes from the response output.

Usage example:

../results?includeAttributes=true

dataQuality

string

Allows you to indicate which workload type data collection detail to return for the system. See dataQuality for the returned details.

Specify a quoted list of workload type names for which data to be returned, separated by commas. Contact [email protected] for a listing of the supported workload type names.

Usage example:

../results?dataQuality="CPU Utilization (CINT2006 Rate),Memory Utilization in Percent"

Note: A "400-Bad Request" error message is returned if a non-supported workload type is specified.

entityId

string

F

The Densify assigned entity ID of the cloud system.

resourceId

string

F

The Azure identifier assigned to the instance system.

accountIdRef

string

F

The Azure subscription identifier.

region

string

F

The region containing the instance.

currentType

string

F

The current instance type.

recommendationType

string

F

The recommended action for the system.

This is also known as the Optimization Type in the Densify Console (see Optimization Type Color-Coding Summary).

The following types of recommended actions are supported for this cloud platform:

• "Just Right"—this instance is optimally sized for the workload;
• "Upsize - Optimal Family"—this instance should be upsized to a more optimal instance family;
• "Upsize"—this instance should be upsized to an instance within the same instance family;
• "Terminate"—this instance should be terminated;
• "Downsize - Optimal Family"—this instance should be downsized to an instance belonging to a more suited instance family;
• "Downsize"—this instance should be downsized to an instance within the same instance family;
• "Modernize - Optimal Family"—this instance should be modernized to an instance belonging to a more optimal instance family;
• "Modernize"—this instance should be modernized to an instance within the same instance family.
• "Not Analyzed"—this instance has no recommendation due to insufficient workload information.

For VM Scale Sets, additional recommendation actions are supported:

• Upscale—increase compute capacity by adjusting the maximum group size;
• Downscale—decrease compute capacity by adjusting the minimum group size.

Use recommendationType as a filter to retrieve only system actions of interest.

Systems with insufficient information for analysis do not have a recommendation and are returned with limited elements. See Example: Returning Azure Systems with No Recommendations.

recommendedType

string

F

The recommended instance type after Densify optimization analysis.

implementationMethod

string

F

[Self Optimization|Manual|N/A]

Specifies whether this system is configured for Self-Optimization or Manual actioning based on the recommended action (recommendationType) and on the Self-Optimizing Automation policies.

Note: Self-Optimization is not supported for VM Scale Sets with more than one VM instance, as a result this element is not returned for these VM Scale Sets.

predictedUptime

percentage

The predicted uptime (%) for the system is based on the percentage of hours CPU utilization data is present in the workload range specified in the policy settings.

Predicted uptime % for new systems started mid-way within the workload range is calculated from the time/date that the system was started, as opposed to the beginning of the interval resulting, in more accurate prediction for the future.

totalHoursRunning

string

The total hours that the system has been running, in the workload range.

Total hours for a scale group is the total time the scale group has been running and does not include cumulative hours for all of the in-service instances.

totalHours

string

The total hours since the instance was created, that are within the workload range.

Total hours for a scale group is the total time since the scale group was created and does not include cumulative hours for all of the in-service instances.

If the system is created in the middle of the workload range, then Densify uses the creation date to calculate total hours.

name

string

F

The Azure name assigned to the system.

rptHref

string

The reference resource to the Impact Analysis and Recommendation Report (also known as the Impact Analysis and Recommendation Report report). Use this reference to downoad the report.

This report for the specified instance is available for download after the reporting database tables have been updated (i.e. after RDB populate has been executed). By default, the reporting database tables are updated once every night.

You need to use the following in the request header to download the PDF file:
Accept : application/octet-stream .

Note: HTTPS must be enabled to download the Impact Analysis and Recommendation Report PDF.

See Viewing the Impact Analysis and Recommendation ReportViewing the Impact Analysis and Recommendation Report for details on the content of the report.

Note: The Impact Analysis and Recommendation Report report is not currently available for VM Scale Sets with maximum size >1.

Example: Downloading an Impact Analysis and Recommendation Report

approvalType

string

F

The approval setting for the system recommendation.

The value in this string is derived from the Self-Optimizing Automation policies in implementationMethod and the approval attribute attr_ApprovalSetting.

Possible settings include:

• "na"— not approved;
• "all"—approve any change;
• "<recommended-instance-type>"—approve changing the instance to the specified <recommended-instance-type>.

densifyPolicy

string

F

The Densify policy used for optimization analysis.

savingsEstimate

string

This calculation also applies to scale groups with maximum group size = 1. In this case, the scale group is considered as a VM, with no running instance elements exposed. For scale groups with maximum group size greater than 1, the savings estimate is the difference between the current and recommended instance type cost (i.e. catalog cost), with the average group in-service instances taken into consideration (i.e. [avgInstanceCountCurrent * currentCost] - [avgInstanceCountRecommended* recommendedCost]).

effortEstimate

string

F

[Moderate|Low|Very Low|None|Impossible]

This element describes the effort required to investigate and implement the Densify recommendations. Effort for each system is calculated by rule-driven analytics based on factors (such as instance family change, storage change, data quality checks, feature changes, etc.) that can be configured in the policy settings and rule sets which capture best practices.

"Impossible" effort is a result of a manual override for the instance.

If a system is not ‘Not Analyzed’, Densify does not return an effortEstimate.

Note: When using the Subscription API, Densify returns an effortEstimate of "impossible" for systems that are ‘Not Analyzed’.

powerState

string

F

The power state of Azure VMs. The power state is not available for VM Scale Set.

Power state is not shown in the UI. .

recommendedHostEntityId

string

F

The Densify entity ID of the catalog instance for the recommended instance type.

currentCost

string

The cost of the existing instance type (i.e. the instance catalog cost).

recommendedCost

string

The cost of the recommended instance type (i.e. the instance catalog cost) after Densify optimization analysis.

serviceType

string

F

The Azure cloud service type. Possible settings include:

• Virtual Machine
• VM Scale Set

Scale groups with maximum group size of 1 (i.e. maxGroupCurrent=1) have serviceType=VM Scale Set. All other returned elements are similar to those for a virtual machine service (i.e. min/max group size values are not returned).

currentHourlyRate

string

The hourly rate for the current instance type (i.e. instance catalog cost / monthly hours). This value is rounded to the nearest penny.

recommendedHourlyRate

string

The hourly rate for the recommended instance type (i.e. instance catalog cost / monthly hours). This value is rounded to the nearest penny.

attributes

array of:

• id
• name
• value

System attributes are properties set during the data collection process by a vendor platform (i.e. Azure) or by Densify for analytics.

Note: The attribute array is only returned when includeAttributes=true is added to the query string.

provisioningId

string

This element is used to identify the terraform-map recommendations for a unique system and corresponds to the "Provisioning Id" Azure user-defined resource tag value. The "Provisioning Id" resource tag is used to uniquely identify a system, since its resourceId or system name could possibly change after an instance type update.

See Example: Returning Azure Recommendations with Low Effort in Terraform-map Format

If the "Provisioning Id" user-defined resource tag value is not set, then the system name is used to identify the recommendations.

recommFirstSeen

Unix time

(in milliseconds)

The first date and time the recommended instance type (i.e. the recommendedType element) was provided by Densify (Unix Epoch time, in milliseconds).

recommLastSeen

Unix time

(in milliseconds)

The latest date and time the recommended instance type (i.e. the recommendedType element) was provided by Densify (Unix Epoch time, in milliseconds).

recommSeenCount

integer

The number of times Densify suggested the recommended instance type (i.e. the recommendedType element). This is the count of Densify analysis processes which produced the same recommended instance type from recommFirstSeen to recommLastSeen. This value is updated when the RDB populate task (i.e. the reporting database update process) is executed. The RDB populate task compares the current recommendedType with the new recommendedType to update the recommSeenCount counter.

Note: In typical production environments, where the RDB populate task is scheduled to run once daily post data collection and analysis, the recommSeenCount value will reflect exactly the number of times the recommended instance type was provided. If your environment executes the RDB populate task more than once daily, the recommSeenCount value will be inflated beyond the actual number of times the instance type was recommended. Contact [email protected] if you have concerns about the recommSeenCount value.

auditInfo

• dataCollection:
• dateFirstAudited
• dateLastAudited
• auditCount
• workloadDataLast30:
• firstDate
• lastDate
• totalDays
• seenDays

The following system data collection details are returned:

• dateFirstAudited—the first time data was collected for this system (Unix epoch time, in milliseconds);
• dateLastAudited—the most recent data collection time (Unix epoch time, in milliseconds);
• auditCount—the number of times that data was collected.

The following system workload collection details, for the last 30 days, are returned:

• firstDate—the first time workload data was collected for this system (Unix epoch time, in milliseconds);
• lastDate—the most recent workload data collection time for this system (Unix epoch time, in milliseconds);
• totalDays—the difference in days between firstDate and lastDate;
• seenDays—the number of days that at least one workload data was added into Densify for this system.

Note: If no workload data is collected for the system in the last 30 days, then the workloadDataLast30 element block is not returned.

Note: The values in auditInfo are updated once a day, after the data collection and RDB populate processes are complete (i.e. the reporting tables have been updated with latest data collected).

dataQuality

array of:

• workloadName
• firstSeen
• lastSeen
• completeDays
• partialDays

The dataQuality array provides workload type data collection details for the system:

• workloadName—the workload type name (see DCE Virtual Environment Workload Viewer to find a list of the supported workload types from the Analysis Console);
• firstSeen—the first time this workload was collected (Unix Epoch time, in milliseconds);
• lastSeen—the most recent time this workload was collected (Unix Epoch time, in milliseconds);
• completeDays—the number of complete days that this workload data was collected;
• partialDays—the number of partial days that this workload data was collected.

Note: The dataQuality array is only returned when the dataQuality query string is specified in the request. In addition, if you specify a workload type in the request, for which system workload data does not exist in Densify, then no data is returned.

Note: The values in the dataQuality array are updated after data collection and subsequent updates to the reporting tables (i.e. RDB Populate process) are completed.

Scale Group Details

The following details are returned for scale groups with maximum size > 1. Scale groups with maximum size = 1 are treated as VMs.

orchestrationMode

string

The orchestration mode applied to this VM Scale Set. The orchestration mode can:

• Uniform
• Flexible

Only Uniform scale sets, or Flexible scale sets running identical instance types are analyzed. See Mixed Mode Services for details.

autoScaling

string

The scaling mode applied to this VM Scale Set can be one of:

• Manual
• Autoscale

If set to Flexible, the scale set must be running the same instance types.

profiles

integer

The number of profiles associated with the selected VM Scale Set. Profiles are only applicable to scale sets with scaling mode=Autoscale.

minGroupCurrent

integer

Specifies the current minimum group size of a scaling group.

minGroupRecommended

integer

Specifies the recommended minimum group size for a scaling group.

maxGroupCurrent

integer

Specifies the current maximum group size of a scale group.

maxGroupRecommended

integer

Specifies the recommended maximum group size for a scale group.

avgInstanceCountCurrent

float

The average of in-service instances over the historical interval (or workload range). This interval is defined by your policy (e.g. over the last 60 days).

avgInstanceCountRecommended

float

The predicted average instance count if the scale group recommendations are implemented.

scalingPolicies

string

This value indicates whether the scaling mode needs to be reviewed. Possible values depend on whether or not the VM Scale Set is managed by AKS:

• VM Scale Set is managed by an AKS cluster:
• No Value- If the optimization type = Terminate, then:
• In the UI, a dash, "—" is displayed.
• In the API,"Terminate" is returned in the /results.
• Keep—If the current average group size is the same as the recommended average group size. The optimization type =Just Right.
• Review—If Densify recommends changing one or more of instance type, average, minimum or maximum group size.
• VM Scale Set is NOT managed by an AKS cluster:
• No Value- If the optimization type = Terminate, then:
• In the UI, a dash, "—" is displayed.
• In the API,"Terminate" is returned in the /results.
• Keep—If the current average group size, minimum and maximum group size are not changed. The optimization type =Just Right.
• Review—If Densify recommends changing one or more of instance type, average, minimum or maximum group.
• Enable Autoscale—If Densify recommends changing one or more of instance type, average, minimum or maximum group size and the VM Scale Set is not managed by AKS.
• Adjust —If the current average group size is not the same as the predicted average group size AND instance type and minimum and maximum group size do not change AND the VM Scale Set is not managed by AKS.

This element is only returned for scale groups with maximum group size greater than one.