From 88d68e5548e5e098065308fe90e46dbe286b94d1 Mon Sep 17 00:00:00 2001 From: James Rasell Date: Thu, 4 Nov 2021 10:22:21 +0100 Subject: [PATCH] docs: update API alloc list same response to be current. --- website/content/api-docs/allocations.mdx | 191 +++++++++++++---------- 1 file changed, 105 insertions(+), 86 deletions(-) diff --git a/website/content/api-docs/allocations.mdx b/website/content/api-docs/allocations.mdx index ded05e406..e39eb7f4c 100644 --- a/website/content/api-docs/allocations.mdx +++ b/website/content/api-docs/allocations.mdx @@ -65,113 +65,132 @@ $ curl \ ```json [ { - "ID": "a8198d79-cfdb-6593-a999-1e9adabcba2e", - "EvalID": "5456bd7a-9fc0-c0dd-6131-cbee77f57577", - "Name": "example.cache[0]", - "NodeID": "fb2170a8-257d-3c64-b14d-bc06cc94e34c", - "PreviousAllocation": "516d2753-0513-cfc7-57ac-2d6fac18b9dc", - "NextAllocation": "cd13d9b9-4f97-7184-c88b-7b451981616b", - "RescheduleTracker": { - "Events": [ - { - "PrevAllocID": "516d2753-0513-cfc7-57ac-2d6fac18b9dc", - "PrevNodeID": "9230cd3b-3bda-9a3f-82f9-b2ea8dedb20e", - "RescheduleTime": 1517434161192946200, - "Delay": "5000000000" - } - ] - }, - "JobID": "example", - "TaskGroup": "cache", - "DesiredStatus": "run", - "DesiredDescription": "", + "ClientDescription": "Tasks are running", "ClientStatus": "running", - "ClientDescription": "", + "CreateIndex": 10, + "CreateTime": 1636017249798459000, + "DeploymentStatus": { + "Canary": false, + "Healthy": true, + "ModifyIndex": 15, + "Timestamp": "2021-11-04T10:14:22.054814+01:00" + }, + "DesiredDescription": "", + "DesiredStatus": "run", + "DesiredTransition": { + "ForceReschedule": null, + "Migrate": null, + "Reschedule": null + }, + "EvalID": "cb20d15d-861f-8d8d-8253-e93932beea2e", + "FollowupEvalID": "", + "ID": "5457f16d-0f87-8e6b-5e91-0c7da3a41eb7", + "JobID": "example", + "JobType": "service", + "JobVersion": 0, + "ModifyIndex": 15, + "ModifyTime": 1636017262190928000, + "Name": "example.cache[0]", + "Namespace": "default", + "NodeID": "f476d2b4-02dc-c216-d031-273396727347", + "NodeName": "linux", + "PreemptedAllocations": null, + "PreemptedByAllocation": "", + "RescheduleTracker": null, + "TaskGroup": "cache", "TaskStates": { "redis": { - "State": "running", - "FinishedAt": "0001-01-01T00:00:00Z", - "LastRestart": "0001-01-01T00:00:00Z", - "Restarts": 0, - "StartedAt": "2017-07-25T23:36:26.106431265Z", - "Failed": false, "Events": [ { + "Details": {}, + "DiskLimit": 0, + "DisplayMessage": "Task received by client", + "DownloadError": "", + "DriverError": "", + "DriverMessage": "", + "ExitCode": 0, + "FailedSibling": "", + "FailsTask": false, + "GenericSource": "", + "KillError": "", + "KillReason": "", + "KillTimeout": 0, + "Message": "", + "RestartReason": "", + "SetupError": "", + "Signal": 0, + "StartDelay": 0, + "TaskSignal": "", + "TaskSignalReason": "", + "Time": 1636017249803624000, "Type": "Received", - "Time": 1495747371795703800, - "FailsTask": false, - "RestartReason": "", - "SetupError": "", - "DriverError": "", - "ExitCode": 0, - "Signal": 0, - "Message": "", - "KillTimeout": 0, - "KillError": "", - "KillReason": "", - "StartDelay": 0, - "DownloadError": "", "ValidationError": "", - "DiskLimit": 0, - "FailedSibling": "", - "VaultError": "", - "TaskSignalReason": "", - "TaskSignal": "", - "DriverMessage": "" + "VaultError": "" }, { - "Type": "Driver", - "Time": 1495747371798867200, - "FailsTask": false, - "RestartReason": "", - "SetupError": "", + "Details": { + "message": "Building Task Directory" + }, + "DiskLimit": 0, + "DisplayMessage": "Building Task Directory", + "DownloadError": "", "DriverError": "", + "DriverMessage": "", "ExitCode": 0, - "Signal": 0, - "Message": "", - "KillTimeout": 0, + "FailedSibling": "", + "FailsTask": false, + "GenericSource": "", "KillError": "", "KillReason": "", + "KillTimeout": 0, + "Message": "Building Task Directory", + "RestartReason": "", + "SetupError": "", + "Signal": 0, "StartDelay": 0, - "DownloadError": "", - "ValidationError": "", - "DiskLimit": 0, - "FailedSibling": "", - "VaultError": "", - "TaskSignalReason": "", "TaskSignal": "", - "DriverMessage": "Downloading image redis:3.2" + "TaskSignalReason": "", + "Time": 1636017249805254000, + "Type": "Task Setup", + "ValidationError": "", + "VaultError": "" }, { + "Details": {}, + "DiskLimit": 0, + "DisplayMessage": "Task started by client", + "DownloadError": "", + "DriverError": "", + "DriverMessage": "", + "ExitCode": 0, + "FailedSibling": "", + "FailsTask": false, + "GenericSource": "", + "KillError": "", + "KillReason": "", + "KillTimeout": 0, + "Message": "", + "RestartReason": "", + "SetupError": "", + "Signal": 0, + "StartDelay": 0, + "TaskSignal": "", + "TaskSignalReason": "", + "Time": 1636017252049956000, "Type": "Started", - "Time": 1495747379525667800, - "FailsTask": false, - "RestartReason": "", - "SetupError": "", - "DriverError": "", - "ExitCode": 0, - "Signal": 0, - "Message": "", - "KillTimeout": 0, - "KillError": "", - "KillReason": "", - "StartDelay": 0, - "DownloadError": "", "ValidationError": "", - "DiskLimit": 0, - "FailedSibling": "", - "VaultError": "", - "TaskSignalReason": "", - "TaskSignal": "", - "DriverMessage": "" + "VaultError": "" } - ] + ], + "Failed": false, + "FinishedAt": null, + "LastRestart": null, + "Restarts": 0, + "StartedAt": "2021-11-04T09:14:12.04996Z", + "State": "running", + "TaskHandle": null } - }, - "CreateIndex": 54, - "ModifyIndex": 57, - "CreateTime": 1495747371794276400, - "ModifyTime": 1495747371794276400 + } } ] ```