Get Recommendation Session Status
Provides a lightweight way to poll the current progress and state of a recommendation session.
Notes:
- Use this endpoint instead of the full session GET when polling for completion.
- Returns the overall status, site-specific analysis states, status messages, and any alerts generated during analysis.
- Indicates if a rerun is recommended due to environment changes.
The id of the resource
The recommendation resource is present. Status may indicate further information.
{
"recommendation_overall_status": "READY_TO_PUBLISH",
"recommendation_analysis_states": [
{
"site_id": "9e0865d0-9d89-44c7-8cc0-9f96a9b35721",
"status_message": "",
"status": "SUCCESS"
}
],
"recommendation_result_states": [
{
"id": "9e0865d0-9d89-44c7-8cc0-9f96a9b35721",
"site_id": "9e0865d0-9d89-44c7-8cc0-9f96a9b35721",
"status": "READY_TO_PUBLISH"
}
],
"rerun_recommended": false,
"alerts": [],
"groups_with_alert": []
}The status of the recommendation, indicating the current state of the recommendation generation or publication process.
| Status | Description |
|---|---|
WAITING |
Initial state. |
ANALYSIS_IN_PROGRESS |
Analysis is running. |
READY_TO_PUBLISH |
Analysis complete. |
ANALYSIS_FAILED |
Analysis failed. |
PUBLISHED |
Successfully published to NSX. |
PUBLISH_INITIATED |
Publication started. |
PUBLISH_FAILED |
Publication failed. |
DISCOVERY_CANCELED |
User canceled. |
NOTHING_TO_PUBLISH |
No recommendations generated. |
Array of status values representing the current state of the recommendation analysis process. Can contain multiple status values if the analysis is being performed across multiple sites or stages.
Array of status values representing the current state of the recommendation result. Can contain multiple status values if the analysis is being performed across multiple sites or stages.
Used to communicate any information back to the user while or after processing. Examples of these are any errors/exceptions so far encountered during processing( which should be cleared if processing completes successfully). May be empty.
Boolean flag indicating whether the recommendation should be rerun. Set to true when continuous monitoring detects changes in effective members, configuration, or other factors that warrant regenerating the recommendation.
Alert reasons is set when recommendation has a alert for user. This does not inhibit the recommendation job.
During start/rerun of a recommendation, if some group(s) has alert like unsupported membership types, their respective id(s), path(s), display name(s) and unsupported membership type(s) will be stored and kept in this array.
Bad Request
{
"error_code": 0,
"module_name": "string",
"error_message": "string"
}HTTP Status or Application error code.
Module where the error happened.
Message describing the error.
Unauthorized
{
"error_code": 0,
"module_name": "string",
"error_message": "string"
}HTTP Status or Application error code.
Module where the error happened.
Message describing the error.
Forbidden
{
"error_code": 0,
"module_name": "string",
"error_message": "string"
}HTTP Status or Application error code.
Module where the error happened.
Message describing the error.
Precondition Failed
{
"error_code": 0,
"module_name": "string",
"error_message": "string"
}HTTP Status or Application error code.
Module where the error happened.
Message describing the error.
Precondition Required
{
"error_code": 0,
"module_name": "string",
"error_message": "string"
}HTTP Status or Application error code.
Module where the error happened.
Message describing the error.
Too Many Requests
{
"error_code": 0,
"module_name": "string",
"error_message": "string"
}HTTP Status or Application error code.
Module where the error happened.
Message describing the error.
Error
{
"error_code": 0,
"module_name": "string",
"error_message": "string"
}HTTP Status or Application error code.
Module where the error happened.
Message describing the error.
curl -H 'Authorization: <value>' https://{api_host}/intelligence/recommendations/{id}/status