All Products
Search
Document Center

Container Service for Kubernetes:ListOperationPlansForRegion - List execution plans for automated O&M tasks in a specified region

Last Updated:Dec 26, 2025

Queries the 100 most recent execution plans for automated Operations and Maintenance (O&M) in a specified region. After you enable features such as intelligent cluster hosting in Auto Mode, automatic cluster upgrades, and automated O&M for node pools, you can call this operation to query the automatically generated O&M plans and check their execution status. Examples include cluster upgrades and node pool CVE fixes.

Debug

You can call this operation directly in OpenAPI Explorer, which eliminates the need to calculate signatures. After a successful call, OpenAPI Explorer automatically generates SDK code examples.

Authorization information

The following table describes the authorization information that is required to call this operation. You can add this information to the Action element of a Resource Access Management (RAM) policy to grant a RAM user or RAM role the permissions to call this operation. The columns are described as follows:

  • Operation: The specific permission.
  • Access level: The access level of each operation. Valid values: Write, Read, and List.
  • Resource type: The type of resource on which the permission can be granted. The following rules apply:
    • An asterisk ( * ) indicates a required resource type.
    • If an operation does not support resource-level authorization, All Resources is used.
  • Condition key: The condition keys defined by the cloud product.
  • Associated operation: Other required operations. To call this operation, you must also have the permissions to call the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
cs:ListOperationPlansForRegionnone
*All Resources
*
    None
None

Request syntax

<p>GET /regions/{region_id}/operation/plans HTTP/1.1</p>

Request parameters

NameTypeRequiredDescriptionExample
region_idstringYes

The region ID.

cn-beijing
cluster_idstringNo

Filter by cluster ID.

c02b3e03be10643e8a644a843ffcb****
typestringNo

Filter by execution plan type.

Valid values:
  • CVE_FIX: CVE fix.
  • CONTAINERD_UPGRADE: containerd upgrade.
  • CLUSTER_UPGRADE_MASTER: Master component upgrade.
  • CLUSTER_UPGRADE_ADDON: Add-on upgrade.
  • NODEPOOL_CONFIG: Node pool configuration update.
  • KUBELET_UPGRADE: Kubelet upgrade.
  • NODEPOOL_UPDATE_OS: Node pool OS update.
  • IMAGE_UPGRADE: Image upgrade.
CLUSTER_UPGRADE_MASTER
statestringNo

Filter by execution plan status.

Valid values:
  • Scheduled: The plan is scheduled.
  • Failed: The execution failed.
  • ValidatingFailed: The pre-execution check failed.
  • Executing: The plan is being executed.
  • Canceled: The plan was canceled.
  • Executed: The plan was executed.
Scheduled

Response parameters

NameTypeDescriptionExample
object

Response schema

plansarray<object>

The list of execution plans.

plansobject

The execution plan.

plan_idstring

The execution plan ID.

P-655c9c127e0e6603ef00****
cluster_idstring

The cluster ID.

c29ced64b3dfe4f33b57ca0aa9f68****
createdstring

The time when the execution plan was created.

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

The expected start time of the execution.

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

The expected end time of the execution.

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

The status.

Valid values:
  • Scheduled: The plan is scheduled.
  • Failed: The execution failed.
  • ValidatingFailed: The pre-execution check failed.
  • Executing: The plan is being executed.
  • Canceled: The plan was canceled.
  • Executed: The plan was executed.
Scheduled
state_reasonobject

The reason for the status.

codestring

The code.

CanceledByUser
messagestring

The message.

plan has been canceled by user
typestring

The type.

Valid values:
  • CVE_FIX: CVE fix.
  • CONTAINERD_UPGRADE: containerd upgrade.
  • CLUSTER_UPGRADE_MASTER: Master component upgrade.
  • CLUSTER_UPGRADE_ADDON: Add-on upgrade.
  • NODEPOOL_CONFIG: Node pool configuration update.
  • KUBELET_UPGRADE: Kubelet upgrade.
  • NODEPOOL_UPDATE_OS: Node pool OS update.
  • IMAGE_UPGRADE: Image upgrade.
CLUSTER_UPGRADE_MASTER
target_typestring

The type of the execution target.

Valid values:
  • cluster: cluster.
  • nodepool: node pool.
  • addon: add-on.
cluster
target_idstring

The ID of the execution target.

c29ced64b3dfe4f33b57ca0aa9f68****
task_idstring

The ID of the task generated by the execution plan.

T-681ac448b23ced010600****

Examples

Sample success response

JSON format

{
  "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****"
    }
  ]
}

Error codes

For more information about error codes, see the Error Center.

Change history

Change timeChange summaryAction
2025-11-25The OpenAPI response structure is changed.View change details
2025-11-04A new OpenAPI operation is added.View change details