Fetching resources using search

Note

For more information on the search syntax and available attributes, see https://www.acronis.com/en-us/support/documentation/CyberProtectionService/index.html#operators-dynamic-groups.html.

1. Authenticate to the cloud platform via the Python shell.

   The following variables should be available now:

   >>> base_url  # the base URL of the API
   'https://eu2-cloud.acronis.com/api'
   >>> auth  # the 'Authorization' header value with the access token
   {'Authorization': 'Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImtpZCI6ImMwMD...'}
   

2. Assuming that you have a customer tenant UUID, store it in a variable:

   >>> customer_tenant_id = '<customer tenant ID>'
   

3. Define a variable named filters, and then assign a search parameter that queries all workloads of the machine under the to this variable:

   >>> filters = specified customer tenant
   ...
   {
       "search": f"customerUuid = '{customer_tenant_id}' AND resourceType = 'machine'"
   }
   

4. Send a GET request to the /resource_management/v4/resources endpoint:

   >>> response = requests.get(f'{base_url}/resource_management/v4/resources', headers=auth, params=filters)
   

5. Check the status code of the response:

   >>> response.status_code
   200
   

   Status code 200 means that the request was successful.

   Note

   A different status code means that an error has occurred. For details of the error, see HTTP status response codes and API error codes.

   Also, the response body contains an object with the items key, containing an array of resource objects formatted as a JSON text. When converted to an object, it will look like this:

   >>> pprint.pprint(response.json())
   {'items': [{'created_at': '2021-02-03T14:57:07.293995787Z',
               'external_id': '23effcf6-2798-4631-9a52-5785bf3af657@17',
               'id': '23effcf6-2798-4631-9a52-5785bf3af657',
               'name': 'DESKTOP-JRPTA4A',
               'tenant_id': '17',
               'type': 'resource.machine',
               'updated_at': '2021-02-03T18:13:48.312293448Z',
               'user_defined_name': 'DESKTOP-JRPTA4A'}],
   'paging': {'cursors': {'total': 1}}}