DescribeNodeGroupRefreshTask - 查询节点组配置刷新任务详情

Updated at:

查询节点组配置刷新任务详细进展。返回每个节点的实际执行结果,包括已刷新的属性、因超出 MaxDisruptiveAction 约束被跳过的属性、以及失败原因。

接口说明

返回的结果中包含一下内容:

  • 每个有配置漂移的节点的处理情况

  • 每个节点的处理结果、状态、原因

  • 每个节点刷新、跳过的属性

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

eflo:DescribeNodeGroupRefreshTask

get

*全部资源

*

无 无

请求参数

名称

类型

必填

描述

示例值

NodeGroupRefreshTaskId

string

是

刷新任务 ID

task-159136551662516768776

NodeStatuses

array

否

查询要过滤的节点刷新状态:

  • Pending 节点等待刷新

  • InProgress 节点正在刷新

  • Success 节点刷新成功

  • Failed 节点刷新失败

  • Skipped 节点所有待刷新属性都超出 MaxDisruptiveAction 约束而跳过

string

否

节点所处状态列表。不设置会返回所有状态的节点列表。

Success

NextToken

string

否

查询凭证(Token)。取值为上一次调用该接口返回的 NextToken 参数值,初次调用接口时无需设置该参数。用来分页拉取当前刷新任务中的节点列表。

563d42ae0b17572449ec8c97f7f66069

MaxResults

integer

否

分页查询时每页的最大条目数,取值范围:1~500。默认值:100。

20

返回参数

名称

类型

描述

示例值

object

RequestId

string

Id of the request

4FD06DF0-9167-5C6F-A145-F30CA4A15D54

NextToken

string

下一个查询开始的 Token,NextToken 为空表示没有下一个。

7ed93fda-5e7f-436a-ae5a-bd8e6b04e36b

MaxResults

integer

单页查询的最大条目数。

20

NodeGroupRefreshTaskId

string

刷新任务 ID

task-159136551662516768776

NodeGroupId

string

节点组 ID

ng-3525

Status

string

任务状态:

  • Pending 刷新任务创建成功,等待执行

  • InProgress 刷新任务正在处理中

  • Success 刷新任务执行成功

  • Failed 刷新任务执行失败

InProgress

TotalNodeCount

integer

该任务刷新总节点数

100

FinishedCount

integer

已完成节点数(包括成功、失败、跳过的)

45

FailedCount

integer

失败节点数

2

StartTime

string

刷新任务的开始时间(ISO8601)

2026-04-20T10:00:00Z

EndTime

string

刷新任务的结束时间(ISO8601)

2026-04-20T10:30:00Z

MaxDisruptiveAction

string

刷新操作允许的最大破坏性操作等级

Refresh

Nodes

array<object>

节点列表

array<object>

节点详细

NodeId

string

节点 ID

node-001

Action

string

对该节点实际执行的动作等级。若节点有多个属性被刷新,取其中所需动作等级最高者:

  • Refresh 原地刷新

  • Reboot 重启

  • Reimage 重装 若整个节点被跳过,返回空。

Refresh

Status

string

节点刷新状态:

  • Pending 节点等待刷新

  • InProgress 节点正在刷新

  • Success 节点刷新成功

  • Failed 节点刷新失败

  • Skipped 节点所有待刷新属性都超出 MaxDisruptiveAction 约束而跳过

Success

ErrorCode

string

错误码

NodeInMaintenance

ErrorMessage

string

错误信息

The node has been confirmed for maintenance and there is no need to confirm the maintenance again. sn: 21B917666,status:ClusterNodeRepairing

PropertyDrifts

array<object>

该节点的属性偏差列表(含已执行和被跳过的)

object

PropertyPath

string

属性路径(dot notation)

RamRoleName

ActualValue

string

节点属性当前值,复杂类型序列化为 JSON 字符串

old-role

TargetValue

string

节点属性目标值,复杂类型序列化为 JSON 字符串

new-role

MinRequiredAction

string

使 TargetValue 生效所需的最低动作:Refresh / Reboot / Reimage,详情参见 RefreshNodeGroupNodes 接口入参 MaxDisruptiveAction 解释。

Refresh

Skipped

boolean

是否因超出 MaxDisruptiveAction 被跳过

false

示例

正常返回示例

JSON格式

{
  "RequestId": "4FD06DF0-9167-5C6F-A145-F30CA4A15D54",
  "NextToken": "7ed93fda-5e7f-436a-ae5a-bd8e6b04e36b",
  "MaxResults": 20,
  "NodeGroupRefreshTaskId": "task-159136551662516768776",
  "NodeGroupId": "ng-3525",
  "Status": "InProgress",
  "TotalNodeCount": 100,
  "FinishedCount": 45,
  "FailedCount": 2,
  "StartTime": "2026-04-20T10:00:00Z",
  "EndTime": "2026-04-20T10:30:00Z",
  "MaxDisruptiveAction": "Refresh",
  "Nodes": [
    {
      "NodeId": "node-001",
      "Action": "Refresh",
      "Status": "Success",
      "ErrorCode": "NodeInMaintenance",
      "ErrorMessage": "The node has been confirmed for maintenance and there is no need to confirm the maintenance again. sn: 21B917666,status:ClusterNodeRepairing",
      "PropertyDrifts": [
        {
          "PropertyPath": "RamRoleName",
          "ActualValue": "old-role",
          "TargetValue": "new-role",
          "MinRequiredAction": "Refresh",
          "Skipped": false
        }
      ]
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情。