Advisor

This section describes a set of API requests that allow retrieve recommendations from cloud accounts. A recommendation is a piece of advise a cloud provider provides for the resources deployed in their cloud accounts, that will be beneficial to follow in order to comply with the cloud provider's best practices. It offers advice on important matters such as security, performance, cost savings and many more.

Contents

Recommendations

Show recommendation summary

GET /v3/advisor/recommendation_summaries

It shows the summary with the amount of recommendations for the customer making the call.

Inputs

None

Returns

A customer recommendation summary with the following fields:

Field Type Description
id String Identifier of the customer.
resource_recommendations Array of recommendation summaries An array of recommendation summaries. A recommendation summary is a dictionary of categories, each one containing the number of recommendations grouped by impact, and the total number of recommendations for that category.

Back to top

List cloud account recommendation statuses

GET /v3/advisor/cloud_account_recommendation_refresh_statuses

It lists the cloud account refresh statuses for cloud accounts belonging to the customer making the call.

Inputs

None

Returns

An array of cloud account refresh statuses, each with the following fields:

Field Type Description
id String Identifier of the cloud account.
last_refreshed_at String Timestamp of the last time the cloud account refreshed its recommendations.
error String A description of the error, if there was any.
supported Boolean A boolean indicating whether the cloud account supports recommendations (true) or not (false).
resource_recommendations Array of recommendation summaries An array of recommendation summaries. A recommendation summary is a dictionary of categories, each one containing the number of recommendations grouped by impact, and the total number of recommendations for that category.

Back to top

List cloud account recommendations

GET /v3/advisor/cloud_accounts/:id/recommendations

It lists the recommendations for the cloud account specified. The cloud account must belong to the customer making the call.

Inputs

None

Returns

An array of recommendations, each with the following field:

Field Type Description
id String Identifier of the recommendation.
short_description String A short description of the recommendation.
long_description String A complete description of the recommendation and the implications it has.
category String The category of the recommendation.
impact String A severity of the issue causing this recommendation. Can be either High, Medium or Low.
resources Array of resource recommendations An array of resource recommendations, each one conformed by a remote_id with the ID of the resource on the cloud, an action, describing the steps to correct it, and optionally an ID that corresponds to the ID of an IMCO resource (like servers and such) and a resource_type with the type of the resource (like Server, etc).

Back to top

List cloud account recommendation statuses

GET /v3/advisor/cloud_account_recommendation_refresh_statuses

It lists the cloud account refresh statuses for cloud accounts belonging to the customer making the call.

Inputs

None

Returns

An array of cloud account refresh statuses, each with the following fields:

Field Type Description
id String Identifier of the cloud account.
last_refreshed_at String Timestamp of the last time the cloud account refresh status was refreshed.
error String A description of the error, if there was any.
supported Boolean A boolean indicating whether the cloud account supports recommendations (true) or not (false).
resource_recommendations Array of recommendation summaries An array of recommendation summaries. A recommendation summary is a dictionary of categories, each one containing the number of recommendations grouped by impact, and the total number of recommendations for that category.

Back to top

Show cloud account recommendation

GET /v3/advisor/recommendations/:id

It shows the recommendation with the identifier specified. The recommendation must belong to a cloud account belonging to the customer making the call.

Inputs

None

Returns

A recommendation with the following fields:

Field Type Description
id String Identifier of the recommendation.
short_description String A short description of the recommendation.
long_description String A complete description of the recommendation and the implications it has.
category String The category of the recommendation.
impact String A severity of the issue causing this recommendation. Can be either High, Medium or Low.
resources Array of resource recommendations An array of resource recommendations, each one conformed by a remote_id with the ID of the resource on the cloud, an action, describing the steps to correct it, and optionally an ID that corresponds to the ID of an IMCO resource (like servers and such) and a resource_type with the type of the resource (like Server, etc).

Back to top