Query automated maintenance schedules with ListOperationPlans - Container Service for Kubernetes - Alibaba Cloud - Container Service for Kubernetes

Queries the automated maintenance schedules of a cluster.

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:ListOperationPlans

list

*All Resource

*

None

Request syntax

GET /operation/plans HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
cluster_id	string	No	The cluster ID.	c29ced64b3dfe4f33b57ca0aa9f68****
type	string	No	The operation plan type.	cluster_upgrade

Response elements

Element	Type	Description	Example
	object
plans	array<object>	The list of auto O&M execution plans.
	object	An execution plan.
plan_id	string	The operation plan ID.	P-655c9c127e0e6603ef00****
cluster_id	string	The cluster ID.	c29ced64b3dfe4f33b57ca0aa9f68****
created	string	The time when the operation plan was created.	2023-11-21T20:01:22+08:00
start_time	string	The expected start time of the plan.	2023-11-22T15:18:00+08:00
end_time	string	The expected end time of the plan.	2023-11-22T18:00:00+08:00
state	string	The plan status. Valid values: scheduled Canceled	scheduled
type	string	The plan type. Valid values: cluster_upgrade	cluster_upgrade
target_type	string	The target type.	cluster
target_id	string	The target ID.	c29ced64b3dfe4f33b57ca0aa9f68****
task_id	string	The ID of the task generated by the execution plan.	T-6764d027be846d01310006b1

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",
      "type": "cluster_upgrade",
      "target_type": "cluster",
      "target_id": "c29ced64b3dfe4f33b57ca0aa9f68****",
      "task_id": "T-6764d027be846d01310006b1"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.