Showing backup plan details

GET /v2/{project_id}/jobs/{job_id}

Shows details for a backup plan.

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

Request

Parameters

Name	In	Type	Description
`project_id`	path	string	The UUID of the project.
`job_id`	path	string	The job UUID.

Example

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

Response

Parameters

Name	In	Type	Description
`job_id`	body	string	The job UUID.
`job_id_hash`	body	string	The job ID hash.
`user_id`	body	string	The user UUID.
`project_id`	body	string	The UUID of the project.
`name`	body	string	The name of the job.
`description`	body	string	The description of the job.
`client_id`	body	string	The client UUID.
`job_schedule`	body	dict	The schedule information of the job.
`job_actions`	body	list	A list of actions that carry out the backup/restore job.
`status`	body	string	The job status.
`disabled`	body	boolean	If set to `true`, the job is disabled. If set to `false`, the job is enabled.
`started_at`	body	string	The date and time when the job started. The date and time stamp format is ISO 8601: CCYY-MM-DDThh:mm:ss±hh:mm For example, `2015-08-27T09:49:58-05:00`. The `±hh:mm` value, if included, is the time zone as an offset from UTC. In this example, the offset value is `-05:00`.
`ended_at`	body	string	The date and time when the job ended. The date and time stamp format is ISO 8601: CCYY-MM-DDThh:mm:ss±hh:mm For example, `2015-08-27T09:49:58-05:00`. The `±hh:mm` value, if included, is the time zone as an offset from UTC. In this example, the offset value is `-05:00`.

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

{
  "created_at": "2024-05-09T09:51:10.785289",
  "updated_at": "2024-05-09T09:52:58.261715",
  "job_id": "e632eb1884e0468c8a41e656942df500",
  "job_id_hash": "d91e52f5117e95d8cf094071a7923289951a433c",
  "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
}