If an error occurs in a request, both an Error object defined by the schema in the following table and a status code are returned. However, note that for API that return Job objects, the Job object might be returned depending on where the error occurred.
|
Variable name |
Type |
Description |
|---|---|---|
|
errorSource |
string |
The URI sent by the API client |
|
message |
string |
The error message (same message that is logged) |
|
messageID |
string |
The message ID (same ID that is logged) |
|
actions |
string array |
Actions that the API client must take |
The following shows an example of the Error object.
{"errorSource": "http://localhost:22015/Analytics/RAIDAgent/v1/objects/RAID_PD_LDC?hostName=HOST1&agentInstanceName=instance1",
"message": "The specified agent does not exist. (agent type = RAID, instance name = instance1, host name = HOST1)",
"messageID": "KNAQ35000-E",
"actions":["Check whether the agent information for the specified agent exists."]}