All Products
Search
Document Center

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

Last Updated:Dec 26, 2025

Queries the 100 most recent automated O&M execution plans in a specified region. If you enable features such as cluster hosting in Auto Mode, automatic cluster upgrades, and automated O&M for node pools, you can call this operation to query the system-generated O&M plans and their execution status. Examples of these plans include cluster upgrades and CVE fixes for node pools.

Debugging

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

Authorization information

The following table lists the authorization information for this operation. To grant a Resource Access Management (RAM) user or RAM role the permissions to call this operation, add the required permission to the Action element of a RAM access policy. The following list describes the items in the table:

  • Operation: The specific permission.
  • Access level: The access level of each operation. Valid values: Write, Read, and List.
  • Resource type: The resource type that an operation can access.
    • Required resource types are marked with an asterisk ( * ).
    • For operations that do not support resource-level authorization, All resources is displayed for this item.
  • Condition key: The condition keys that are defined by the cloud product.
  • Associated operation: Other operations that you must also be authorized to perform to successfully call this operation.
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

Filters the results by cluster ID.

c02b3e03be10643e8a644a843ffcb****
typestringNo

Filters the results by execution plan type.

Valid values:
  • CVE_FIX
  • CONTAINERD_UPGRADE
  • CLUSTER_UPGRADE_MASTER
  • CLUSTER_UPGRADE_ADDON
  • NODEPOOL_CONFIG
  • KUBELET_UPGRADE
  • NODEPOOL_UPDATE_OS
  • IMAGE_UPGRADE
CLUSTER_UPGRADE_MASTER
statestringNo

Filters the results by execution plan state.

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

Response parameters

NameTypeDescriptionExample
object

The response schema.

plansarray<object>

The list of execution plans.

plansobject

An 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 state of the plan.

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

The reason for the state.

codestring

The code.

CanceledByUser
messagestring

The message.

plan has been canceled by user
typestring

The type.

Valid values:
  • CVE_FIX
  • CONTAINERD_UPGRADE
  • CLUSTER_UPGRADE_MASTER
  • CLUSTER_UPGRADE_ADDON
  • NODEPOOL_CONFIG
  • KUBELET_UPGRADE
  • NODEPOOL_UPDATE_OS
  • IMAGE_UPGRADE
CLUSTER_UPGRADE_MASTER
target_typestring

The type of the execution target.

Valid values:
  • cluster
  • nodepool
  • addon
cluster
target_idstring

The ID of the execution target.

c29ced64b3dfe4f33b57ca0aa9f68****
task_idstring

The ID of the task that is generated by the execution plan.

T-681ac448b23ced010600****

Examples

Successful response example

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 a list of error codes, see the API Error Center.

Change history

Change timeDescriptionActions
2025-11-25The OpenAPI response structure is changed.View Details
2025-11-04The OpenAPI is added.View Details