Skip to content

RS: Add fields and descriptions returned by /v1/actions to REST API reference #1257

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Mar 26, 2025
Merged

RS: Add fields and descriptions returned by /v1/actions to REST API reference #1257

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
da8f5ce
DOC-4920 RS: Add fields and descriptions returned by /v1/actions to R…
rrelledge Mar 5, 2025
6239317
DOC-4920 Added more details about pending_ops structure and fields
rrelledge Mar 20, 2025
db4575f
Added missing commas to JSON example
rrelledge Mar 20, 2025
6ad73c3
DOC-4920 Fixed pending_ops heartbeat and last_sample_time description…
rrelledge Mar 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 25 additions & 3 deletions content/operate/rs/references/rest-api/requests/actions/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ weight: $weight
GET /v1/actions
```

Get the status of all actions (executing, queued, or completed) on all entities (clusters, nodes, and databases). This API tracks long-lived API requests that return either a `task_id` or an `action_uid`.
Get the status of all running, pending, or completed actions on all clusters, nodes, and databases. This API tracks long-lived API requests that return either a `task_id` or an `action_uid`.

#### Required permissions

Expand All @@ -41,7 +41,18 @@ GET /actions

### Response {#get-all-response}

Returns a JSON array of [action objects]({{< relref "/operate/rs/references/rest-api/objects/action" >}}) and an array of [state-machine objects]({{< relref "/operate/rs/references/rest-api/objects/state-machine" >}}).
Returns a JSON array of [action objects]({{< relref "/operate/rs/references/rest-api/objects/action" >}}), which represent tasks, and an array of [state-machine objects]({{< relref "/operate/rs/references/rest-api/objects/state-machine" >}}).

| Field | Type/Value | Description |
|-------|------------|-------------|
| action_uid | string | The action's globally unique identifier |
| name | string | Name of the running or failed state machine |
| progress | float (range: 0-100) | Percent of completed steps for the action |
| status | "pending"<br />"active"<br />"completed"<br />"failed" | The action's status |
| node_uid | string | UID of the node where the operation runs (optional) |
| object_name | string | The object that the action runs on (optional) |
| state | string | The current state of the state machine (optional) |
| pending_ops | JSON object | List of operations that are waiting to run (optional) |
Copy link

@aweyl aweyl Mar 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rrelledge Could you please get more details from Nikolay about the fields that are included in pending ops and about it's strcuture

Copy link
Collaborator Author

@rrelledge rrelledge Mar 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I will ask.


Regardless of an action’s source, each action in the response contains the following attributes: `name`, `action_uid`, `status`, and `progress`.

Expand Down Expand Up @@ -93,7 +104,7 @@ Regardless of an action’s source, each action in the response contains the fol
GET /v1/actions/{uid}
```

Get the status of a currently executing, queued, or completed action.
Get the status of a specific action.

#### Required permissions

Expand All @@ -119,6 +130,17 @@ GET /actions/{uid}

Returns an [action object]({{< relref "/operate/rs/references/rest-api/objects/action" >}}).

| Field | Type/Value | Description |
|-------|------------|-------------|
| action_uid | string | The action's globally unique identifier |
| name | string | Name of the running or failed state machine |
| progress | float (range: 0-100) | Percent of completed steps for the action |
| status | "pending"<br />"active"<br />"completed"<br />"failed" | The action's status |
| node_uid | string | UID of the node where the operation runs (optional) |
| object_name | string | The object that the action runs on (optional) |
| state | string | The current state of the state machine (optional) |
| pending_ops | JSON object | List of operations that are waiting to run (optional) |

Regardless of an action’s source, each action contains the following attributes: `name`, `action_uid`, `status`, and `progress`.

#### Example JSON body
Expand Down