ListOperationPlansForRegion - 查询指定地域自动运维任务执行计划列表

查询指定地域内最近100条自动运维执行计划列表。开启集群智能托管模式Auto Mode、集群自动升级、节点池自动化运维等功能时,您可以通过该接口查询由系统自动生成的运维计划及其执行情况,例如集群升级、节点池CVE修复等。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
cs:ListOperationPlansForRegionnone
*全部资源
*

请求语法

GET /regions/{region_id}/operation/plans HTTP/1.1

请求参数

名称类型必填描述示例值
region_idstring

地域 ID。

cn-beijing
cluster_idstring

按集群 ID 过滤。

c02b3e03be10643e8a644a843ffcb****
typestring

按执行计划类型过滤。

枚举值:
  • CVE_FIXCVE_FIX
  • CONTAINERD_UPGRADECONTAINERD_UPGRADE
  • CLUSTER_UPGRADE_MASTERCLUSTER_UPGRADE_MASTER
  • CLUSTER_UPGRADE_ADDONCLUSTER_UPGRADE_ADDON
  • NODEPOOL_CONFIGNODEPOOL_CONFIG
  • KUBELET_UPGRADEKUBELET_UPGRADE
  • NODEPOOL_UPDATE_OSNODEPOOL_UPDATE_OS
  • IMAGE_UPGRADEIMAGE_UPGRADE
CLUSTER_UPGRADE_MASTER
statestring

按执行计划状态过滤。

枚举值:
  • Scheduled已编排计划
  • Failed执行失败
  • ValidatingFailed执行前检查失败
  • Executing执行中
  • Canceled已取消
  • Executed已执行
Scheduled

返回参数

名称类型描述示例值
object

Schema of Response

plansarray<object>

执行计划列表。

plansobject

执行计划。

plan_idstring

执行计划 ID。

P-655c9c127e0e6603ef00****
cluster_idstring

集群 ID。

c29ced64b3dfe4f33b57ca0aa9f68****
createdstring

执行计划创建时间。

2023-11-21T20:01:22+08:00
start_timestring

预期开始执行时间。

2023-11-22T15:18:00+08:00
end_timestring

预期结束执行时间。

2023-11-22T18:00:00+08:00
statestring

状态。

枚举值:
  • Scheduled已编排计划
  • Failed执行失败
  • ValidatingFailed执行前检查失败
  • Executing执行中
  • Canceled已取消
  • Executed已执行
Scheduled
state_reasonobject

状态原因。

codestring

代码。

CanceledByUser
messagestring

信息。

plan has been canceled by user
typestring

类型。

枚举值:
  • CVE_FIXCVE_FIX
  • CONTAINERD_UPGRADECONTAINERD_UPGRADE
  • CLUSTER_UPGRADE_MASTERCLUSTER_UPGRADE_MASTER
  • CLUSTER_UPGRADE_ADDONCLUSTER_UPGRADE_ADDON
  • NODEPOOL_CONFIGNODEPOOL_CONFIG
  • KUBELET_UPGRADEKUBELET_UPGRADE
  • NODEPOOL_UPDATE_OSNODEPOOL_UPDATE_OS
  • IMAGE_UPGRADEIMAGE_UPGRADE
CLUSTER_UPGRADE_MASTER
target_typestring

执行目标类型。

枚举值:
  • clustercluster
  • nodepoolnodepool
  • addonaddon
cluster
target_idstring

执行目标 ID。

c29ced64b3dfe4f33b57ca0aa9f68****
task_idstring

执行计划产生的任务 ID。

T-681ac448b23ced010600****

示例

正常返回示例

JSON格式

{
  "plans": [
    {
      "plan_id": "P-655c9c127e0e6603ef00****",
      "cluster_id": "c29ced64b3dfe4f33b57ca0aa9f68****",
      "created": "2023-11-21T20:01:22+08:00",
      "start_time": "2023-11-22T15:18:00+08:00",
      "end_time": "2023-11-22T18:00:00+08:00",
      "state": "Scheduled",
      "state_reason": {
        "code": "CanceledByUser",
        "message": "plan has been canceled by user"
      },
      "type": "CLUSTER_UPGRADE_MASTER",
      "target_type": "cluster",
      "target_id": "c29ced64b3dfe4f33b57ca0aa9f68****",
      "task_id": "T-681ac448b23ced010600****"
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2025-11-25OpenAPI 返回结构发生变更查看变更详情
2025-11-04新增 OpenAPI查看变更详情