analysisId

string

The unique referenced ID of the GCP 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.

Usage example:

../results?recommendationType=Upsize

includeAttributes

• true
• false

Indicate whether or not to return system attributes:

• true—returns all 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 GCP identifier assigned to the Compute Engine system .

accountIdRef

string

F

The GCP Project identifier.

currentType

string

F

The current instance type of the Compute Engine system.

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.

Systems with insufficient information for analysis do not have a recommendation and are returned with limited elements. See Example: Returning GCP 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.

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.

name

string

F

The GCP 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.

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

The value of savingestimate output parameter is the difference between the current and recommended instance type cost (this is the catalog cost). When using the API, the predicted uptime is NOT taken into consideration (i.e. [currentCost – recommendedCost]). The Impact Analysis and Recommendation Report report uses the predicted uptime % when calculating estimated savings regardless of whether the report is obtained through the UI or via API.

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 the system.

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 GCP service type:

• Compute Engine

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. GCP) 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" GCP user-defined label value. The "Provisioning Id" label is used to uniquely identify a system, since its resourceId or system name could possibly change after an instance type update.

See Example: Returning GCP Recommendations with Low Effort in Terraform-map Form.

If the "Provisioning Id" label 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.

See Example: Returning GCP Instances with Downsize Recommendations.