The following describes the error object that is returned together with an HTTP status code if an error occurs during the processing of a request.
The following table explains the schema of an error object.
|
Attribute |
Data type |
Description |
|---|---|---|
|
errorSource |
string |
URL where the error occurs |
|
messageId |
string |
Message ID |
|
message |
string |
Content of the error message |
|
cause |
string |
Cause of the error |
|
solution |
string |
Solution to the error |
|
errorCode |
string |
Error code from the storage system A value is returned only if an error occurs in the storage system. The error codes are as follows:
Storage system error codes are required for maintenance of the storage system. |
The following is an example of an error object when an error occurs in a storage system:
{
"errorSource": "/ConfigurationManager/simple/v1/objects/volumes/100/actions/expand/invoke",
"messageId": "KART70000-E",
"message": "The specified volume is being used by another program product, or format in progress. Operation could not be completed. Wait for a while and try again. Confirm the volume is not in use by other program product.",
"errorCode": {
"SSB1": "B96B",
"SSB2": "AF2E"
}
}
The following table shows the schema of an error object when some information is obtained even though an error has occurred, or when only a part of the operation is complete.
|
Attribute |
Data type |
Description |
|---|---|---|
|
errorResponses |
object[] |
Detailed information about the error object
|
|
partialSuccessResponses |
object[] |
An error occurred, but the result is returned if the information is partially obtained or if the processing is partially successful. If all of the processing fails, an empty array might be returned. |
The following is an example of when an error occurs in a storage system but the processing is partially successful:
{
"errorResponses": [
{
"errorSource": "/ConfigurationManager/simple/v1/objects/snapshots",
"messageId": "KART70000-E",
"message": "The specified volume does not exist. Check the parameter and try again. If this problem occurs repeatedly, contact customer support.",
"errorCode": {
"SSB1": "2E20",
"SSB2": "0000"
}
}
],
"partialSuccessResponses": [
{
"statusResource": "/ConfigurationManager/simple/v1/objects/command-status/3"
}
]
}