This is an archive version of the document. To get the most up-to-date information, see the current version.Exporting Instances List
This section explains how to export a list with instances used as workers.
Request
GET https://<hostname>/api/v1/workers/export |
Request Headers
The request header must contain an authorization token of the current session.
Request Parameters
None.
Request Body
None.
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 HTTPS headers.
Header | Description |
Content-length | The length of the response body. |
Content-type | The media type and syntax of the response body message: application/json; charset=utf-8 |
Response Body
Property | Type | Description |
|---|---|---|
resourceId | string | The identification number of the worker. |
name | string | The name of the worker. |
host | string | The IP address of the host server. |
network | string | The name of the network to which the worker belongs. |
subnetName | string | The name of the subnet. |
instanceType | string | The type of the VM that acts as a worker. |
status | string | The VM status. |
region | string | The region to which the worker belongs. |
Example
Request: GET https://abc.ukwest.cloudapp.azure.com/api/v1/workers/export
Request Header: Authorization: Bearer <Access-Token>
Response: 200 OK
Response Body: [ { "resourceId": "/subscriptions/3a9a8330-7bbc-4b03-9c68-15d674fbc809/resourcegroups/jenkins-abc/providers/microsoft.compute/virtualmachines/vba-27140802-e407-4811-ae2e-2c66fc353df0", "name": "VBA-27140802-e407-4811-ae2e-2c66fc353df0", "host": "10.92.0.4", "network": "vba_vnet-eastus-0", "subnetName": "veeambackup", "instanceType": "Standard_A2", "status": "Stopped", "region": "East US" }, { "resourceId": "/subscriptions/3a9a8330-7bbc-4b03-9c68-15d674fbc809/resourcegroups/jenkins-abc/providers/microsoft.compute/virtualmachines/vba-5d5c94e7-99b2-4c1d-8c48-848e49839979", "name": "VBA-5d5c94e7-99b2-4c1d-8c48-848e49839979", "host": "10.4.15.5", "network": "abc-network", "subnetName": "abc-Subnet", "instanceType": "Standard_A2", "status": "Stopped", "region": "UK West" } ] |