Error Return
Last Updated:2020-07-20
When an error occurs when the user accesses API, the corresponding error code and error message will be returned to the user to facilitate localization and make appropriate processing. The detailed error information is returned through Response Body in case of a request error, and the following format is followed:
Parameter name | Type | Description |
---|---|---|
code | String | It means a specific error type. |
message | String | Detailed description on the error. |
requestId | String | RequestId causing the error. |
Example:
{
"requestId": "3ffd9f45-6908-452d-9f4f-5fb1f5f5d8d6",
"code": "INVALID_PARAMETER_VALUE",
"message": "Metric data required."
}
BCM Service Error Code
Error code | Error message | HTTP status code | Description |
---|---|---|---|
AUTHORIZATION_ERROR | invalid user credential information | 403 | Verification information failure |
INVALID_PARAMETER | Required statistics[]parameter String[]is not present | 400 | Parameter error, lack of statistics[]parameter |
INVALID_PARAMETER | Required periodInSecond parameter int is not present | 400 | Parameter error, lack of periodInSecond parameter |
INVALID_PARAMETER_VALUE | Period in second must be positive. | 400 | Parameter value error, periodInSecond must be positive. |
INVALID_PARAMETER_VALUE | Start time is later than 2 hours after current time or earlier than 40 days ago. | 400 | Parameter value error, the start time is 2 hours later or 40 days earlier than the current time. |
INTERNAL_ERROR | We encountered an internal error. Please try again. | 500 | All other undefined errors |