作请求

作请求

Redis 企业软件
方法 路径 描述
获取 /v1/actions 获取所有作
获取 /v1/actions/{uid} 获取单个作

获取所有作

GET /v1/actions

获取所有集群、节点和数据库上所有正在运行、待处理或已完成的作的状态。此 API 跟踪返回task_id或action_uid.

所需权限

权限名称
view_status_of_cluster_action

请求

HTTP 请求示例

GET /v1/actions

响应

返回一个 JSON 数组的动作对象（表示任务）和一个状态机对象数组。

田 类型/值 描述
action_uid 字符串 作的全局唯一标识符
名字 字符串 正在运行或失败的状态机的名称
进展 浮点型 （范围： 0-100） 作已完成步骤的百分比
地位 “待处理”
“活动”
“已完成”“
失败”		 作的状态
node_uid 字符串 运行作的节点的 UID（可选）
object_name 字符串 运行作的对象（可选）
州 字符串 状态机的当前状态（可选）
pending_ops JSON 对象 等待运行的作列表（可选）
"pending_ops": {
  "3": {
    "heartbeat": integer,
    "snapshot": { ... },
    "last_sample_time": integer,
    "op_name": string,
    "status_code": string,
    "status_description": string,
    "progress": float
  }
}

pending_ops是一个映射，其中键是shard_id，该值是一个映射，可以包含以下可选字段：
heartbeat：自 Unix 纪元以来的时间（以秒为单位），自上次更改作进度以来。
snapshot：由作存储的运行所需的属性的映射。
last_sample_time：自 Unix 纪元以来拍摄作的最后一个快照的时间（以秒为单位）。
op_name：正在运行的状态机中的作的名称。
status_code：作当前状态的代码。
status_description：作的当前状态。
progress：作的进度百分比（1 到 100）。

无论作的来源如何，响应中的每个作都包含以下属性：name,action_uid,status和progress.

示例 JSON 正文

{
  "actions": [
    {
      "action_uid": "159ca2f8-7bf3-4cda-97e8-4eb560665c28",
      "name": "retry_bdb",
      "node_uid": "2",
      "progress": "100",
      "status": "completed",
      "task_id": "159ca2f8-7bf3-4cda-97e8-4eb560665c28"
    },
    {
      "action_uid": "661697c5-c747-41bd-ab81-ffc8fd13c494",
      "name": "retry_bdb",
      "node_uid": "1",
      "progress": "100",
      "status": "completed",
      "task_id": "661697c5-c747-41bd-ab81-ffc8fd13c494"
    }
  ],
  "state-machines": [
    {
      "action_uid": "a10586b1-60bc-428e-9bc6-392eb5f0d8ae",
      "heartbeat": 1650378874,
      "name": "SMCreateBDB",
      "object_name": "bdb:1",
      "progress": 100,
      "status": "completed"
    }
  ]
}

Status codes

Code Description
200 OK No error, response provides info about an ongoing action
404 Not Found Action does not exist (i.e. not currently running and no available status of last run).

Get a specific action

GET /v1/actions/{uid}

Get the status of a specific action.

Required permissions

Permission name
view_status_of_cluster_action

Request

Example HTTP request

GET /v1/actions/{uid}

URL parameters

Field Type Description
uid string The action_uid to check

Response

Returns an action object.

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"
"active"
"completed"
"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)
"pending_ops": {
  "3": {
    "heartbeat": integer,
    "snapshot": { ... },
    "last_sample_time": integer,
    "op_name": string,
    "status_code": string,
    "status_description": string,
    "progress": float
  }
}

pending_ops is a map where the key is the shard_id, and the value is a map that can include the following optional fields:
heartbeat: The time, in seconds since the Unix epoch, since the last change in the progress of the operation.
snapshot: A map of properties stored by the operation that are needed to run.
last_sample_time: The time, in seconds since the Unix epoch, when the last snapshot of the operation was taken.
op_name: The name of the operation from the state machine that is running.
status_code: The code for the operation's current status.
status_description: The operation's current status.
progress: The operation's progress in percentage (1 to 100).

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

Example JSON body

{
  "action_uid": "159ca2f8-7bf3-4cda-97e8-4eb560665c28",
  "name": "retry_bdb",
  "node_uid": "2",
  "progress": "100",
  "status": "completed",
  "task_id": "159ca2f8-7bf3-4cda-97e8-4eb560665c28"
}

Status codes

Code Description
200 OK No error, response provides info about an ongoing action
404 Not Found Action does not exist (i.e. not currently running and no available status of last run)
RATE THIS PAGE
Back to top ↑