Review scheduled jobs and their runs
See the schedules that act on your tenant's keys, such as automatic rotation, and every time each one ran: when it was planned, how many attempts it took, its result and when it completed.
Who can do it
Every built-in tenant role. The console shows a key's Rotation schedule tab only to a person who holds the permission to read the tenant's schedules. Reading schedules changes nothing.
Before you start
- A schedule exists only for a key whose automatic rotation is enabled. Enabling it is part of the key's rotation settings, not of this task.
Steps
- Open Key Inventory and select the key to open its detail.
- Select the Rotation schedule tab. It shows the key's schedule, its status and when it was created and last changed. The active schedule is shown by default, otherwise the most recent one.
- When the key has more than one schedule, select Show executions on the schedule whose runs you want.
- Read Executions, 20 per page: each run's state, what started it (its due time or an operator), the time it was planned for, its attempts, result, reason and completion time. Move between pages with Previous and Next.
What you see when it worked
Each run carries a state such as Scheduled, Running, Waiting to retry, Succeeded, Failed or Replaced by a newer execution. A schedule that has not run yet reads This schedule has not run yet. A key without automatic rotation reads Automatic rotation is not enabled for this key, with a shortcut to the key's automatic rotation settings.
If it fails
| What you see | Cause | What to do |
|---|---|---|
| Scheduling is unavailable | The scheduling service could not be reached or did not answer in time | Retry; if it persists, your platform operator checks the scheduling service |
| This schedule cannot be read with your access. | You lack the permission to read schedules, or the schedule is not your tenant's | Ask a tenant administrator for the permission |
| No Rotation schedule tab on the key | You lack the permission to read schedules | Ask a tenant administrator for it |
Without the console
| Surface | How |
|---|---|
| API | GET /api/v3/admin/tenants/{tenantId}/schedules (operation listTenantSchedules), optionally filtered by status and by resourceId (for a key, its identifier), paged with page and size; then GET /api/v3/admin/tenants/{tenantId}/schedules/{scheduleId}/executions (operation listTenantScheduleExecutions) |
Related
- Key Inventory: what the screen shows, including a key's rotation schedule.