
This is an archive version of the document. To get the most up-to-date information, see the
current version.
Asynchronous Operations
You can get data on asynchronous operations with the specified ID.
Request
To retrieve information on a specific operation, send the HTTP GET request to the /operations/{operationId} endpoint. {operationId} is a system ID assigned to the operation in the Veeam Backup for Microsoft Azure REST API.
Note |
If a specific request takes too long to process, Veeam Backup for Microsoft Azure v3 returns the {operationId} with 202 Code. |
HTTP Request
GET https://<hostname>/api/v3/operations/{operationId} |
Request Headers
The request contains the following headers.
Header | Required | Value | Description |
---|
Authorization | Required | Bearer <Access-Token> | Authenticates a client who sends the request to the server. Must contain the access token for the current logon session in the Bearer <Access-Token> format. |
Response
The server returns the following response to the client.
Response Codes
A successfully completed operation returns a response code 200 (OK).
Response Headers
The response to this request contains the following headers. The response may also include additional standard HTTP headers.
Header | Value | Description |
---|
Content-length | integer | Identifies the length of the response body message, in bytes. |
Content-type | - application/json
- application/problem+json
| Identifies the media type of the response body message. |
Response Body
In the response body, Veeam Backup for Microsoft Azure returns the following:
ObjectAsyncOperationV2
Property | Type | Description |
---|
result | object | Result of an operation performed by Veeam Backup for Microsoft Azure. | id | string($uuid) | System ID assigned to an operation. | startTime | string($date-time) | Date and time when the operation started. | status | string | Status of the operation: Canceled, Canceling, Error, NeverExecuted, Pending, Running, RunningWithError, RunningWithWarning, Success, Warning. | error | ProblemDetails | [Applies if the session completes with an error] Information on the error. | _links | array | A list of methods and operations available for the specified operation in the Veeam Backup for Microsoft Azure REST API, and request URLs used to perform the operations. |
|
ProblemDetails
Property | Type | Description |
---|
type | string | Type of an error. | title | string | Error message. | status | integer($int32) | Error status code. | detail | string | Details of the error. | instance | string | System ID of an instance assigned in Veeam Backup for Microsoft Azure REST API where the error occurred. |
|
Example
The following request returns information on a session with the ID 2fa30a54-90f9-4b3e-8437-499e32eb8b5b. Request: GET https://51.11.247.127/api/v3/sessions/2fa30a54-90f9-4b3e-8437-499e32eb8b5b Request Header: Authorization: Bearer <Access-Token> Response: 200 Response Body: { "result": { "offset": 0, "limit": 200, "totalCount": 1, "results": [ { "tenantId": "3e924ba9-93bc-40d5-8a47-33f07b239a52", "name": "Veeam Software Group GmbH" } ], "_links": { "self": { "href": "https://51.11.247.127/api/v3/cloudInfrastructure/tenants?offset=0&limit=200" } } }, "id": "2fa30a54-90f9-4b3e-8437-499e32eb8b5b", "startTime": "2020-12-01T21:31:58.4323732Z", "status": "Success", "_links": { "self": { "href": "https://51.11.247.127/api/v3/operations/2fa30a54-90f9-4b3e-8437-499e32eb8b5b" } } } |
|