FlexQuery Service Update: Standardized Error Codes and Request ID Formatting
search cancel

FlexQuery Service Update: Standardized Error Codes and Request ID Formatting

book

Article ID: 449368

calendar_today

Updated On:

Products

CloudHealth

Issue/Introduction

To improve message clarity for our users and help engineering and support teams investigate logs more efficiently, our internal team will be updating the FlexQuery error format.
Every user-facing error message will now include a standardized ErrorCode prefix along with a unique RequestId appended at the end.

For e.g:

  • Previous Format:"Dataset AWS_CRR (For specified Granularity, if any) is not available."
  • New Format:"FQ-USR-304: Dataset AWS_CRR (For specified Granularity, if any) is not available. RequestId: 20213b41-d5e1-468f-9fbc-ccb22ec26a46"

Resolution

Below is the full set of new FlexQuery error codes.

("FQ-DS-101", "Unable to access the dataset due to a permissions issue. Please contact Support")

("FQ-DS-102", "Dataset table not found. The dataset may have been removed or renamed")

("FQ-DS-104", "Query engine encountered an internal error")

("FQ-DS-105", "Dataset is not available. Please contact Support")

("FQ-DS-106", "You have requested a report for which we have no generated analysis data")

 

("FQ-QE-201", "Query engine encountered an internal error. Please retry")

("FQ-QE-202", "Query execution timed out. Please submit the query again")

("FQ-QE-203", "Query exceeded resources. Simplify it by reducing joins, columns, WITH clauses, or time range")

("FQ-QE-204", "Query engine is not available")

("FQ-QE-205", "Query is too complex. Query must be simplified. Reduce joins, columns, or time range")

("FQ-QE-206", "Query was cancelled")

("FQ-QE-207", "Query results have expired. Please submit the query again")

("FQ-QE-208", "Query unsupported/validation error")

("FQ-QE-209", "Invalid request exception")

 

("FQ-USR-301", "The SQL query is invalid")

("FQ-USR-302", "Query contains ambiguous columns. Please use Alias on the dataset and reference the alias on columns used from datasets in the Query. Example: Select <<Alias>>.<<ColumnName1>>, <<Alias>>.<<>ColumnName2>> from <<Dataset>> as <<Alias>>")

("FQ-USR-303", "Invalid request provided")

("FQ-USR-304", "Unable to parse the SQL query")

("FQ-USR-305", "A resource with this name already exists")

("FQ-USR-306", "The requested resource does not exist")

("FQ-USR-307", "Queried Page is invalid")

("FQ-USR-308", "Query Result has been already communicated/fetched")

 

("FQ-AUTH-401", "You are not authorized to perform this action")

 

("FQ-SVC-501", "An internal service error occurred")

("FQ-SVC-502", "Error retrieving cached results")

 

("FQ-RL-601", "Too many requests. Please wait and retry")

("FQ-RL-602", "We are currently experiencing high system load. Please retry after some time")

 Note: The error messages will be more nuanced in case of specific errors with these error codes.

Example:

  • With FQ-USR-301 error code the error message can be "Selected columns cannot be empty to form SQL Query"

  • With FQ-USR-304 error code the error message can be "Unsupported Time Range, Maximum allowed for MONTHLY Granularity is 13 Months" OR "SQL Function <> is not Supported"

If you encounter any issues or need further assistance, please feel free to open a support ticket with us at at Support@Broadcom