3.1.5.13 operationResults
The operationResults resource provides the status of a specific asynchronous operation. The URL for a specific operations resource is returned in the Location header of that operations.
Note: The system currently stores a history of one million operationResults. If the system reaches more than a million operationResults then the oldest ones will be removed from the Network Controller but are still located in the operational logs of the Network Controller.
It is invoked through the following URI.
-
https://<url>/networking/v1/operationResults/{resourceId}
url: The address or name of the REST server of the Network Controller.
resourceId: the identifier for the specific resource within the resource type. See section 2.2.3.4 for more details.
Note The server MAY support additional versions, v1 or later, in the URI.
The following HTTP methods can be performed on this resource.
|
HTTP method |
Section |
Description |
|---|---|---|
|
GET |
Get an operationResults resource. |
See Asynchronous Operations, section 1.3.2, for more details on its usage.
The following property elements are valid.
|
Element name |
Type |
Description |
|---|---|---|
|
Status |
Read-only |
This is the status of the operations. The following are valid values InProgress, Succeeded, Failed, or Canceled. |
|
error |
Read-only |
Indicates that the request was in error or could not be processed. This element contains the detailed explanation on what the error was and what caused it. It will only be returned when the status element is returned as Failed. |
|
error.code |
Read-only |
Indicates the string value of the error code associated with the error being returned. This will always be returned in case of an error response. |
|
error.message |
Read-only |
Indicates the error message provided to the caller. This is used in diagnosing what caused the error. This will always be returned in case of an error response. |
|
error.details |
Read-only |
Indicates the detailed information of the error. This is used for advanced diagnostics purposes. It is ideal for diagnostics if all these details are returned but they will not always be returned. It will not be in the error response content if it is not returned. |
|
error.details.code |
Read-only |
Indicates the detailed error code of the error response. It is ideal for diagnostics if this code is returned but it will not always be returned. It will not be in the error response content if it is not returned. |
|
error.details.target |
Read-only |
Indicates the target of the detailed error message in the error response. It is ideal for diagnostics if this code is returned but it will not always be returned. It will not be in the error response content if it is not returned. |
|
error.details.message |
Read-only |
Indicates the detailed message of the error response. It is ideal for diagnostics if this code is returned but it will not always be returned. It will not be in the error response content if it is not returned. |
|
error.details.innerError |
Read-only |
Provides the inner error details if any for the error. This can help with more detailed diagnostics of the error. |