Automated O&M Execution Plans Across Regions Overview - ACK - Alibaba Cloud - Container Service for Kubernetes

Query the list of the latest 100 automated O&M execution plans in a specified region. When features such as Auto Mode for Intelligent Cluster Management, automatic cluster upgrade, and node pool automated O&M are enabled, you can use this API to query O&M plans automatically generated by the System and their execution status, such as cluster upgrades or CVE fixes for node pools.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cs:ListOperationPlansForRegion

none

*All Resource

*

None

Request syntax

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

Path Parameters

Parameter	Type	Required	Description	Example
region_id	string	Yes	Region ID.	cn-beijing

Request parameters

Parameter	Type	Required	Description	Example
cluster_id	string	No	Filter by cluster ID.	c02b3e03be10643e8a644a843ffcb****
type	string	No	Filter by execution plan type. Valid values: CVE_FIX : CVE_FIX CONTAINERD_UPGRADE : CONTAINERD_UPGRADE CLUSTER_UPGRADE_MASTER : CLUSTER_UPGRADE_MASTER CLUSTER_UPGRADE_ADDON : CLUSTER_UPGRADE_ADDON NODEPOOL_CONFIG : NODEPOOL_CONFIG KUBELET_UPGRADE : KUBELET_UPGRADE NODEPOOL_UPDATE_OS : NODEPOOL_UPDATE_OS IMAGE_UPGRADE : IMAGE_UPGRADE	CLUSTER_UPGRADE_MASTER
state	string	No	Filter by execution plan status. Valid values: Scheduled : Failed : ValidatingFailed : Executing : Canceled : Executed :	Scheduled

Response elements

Element	Type	Description	Example
	object	Schema of Response
plans	array<object>	List of execution plans.
	array<object>	Execution plan.
plan_id	string	Execution plan ID.	P-655c9c127e0e6603ef00****
cluster_id	string	Cluster ID.	c29ced64b3dfe4f33b57ca0aa9f68****
created	string	Creation Time of the execution plan.	2023-11-21T20:01:22+08:00
start_time	string	Expected start time.	2023-11-22T15:18:00+08:00
end_time	string	Expected End Time of execution.	2023-11-22T18:00:00+08:00
state	string	Status. Valid values: Scheduled : Failed : ValidatingFailed : Executing : Canceled : Executed :	Scheduled
state_reason	object	Status reason.
code	string	Code.	CanceledByUser
message	string	Message.	plan has been canceled by user
type	string	Type. Valid values: CVE_FIX : CVE_FIX CONTAINERD_UPGRADE : CONTAINERD_UPGRADE CLUSTER_UPGRADE_MASTER : CLUSTER_UPGRADE_MASTER CLUSTER_UPGRADE_ADDON : CLUSTER_UPGRADE_ADDON NODEPOOL_CONFIG : NODEPOOL_CONFIG KUBELET_UPGRADE : KUBELET_UPGRADE NODEPOOL_UPDATE_OS : NODEPOOL_UPDATE_OS IMAGE_UPGRADE : IMAGE_UPGRADE	CLUSTER_UPGRADE_MASTER
target_type	string	Type of the execution Target. Valid values: cluster : cluster nodepool : nodepool addon : addon	cluster
target_id	string	ID of the execution Target.	c29ced64b3dfe4f33b57ca0aa9f68****
task_id	string	Job ID generated by the execution plan.	T-681ac448b23ced010600****

Examples

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.