All Products
Search
Document Center

Container Service for Kubernetes:ListOperationPlansForRegion - Queries the execution plans for automated O&M jobs 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. When you enable features such as intelligent cluster management in Auto Mode, automatic cluster upgrades, and automated O&M for node pools, you can call this operation to query system-generated O&M plans and their execution status. Examples of these plans include cluster upgrades and node pool CVE fixes.

Debug

You can run this operation directly in OpenAPI Explorer. This saves you the effort of calculating signatures. After a successful call, OpenAPI Explorer automatically generates SDK code examples.

Authorization information

The following table lists the authorization information for this API. You can use this information in the Action element of a Resource Access Management (RAM) policy statement to grant a RAM user or RAM role the permissions to call this API. The columns are described as follows:

  • Operation: The specific permission point.
  • Access level: The access level of each operation. Valid values are Write, Read, and List.
  • Resource type: The type of resource for which permissions can be granted for the operation. The following rules apply:
    • An asterisk ( * ) is prefixed to a required resource type.
    • If the operation does not support resource-level authorization, All Resources is specified.
  • Condition key: The condition keys defined by the cloud product.
  • Associated operation: Other permissions that are required to perform the operation. To perform the operation, you must have the permissions for 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

Filters the plans by cluster ID.

c02b3e03be10643e8a644a843ffcb****
typestringNo

Filters the plans 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 plans by execution plan state.

Valid values:
  • Scheduled: The plan is scheduled.
  • Failed: The execution failed.
  • ValidatingFailed: The pre-check 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

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 state.

Valid values:
  • Scheduled: The plan is scheduled.
  • Failed: The execution failed.
  • ValidatingFailed: The pre-check 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 job that is generated from the execution plan.

T-681ac448b23ced010600****

Examples

Sample successful response

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

Error codes

For a list of error codes, see the API Error Center.

Change history

Change dateDescriptionOperation
2025-11-25The API response structure is changed.View Details
2025-11-04The API is added.View Details