Listing backup plans

GET /v2/{project_id}/jobs

List backup plans.

Source: https://docs.openstack.org/api-ref/backup/v2/index.html#lists-jobs-v2

Request

Parameters

Name	In	Type	Description
project_id	path	string	The UUID of the project.
limit (Optional)	query	integer	Requests a page size of items. Returns a number of items up to a limit value. Use the limit parameter to make an initial limited request and use the ID of the last-seen item from the response as the marker parameter value in a subsequent limited request.
offset (Optional)	query	string	The ID of the last-seen item. Use the limit parameter to make an initial limited request and use the ID of the last-seen item from the response as the marker parameter value in a subsequent limited request.
search (Optional)	body	dict	The query option of a list. It is a JSON structure. It contains the keywords match, match_not, or one of the two. The values about the keys match and match_not are a list of {key, value}.

Example

# curl -ks -H 'Content-Type: application/json' -H 'X-Auth-Token: gAAAAA<...>' \
https://<node_IP_addr>:8736/v2/3046fb2c2a314a0fbb32607caa1e5277/jobs

Response

Parameters

Name	In	Type	Description
jobs (Optional)	body	list	A list of jobs.

Status codes

Success

Code	Reason
200 - OK	Request was successful.

Error

Code	Reason
401 - Unauthorized	User must authenticate before making a request.
403 - Forbidden	Policy does not allow current user to do this operation.

Example

{
  "jobs": [
    {
      "created_at": "2024-05-09T09:51:10.785289",
      "updated_at": "2024-05-09T09:52:58.261715",
      "job_id": "e632eb1884e0468c8a41e656942df500",
      "project_id": "3046fb2c2a314a0fbb32607caa1e5277",
      "user_id": "d1899d7f32d64b1bb95e262e7a6a4bc2",
      "job_schedule": {
        "schedule_day_of_week": "0,1,2,3,4,5,6",
        "schedule_month": "1,2,3,4,5,6,7,8,9,10,11,12",
        "schedule_day": "1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31",
        "schedule_minute": "00",
        "schedule_hour": "13"
      },
      "client_id": "hci",
      "session_id": "",
      "session_tag": 0,
      "name": "myplan",
      "description": "My new plan",
      "job_actions": [
        {
          "freezer_action": {
            "action": "backup",
            "mode": "hci-volumes",
            "recovery_points_rotation": 7
          },
          "user_id": "d1899d7f32d64b1bb95e262e7a6a4bc2",
          "project_id": "3046fb2c2a314a0fbb32607caa1e5277",
          "action_id": "b9dc9e548b914b80a06d752342828371"
        }
      ],
      "status": "scheduled",
      "disabled": false,
      "started_at": null,
      "ended_at": null
    }
  ]
}