Skip to content

Commit da8f5ce

Browse files
committed
DOC-4920 RS: Add fields and descriptions returned by /v1/actions to REST API reference
1 parent 804012f commit da8f5ce

File tree

1 file changed

+25
-3
lines changed
  • content/operate/rs/references/rest-api/requests/actions

1 file changed

+25
-3
lines changed

content/operate/rs/references/rest-api/requests/actions/_index.md

Lines changed: 25 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ weight: $weight
2323
GET /v1/actions
2424
```
2525

26-
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`.
26+
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`.
2727

2828
#### Required permissions
2929

@@ -41,7 +41,18 @@ GET /actions
4141

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

44-
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" >}}).
44+
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" >}}).
45+
46+
| Field | Type/Value | Description |
47+
|-------|------------|-------------|
48+
| action_uid | string | The action's globally unique identifier |
49+
| name | string | Name of the running or failed state machine |
50+
| progress | float (range: 0-100) | Percent of completed steps for the action |
51+
| status | "pending"<br />"active"<br />"completed"<br />"failed" | The action's status |
52+
| node_uid | string | UID of the node where the operation runs (optional) |
53+
| object_name | string | The object that the action runs on (optional) |
54+
| state | string | The current state of the state machine (optional) |
55+
| pending_ops | JSON object | List of operations that are waiting to run (optional) |
4556

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

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

96-
Get the status of a currently executing, queued, or completed action.
107+
Get the status of a specific action.
97108

98109
#### Required permissions
99110

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

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

133+
| Field | Type/Value | Description |
134+
|-------|------------|-------------|
135+
| action_uid | string | The action's globally unique identifier |
136+
| name | string | Name of the running or failed state machine |
137+
| progress | float (range: 0-100) | Percent of completed steps for the action |
138+
| status | "pending"<br />"active"<br />"completed"<br />"failed" | The action's status |
139+
| node_uid | string | UID of the node where the operation runs (optional) |
140+
| object_name | string | The object that the action runs on (optional) |
141+
| state | string | The current state of the state machine (optional) |
142+
| pending_ops | JSON object | List of operations that are waiting to run (optional) |
143+
122144
Regardless of an action’s source, each action contains the following attributes: `name`, `action_uid`, `status`, and `progress`.
123145

124146
#### Example JSON body

0 commit comments

Comments
 (0)