# Alibaba Cloud Container Service for Kubernetes API > Alibaba Cloud Container Service for Kubernetes API on Apizie: 128 endpoints (Adds existing Elastic Compute Service (ECS) instances to a Container Service for Kubernetes (ACK) cluster.…, Adds existing ECS instances to a node pool in an ACK cluster. You can call this operation to add existing…, Cancels an existing but unexecuted automated O&M task execution plan, Cancels the execution of a cluster task, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/cloud:aliyun-cs/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month. - Project key: `cloud:aliyun-cs` - Category: Cloud - Status: byok - Source: https://api.alibabacloud.com/product/cs - Page: https://zieapi.vercel.app/api/cloud/aliyun-cs - OpenAPI: https://zieapi.vercel.app/api/cloud/aliyun-cs/openapi.json Alibaba Cloud OpenAPI for Container Service for Kubernetes (cs, version 2015-12-15). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret. ## Endpoints ### Adds existing Elastic Compute Service (ECS) instances to a Container Service for Kubernetes (ACK) cluster.… `POST https://zieapi.vercel.app/v1/cloud:aliyun-cs/attach-instances` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | ClusterId | string | yes | The cluster ID | | cpu_policy | string | no | The CPU management policy of the node. The following policies are supported for clusters running version 1.12.6 or later: `static`: Allows… | | format_disk | string | no | Specifies whether to store container data and images on a data cloud disk. Valid values: `true`: Stores container data and images on a… | | image_id | string | no | The custom image ID. If you specify a custom image ID, the system cloud disk image of the instance is replaced with the custom image. If… | | instances | array | yes | The list of ECS instances to be added | | is_edge_worker | string | no | Specifies whether the node to be added is an edge node, which is an Edge Node Service (ENS) node. Valid values: `true`: The node to be… | | keep_instance_name | string | no | Specifies whether to retain the original instance name. Valid values: `true`: Retains the instance name. `false`: Does not retain the… | | key_pair | string | no | The name of the key pair for the instances to be added. You need to specify only one of key_pair and password, or you can leave both… | | nodepool_id | string | no | The node pool ID. If you do not specify this parameter, the node is added to the default node pool | | password | string | no | The SSH logon password for the instances to be added. You need to specify only one of key_pair and password, or you can leave both… | | rds_instances | array | no | The list of ApsaraDB RDS instances | | runtime | object | no | The container runtime. After you specify `nodepool_id`, this parameter is not supported. name: the name of the container runtime. ACK… | | tags | array | no | The node labels. Label definition rules: Labels are case-sensitive key-value pairs. You can configure up to 20 labels. Label keys cannot… | | user_data | string | no | The node user data. For more information, see https://help.aliyun.com/document_detail/49121.html. After you specify `nodepool_id`, this… | ### Adds existing ECS instances to a node pool in an ACK cluster. You can call this operation to add existing… `POST https://zieapi.vercel.app/v1/cloud:aliyun-cs/attach-instances-to-node-pool` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | ClusterId | string | yes | The cluster ID | | NodepoolId | string | yes | The node pool ID | | format_disk | string | no | Specifies whether to store container data and images on a data cloud disk. Valid values: `true`: Stores container data and images on a… | | instances | array | no | The list of ECS instances to be added | | keep_instance_name | string | no | Specifies whether to retain the original instance name. Valid values: `true`: Retains the instance name. `false`: Does not retain the… | | password | string | no | The SSH logon password of the instances to be added | ### Cancels an existing but unexecuted automated O&M task execution plan `POST https://zieapi.vercel.app/v1/cloud:aliyun-cs/cancel-operation-plan` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | plan_id | string | yes | The execution plan ID | ### Cancels the execution of a cluster task `POST https://zieapi.vercel.app/v1/cloud:aliyun-cs/cancel-task` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | task_id | string | yes | The task ID | ### Queries the log configuration of control plane components for an ACK managed cluster. ACK managed clusters… `GET https://zieapi.vercel.app/v1/cloud:aliyun-cs/check-control-plane-log-enable` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | ClusterId | string | yes | The cluster ID | ### Checks whether the current service account has been granted the specified service role permissions.… `POST https://zieapi.vercel.app/v1/cloud:aliyun-cs/check-service-role` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | roles | array | yes | The list of service roles to check | ### Cleans up KubeConfig credentials and RBAC permissions that have been issued to a specified user in a… `POST https://zieapi.vercel.app/v1/cloud:aliyun-cs/clean-cluster-user-permissions` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | ClusterId | string | yes | The cluster ID | | Uid | string | yes | The ID of the specified Resource Access Management (RAM) user or RAM role within the Alibaba Cloud account | | Force | string | no | Specifies whether to force delete the specified KubeConfig. Valid values: false (default): Before deleting the KubeConfig, the system… | ### Cleans up KubeConfig credentials and RBAC permissions for a specified user. If you want to clean up and… `POST https://zieapi.vercel.app/v1/cloud:aliyun-cs/clean-user-permissions` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | Uid | string | yes | The ID of the specified Resource Access Management (RAM) user or RAM role within the Alibaba Cloud account | | Force | string | no | Specifies whether to force delete the specified KubeConfig. Valid values: false (default): Before deleting the KubeConfig, the system… | | ClusterIds | string | no | The list of cluster IDs. If this list is specified, only the KubeConfig credentials and RBAC permissions of the current user in the… | ### Creates a self-healing rule `POST https://zieapi.vercel.app/v1/cloud:aliyun-cs/create-auto-repair-policy` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | cluster_id | string | yes | The cluster ID | | name | string | no | The name of the self-healing rule | | resource_sub_type | string | no | The resource subtype to which the self-healing rule can be bound | | resource_type | string | no | The resource type to which the self-healing rule can be bound | | rules | array | no | The list of self-healing sub-rules | ### Creates an elastic scaling configuration that enables the system to automatically increase or decrease… `POST https://zieapi.vercel.app/v1/cloud:aliyun-cs/create-autoscaling-config` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | ClusterId | string | yes | The cluster ID | | cool_down_duration | string | no | The scale-in trigger delay, which is the time interval between when a scale-in need is detected (the scale-in threshold is reached) and… | | daemonset_eviction_for_nodes | string | no | Specifies whether cluster-autoscaler evicts DaemonSet Pods on a node during scale-in. Valid values: `true`: Eviction is performed.… | | expander | string | no | The node pool scale-out order policy. Valid values: `least-waste`: The default policy. If multiple node pools are available for scale-out,… | | gpu_utilization_threshold | string | no | The GPU scale-in threshold, which is the ratio of requested resources to total resources on a node. A GPU node can be scaled in only when… | | max_graceful_termination_sec | integer | no | The timeout period for cluster-autoscaler to wait for Pod termination during node draining in a scale-in scenario. Unit: seconds. Default… | | min_replica_count | integer | no | The minimum number of Pods allowed in each ReplicaSet before a node can be scaled in. Default value: 0 | | priorities | object | no | The priority configuration for auto scaling. After you create a node pool with elastic scaling enabled, you can configure priority… | | recycle_node_deletion_enabled | string | no | Specifies whether to delete the corresponding Kubernetes Node object after a node in rapid mode is successfully scaled in. For more… | | scale_down_enabled | string | no | Specifies whether to allow node scale-in. Valid values: `true`: Scale-in is allowed. `false`: Scale-in is prohibited | | scale_up_from_zero | string | no | Specifies whether cluster-autoscaler performs scale-out when the number of Ready nodes in the cluster is 0. Default value: true. Valid… | | scaler_type | string | no | The elastic component type. For clusters running version 1.24 or later, the default value is goatscaler. For earlier versions, the default… | | scan_interval | string | no | The scaling sensitivity, which adjusts the interval for the system to evaluate scaling decisions. Valid values: 15, 30, 60, 120, 180, 300.… | | skip_nodes_with_local_storage | string | no | Specifies whether cluster-autoscaler skips scale-in for nodes that run Pods with local storage (such as EmptyDir or HostPath). Valid… | | skip_nodes_with_system_pods | string | no | Specifies whether cluster-autoscaler skips scale-in for nodes that run Pods in the kube-system namespace. This feature does not apply to… | | unneeded_duration | string | no | The cool-down period. The time interval after the most recent scale-out event during which the elastic component does not perform scale-in… | | utilization_threshold | string | no | The scale-in threshold, which is the ratio of requested resources to total resources on a node. A node can be scaled in only when this… | ### Creates an ACK cluster, including ACK managed clusters, ACK Serverless clusters, ACK Edge clusters, and… `POST https://zieapi.vercel.app/v1/cloud:aliyun-cs/create-cluster` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | access_control_list | array | no | [Deprecated] The access control list (ACL) of the SLB instance for the API server of a registered cluster | | addons | array | no | The list of cluster components. When you create a cluster, use `addons` to specify the components that you want to install. Network… | | api_audiences | string | no | A ServiceAccount is the access credential used by a pod to communicate with the cluster API server. The `api-audiences` parameter… | | audit_log_config | object | no | The cluster audit log configuration | | auto_mode | object | no | The https://help.aliyun.com/document_detail/2938898.html configuration | | auto_renew | string | no | [Deprecated] Specifies whether to enable auto-renewal. This parameter takes effect only when `charge_type` is set to `PrePaid`. Valid… | | auto_renew_period | integer | no | [Deprecated] The auto-renewal epoch. This parameter takes effect only when the billing method is subscription and auto-renewal is enabled.… | | charge_type | string | no | [Deprecated] The billing method of the CLB instance used by the API server. Default value: PostPaid. Valid values: PostPaid:… | | cis_enabled | string | no | [Deprecated] For cluster control plane configuration, use the `security_hardening_os` parameter under `control_plane_config` instead. For… | | client_token | string | no | The client token | | cloud_monitor_flags | string | no | [Deprecated] For cluster control plane node configuration, use the `cloud_monitor_flags` parameter under `control_plane_config` instead.… | | cluster_domain | string | no | The cluster local domain name. Naming rules: A domain name consists of one or more parts separated by periods (.). Each part can be up to… | | cluster_spec | string | no | After you set `cluster_type` to `ManagedKubernetes` and configure `profile`, you can further specify the cluster specification. Valid… | | cluster_type | string | no | `Kubernetes`: ACK dedicated cluster. `ManagedKubernetes`: ACK managed cluster types, including ACK managed clusters (Pro and Basic… | | container_cidr | string | no | The pod network CIDR block. It must be a valid private CIDR block, specifically the following CIDR blocks and their subnets: 10.0.0.0/8,… | | control_plane_config | object | no | The control plane configuration for ACK dedicated clusters | | control_plane_endpoints_config | object | no | The cluster endpoint configuration | | controlplane_log_components | array | no | The list of component names that specifies which control plane components to collect logs from. By default, logs are collected from… | | controlplane_log_project | string | no | The Simple Log Service project for control plane component logs. You can use an existing project for log storage or allow the system to… | | controlplane_log_ttl | string | no | The log retention period for control plane component logs, in days | | cpu_policy | string | no | [Deprecated] Use the `cpu_policy` parameter under `control_plane_config` for cluster control plane configuration, or use the `cpu_policy`… | | custom_san | string | no | [Deprecated] Use the `extra_sans` parameter instead. The custom certificate Subject Alternative Name (SAN). Separate multiple IP addresses… | | deletion_protection | string | no | Specifies whether to enable cluster deletion protection, which prevents the cluster from being accidentally deleted in the console or by… | | disable_rollback | string | no | [Deprecated] When cluster creation fails, no rollback is performed by default. You must manually clean up the failed cluster. Specifies… | | enable_rrsa | string | no | [Deprecated] Use the `rrsa_config` parameter instead. Specifies whether to enable the RRSA feature. true: Enables the feature. false: Does… | | encryption_provider_key | string | no | The ID of the Key Management Service (KMS) key used to encrypt cloud disks. For more information, see… | | endpoint_public_access | string | no | Specifies whether to enable public network access. An Elastic IP Address (EIP) is used to expose the API Server for public network access… | | extra_sans | array | no | The custom Subject Alternative Name (SAN) for the API Server certificate | | format_disk | string | no | [Deprecated] Selecting existing nodes during cluster creation is not supported. To add existing nodes to a cluster, create a node pool… | | image_id | string | no | [Deprecated] For cluster control plane configuration, use the `image_id` parameter under `control_plane_config` instead. For node pool… | | image_type | string | no | [Deprecated] For cluster control plane configuration, use the `image_type` parameter under `control_plane_config` instead. For node pool… | | instances | array | no | [Deprecated] Selecting existing nodes during cluster creation is not supported. To add existing nodes to a cluster, create a node pool… | | ip_stack | string | no | The IP protocol stack of the cluster | | is_enterprise_security_group | string | no | Specifies whether to enable automatic creation of an advanced security group. This parameter takes effect when `security_group_id` is… | | keep_instance_name | string | no | [Deprecated] Selecting existing nodes during cluster creation is not supported. To add existing nodes to a cluster, create a node pool… | | key_pair | string | no | [Deprecated] For cluster control plane configuration, use the `key_pair` parameter under `control_plane_config` instead. For node pool… | | kubernetes_version | string | no | The cluster version, which is consistent with the Kubernetes community baseline version. Use the latest version. If you do not specify… | | load_balancer_id | string | no | The Classic Load Balancer (CLB) instance ID used for API Server access. If this parameter is specified, automatic creation of an API… | | load_balancer_spec | string | no | [Deprecated] CLB uses pay-by-usage billing. This parameter does not take effect. The load balancing specification. Valid values:… | | logging_type | string | no | [Deprecated] Enables the log service for the cluster. This parameter takes effect only for ACK Serverless clusters, and the value must be… | | login_password | string | no | [Deprecated] For cluster control plane configuration, use the `login_password` parameter under `control_plane_config` instead. For node… | | maintenance_window | object | no | The cluster O&M window | | master_auto_renew | string | no | [Deprecated] For cluster control plane configuration, use the `auto_renew` parameter under `control_plane_config` instead. Specifies… | | master_auto_renew_period | integer | no | [Deprecated] For cluster control plane configuration, use the `auto_renew_period` parameter under `control_plane_config` instead. The… | | master_count | integer | no | [Deprecated] For cluster control plane configuration, use the `size` parameter under `control_plane_config` instead. The number of master… | | master_instance_charge_type | string | no | [Deprecated] For cluster control plane configuration, use the `instance_charge_type` parameter under `control_plane_config` instead. The… | | master_instance_types | array | no | [Deprecated] For cluster control plane configuration, use the `instance_types` parameter under `control_plane_config` instead. The… | | master_period | integer | no | [Deprecated] For cluster control plane configuration, use the `unit` parameter under `control_plane_config` instead. The subscription… | | master_period_unit | string | no | [Deprecated] For cluster control plane configuration, use the `period_unit` parameter under `control_plane_config` instead. The… | | master_system_disk_category | string | no | [Deprecated] For cluster control plane configuration, use the `system_disk_category` parameter under `control_plane_config` instead. The… | | master_system_disk_performance_level | string | no | [Deprecated] For cluster control plane configuration, use the `system_disk_performance_level` parameter under `control_plane_config`… | | master_system_disk_size | integer | no | [Deprecated] For cluster control plane configuration, use the `system_disk_size` parameter under `control_plane_config` instead. The… | | master_system_disk_snapshot_policy_id | string | no | [Deprecated] For cluster control plane configuration, use the `system_disk_snapshot_policy_id` parameter under `control_plane_config`… | | master_vswitch_ids | array | no | [Deprecated] Use the `vswitch_ids` parameter instead. The list of vSwitch IDs for master nodes. The number of vSwitches must be in the… | | name | string | yes | The custom cluster name. The name can contain digits, Chinese characters, letters, and hyphens (-). The name must be 1 to 63 characters in… | | nat_gateway | string | no | [Deprecated] Use the `snat_entry` parameter instead | | node_cidr_mask | string | no | The number of IP addresses per node, determined by specifying the network CIDR block. This parameter takes effect only for Flannel network… | | node_name_mode | string | no | [Deprecated] For node pool configuration, use the `node_name_mode` parameter under `kubernetes_config` in `nodepool` instead | | node_port_range | string | no | The node service port range. Valid port range: [30000,65535]. Default value: `30000-32767` | | nodepools | array | no | The list of node pools | | num_of_nodes | integer | no | [Deprecated] Use the desired_size parameter under scaling_group in nodepool instead. The number of worker nodes. Valid values: 0 to 100 | | operation_policy | object | no | The cluster automatic O&M policy | | os_type | string | no | [Deprecated] For cluster control plane node configuration, use the image_type parameter under control_plane_config instead. For node pool… | | period | integer | no | [Deprecated] The subscription duration. This parameter takes effect and is required only when charge_type is set to PrePaid. Valid values:… | | period_unit | string | no | [Deprecated] The billing cycle. This parameter is required when the billing method is set to PrePaid. Valid values: Month. Currently, only… | | platform | string | no | [Deprecated] For node pool configuration, use the platform parameter under scaling_group in nodepool instead. The operating system… | | pod_vswitch_ids | array | no | [Deprecated] When the Terway network plugin is selected, specify vSwitches for Pod IP address allocation. Each Pod vSwitch corresponds to… | | profile | string | no | When `cluster_type` is set to `ManagedKubernetes` (ACK managed clusters), you can further specify the cluster subtype. `Default`: ACK… | | proxy_mode | string | no | The kube-proxy mode. `iptables`: A mature and stable kube-proxy mode. Service discovery and load balancing for Kubernetes Services are… | | rds_instances | array | no | [Deprecated] For node pool configuration, use the rds_instances parameter under scaling_group in nodepool instead. The list of ApsaraDB… | | region_id | string | yes | The ID of the region where the cluster is deployed. For details, see https://help.aliyun.com/document_detail/216938.html | | resource_group_id | string | no | The ID of the resource group to which the cluster belongs. Use this parameter to isolate different resources | | rrsa_config | object | no | The RRSA feature configuration | | runtime | object | no | The container runtime used by the cluster. Supported runtimes include containerd, sandboxed containers, and Docker. Kubernetes 1.24 no… | | security_group_id | string | no | The ID of an existing security group. This parameter is mutually exclusive with `is_enterprise_security_group`. Cluster nodes are… | | security_hardening_os | string | no | [Deprecated] For cluster control plane configuration, use the security_hardening_os parameter under control_plane_config instead. For node… | | service_account_issuer | string | no | A ServiceAccount is the access credential used for communication between a Pod and the cluster API Server. The `service-account-issuer` is… | | service_cidr | string | no | The CIDR block for the Service network. Valid ranges: 10.0.0.0/16-24, 172.16-31.0.0/16-24, and 192.168.0.0/16-24. The CIDR block cannot… | | service_discovery_types | array | no | [Deprecated] The service discovery type within the cluster, used to specify the service discovery method in `ACK Serverless` clusters.… | | snat_entry | string | no | Specifies whether to configure SNAT for the VPC. Valid values: `true`: Automatic creation of a NAT gateway and automatic configuration of… | | soc_enabled | string | no | [Deprecated] For cluster control plane node configurations, use the `soc_enabled` parameter under `control_plane_config` instead. For node… | | ssh_flags | string | no | Specifies whether to enable public network SSH logon. This parameter is used to log on to the master nodes of ACK dedicated clusters. This… | | tags | array | no | The node tags. Tag definition rules: Tags are case-sensitive key-value pairs. You can settings up to 20 tags. Tag keys cannot be… | | taints | array | no | [Deprecated] For node pool configuration, use the taints parameter under kubernetes_config in nodepool instead. The node taint… | | timeout_mins | integer | no | [Deprecated] When cluster creation fails, the system does not perform a rollback by default. You must manually clean up the failed… | | timezone | string | no | The time zone used by the cluster. For more information, see https://help.aliyun.com/document_detail/354879.html | | user_ca | string | no | The custom cluster CA | | user_data | string | no | [Deprecated] The custom node data | | vpcid | string | no | The VPC used by the cluster. You must provide a VPC when creating a cluster | | vswitch_ids | array | no | The vSwitches where the cluster nodes reside. This parameter is required when creating a zero-node managed cluster | | worker_auto_renew | string | no | [Deprecated] For node pool configuration, use the auto_renew parameter under scaling_group in nodepool instead. Specifies whether to… | | worker_auto_renew_period | integer | no | [Deprecated] For node pool configuration, use the auto_renew_period parameter under scaling_group in nodepool instead. The Unified Auto… | | worker_data_disks | array | no | [Deprecated] Use the data_disks parameter under scaling_group in nodepool instead for node pool configurations. The combination of data… | | worker_instance_charge_type | string | no | [Deprecated] Use the instance_charge_type parameter under scaling_group in nodepool instead for node pool configurations. The billing… | | worker_instance_types | array | no | [Deprecated] Use the instance_types parameter under scaling_group in nodepool instead for node pool configurations. The instance… | | worker_period | integer | no | [Deprecated] Use the period parameter under scaling_group in nodepool instead for node pool configurations. The subscription duration for… | | worker_period_unit | string | no | [Deprecated] Use the period_unit parameter under scaling_group in nodepool instead for node pool configurations. The billing period unit… | | worker_system_disk_category | string | no | [Deprecated] Use the system_disk_category parameter under scaling_group in nodepool instead for node pool configurations. The system cloud… | | worker_system_disk_performance_level | string | no | [Deprecated] Use the system_disk_performance_level parameter under scaling_group in nodepool instead for node pool configurations. The… | | worker_system_disk_size | integer | no | [Deprecated] Use the system_disk_size parameter under scaling_group in nodepool instead for node pool configurations. The system cloud… | | worker_system_disk_snapshot_policy_id | string | no | [Deprecated] Use the system_disk_snapshot_policy_id parameter under scaling_group in nodepool instead for node pool configurations. The ID… | | worker_vswitch_ids | array | no | [Deprecated] Use the vswitch_ids parameter under scaling_group in nodepool instead for node pool configurations. The list of vSwitches… | | zone_id | string | no | [Deprecated] Use the `zone_ids` parameter instead. The active zone ID of the region to which the cluster belongs. This parameter is… | | zone_ids | array | no | The IDs of multiple zones in the region to which the cluster belongs. This parameter is specific to ACK managed clusters | ### Initiates a cluster diagnosis `POST https://zieapi.vercel.app/v1/cloud:aliyun-cs/create-cluster-diagnosis` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | cluster_id | string | yes | The cluster ID | | target | object | no | The parameters used to specify the diagnosis target. The following examples show the parameters for different diagnosis types: node: ```… | | type | string | no | The diagnosis type | ### Creates a cluster inspection configuration `POST https://zieapi.vercel.app/v1/cloud:aliyun-cs/create-cluster-inspect-config` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | clusterId | string | yes | The cluster ID | | disabledCheckItems | array | no | The list of disabled inspection items | | enabled | string | yes | Specifies whether to enable inspection | | recurrence | string | yes | The inspection cycle defined by using the RFC5545 Recurrence Rule syntax. You must specify BYHOUR and BYMINUTE. Only FREQ=DAILY is… | ### Creates a node pool for a cluster. A node pool is a logical collection of nodes that share the same… `POST https://zieapi.vercel.app/v1/cloud:aliyun-cs/create-cluster-node-pool` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | ClusterId | string | yes | The cluster ID | | auto_mode | object | no | The auto mode configuration of the node pool | | auto_scaling | object | no | The elastic scaling configuration | | count | integer | no | [Deprecated] Use desired_size instead. The number of nodes in the node pool | | eflo_node_group | object | no | The Lingjun node pool configuration | | host_network | string | no | Specifies whether pods in the edge node pool use the host network mode. Valid values: true: host network. Pods directly use the network… | | interconnect_config | object | no | [Deprecated] The configuration of the edge node pool | | interconnect_mode | string | no | The network type of the edge node pool. This parameter takes effect only when type is set to edge. Valid values: basic: public network.… | | intranet | string | no | Specifies whether Layer 3 network connectivity is enabled between nodes in the edge node pool. Valid values: true: enabled. Layer 3… | | kubernetes_config | object | no | The cluster configurations | | management | object | no | The configurations for the managed node pool feature | | max_nodes | integer | no | [Deprecated] The maximum number of nodes allowed in an edge node pool | | node_components | array | no | The list of node components | | node_config | object | no | The node configuration | | nodepool_info | object | no | The node pool configuration | | scaling_group | object | no | The scaling group configuration of the node pool | | tee_config | object | no | The confidential computing cluster configuration | ### Installs node components `POST https://zieapi.vercel.app/v1/cloud:aliyun-cs/create-node-pool-component-instances` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | cluster_id | string | yes | The cluster ID | | nodepool_id | string | yes | The node pool ID | | components | array | yes | The list of node components | | node_names | array | no | The list of nodes for the rolling update. Default value: all nodes | | rolling_policy | object | no | The rolling update configuration | ### An orchestration template defines and describes a set of Kubernetes cluster resources in a declarative… `POST https://zieapi.vercel.app/v1/cloud:aliyun-cs/create-template` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | description | string | no | The orchestration template description | | name | string | yes | The template name. Naming rules: The name can contain digits, Chinese characters, letters, and hyphens (-). The name must be 1 to 63… | | tags | string | no | The orchestration template tags | | template | string | yes | The template content in YAML format | | template_type | string | no | The templatetype. If the value is set to `kubernetes`, the template is displayed on the Orchestration Templates page in the console. If… | ### Configures a trigger for a cluster application. The trigger redeploys pods when specified conditions are met `POST https://zieapi.vercel.app/v1/cloud:aliyun-cs/create-trigger` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | action | string | yes | The trigger action. Valid values: `redeploy`: redeploys the resource defined in `project_id` | | cluster_id | string | yes | The cluster ID | | project_id | string | yes | The trigger project name. The value consists of the namespace and application name in the format of `${namespace}/${name}`. Example:… | | type | string | no | The trigger type. Valid values: `deployment`: a trigger for stateless applications. `application`: a trigger for App Hub applications.… | ### Deletes ACK alert contacts `POST https://zieapi.vercel.app/v1/cloud:aliyun-cs/delete-alert-contact` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | contact_ids | string | yes | The list of alert contact IDs (JSON-encoded) | ### Deletes alert contact groups in ACK `POST https://zieapi.vercel.app/v1/cloud:aliyun-cs/delete-alert-contact-group` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | contact_group_ids | string | yes | The list of alert contact group IDs (JSON-encoded) | ### Deletes a self-healing rule `POST https://zieapi.vercel.app/v1/cloud:aliyun-cs/delete-auto-repair-policy` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | cluster_id | string | yes | The cluster ID | | policy_id | string | yes | The ID of the self-healing rule | ### Deletes a cluster and specifies whether to delete or retain the associated resources of the cluster. Before… `POST https://zieapi.vercel.app/v1/cloud:aliyun-cs/delete-cluster` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | ClusterId | string | yes | The cluster ID | | retain_all_resources | string | no | Specifies whether to retain all resources. If this parameter is set to `true`, `retain_resources` is ignored, and cloud resources created… | | keep_slb | string | no | Specifies whether to retain SLB instances. Valid values: `true`: Retains the created SLB resources. `false`: Does not retain the created… | | retain_resources | string | no | The list of resources. To retain resources when deleting a cluster, specify the IDs of the corresponding resources (JSON-encoded) | | delete_options | string | no | The deletion options for cluster-associated resources (JSON-encoded) | ### Deletes a cluster inspection configuration `POST https://zieapi.vercel.app/v1/cloud:aliyun-cs/delete-cluster-inspect-config` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | clusterId | string | yes | The cluster ID | ### Deletes a node pool that is no longer in use. When a node pool is deleted, all pods on the nodes are… `POST https://zieapi.vercel.app/v1/cloud:aliyun-cs/delete-cluster-nodepool` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | ClusterId | string | yes | The cluster ID | | NodepoolId | string | yes | The node pool ID | | force | string | no | Specifies whether to force delete the node pool. true: Force deletes the node pool. If the node pool contains existing instances, the… | ### Removes nodes from a cluster. When you no longer need cluster nodes to continue working, you can call the… `POST https://zieapi.vercel.app/v1/cloud:aliyun-cs/delete-cluster-nodes` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | ClusterId | string | yes | The cluster ID | | drain_node | string | no | Specifies whether to automatically drain Pods on the nodes. Valid values: `true`: Automatically drains Pods on the nodes. `false`: Does… | | nodes | array | yes | The list of nodes to remove. The node name must be the name of the node in the cluster, such as `cn-hangzhou.192.168.xx.xx` | | release_node | string | no | Specifies whether to release the ECS instances at the same time. Valid values: `true`: Releases the ECS instances at the same time.… | ### Uninstalls a node component `POST https://zieapi.vercel.app/v1/cloud:aliyun-cs/delete-node-pool-component-instance` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | cluster_id | string | yes | The cluster ID | | nodepool_id | string | yes | The node pool ID | | name | string | yes | The component name | | max_parallelism | integer | no | The maximum number of parallel operations per batch. Default value: 1 | | pause_policy | string | no | The auto-pause policy during a node upgrade. Valid values: NotPause FirstBatch EveryBatch Default value: NotPause | | batch_interval | integer | no | The interval between batches, in seconds. Default value: 0 | | max_failed_nodes | integer | no | The maximum number of nodes that can fail during the rolling process. Default value: 0. A value of 0 indicates that the task fails if any… | | node_names | string | no | The list of nodes to rotate. Default value: all nodes (JSON-encoded) | ### Deletes a policy rule instance from a specified cluster `POST https://zieapi.vercel.app/v1/cloud:aliyun-cs/delete-policy-instance` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | cluster_id | string | yes | The ID of the target cluster | | policy_name | string | yes | The name of the policy governance rule | | instance_name | string | no | The instance ID of the policy rule | ### Deletes an orchestration template when it is no longer needed `POST https://zieapi.vercel.app/v1/cloud:aliyun-cs/delete-template` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | TemplateId | string | yes | The ID of the orchestration template | ### Deletes an application trigger when it is no longer needed `POST https://zieapi.vercel.app/v1/cloud:aliyun-cs/delete-trigger` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | cluster_id | string | yes | The cluster ID | | Id | string | yes | The trigger ID | ### Deploys a policy instance in a specified namespace of a cluster. You can select a security policy type in an… `POST https://zieapi.vercel.app/v1/cloud:aliyun-cs/deploy-policy-instance` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | cluster_id | string | yes | The ID of the target cluster | | policy_name | string | yes | The name of the policy governance rule | | action | string | no | The governance action of the rule. Valid values: `deny`: blocks deployments that violate the policy. `warn`: generates alerts | | namespaces | array | no | The namespaces to which the policy applies. An empty value indicates all namespaces | | parameters | object | no | The parameter settings of the current rule instance. For the parameters supported by each policy governance rule and the corresponding… | ### Queries information about a specified component based on parameters such as region, cluster type, cluster… `GET https://zieapi.vercel.app/v1/cloud:aliyun-cs/describe-addon` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | addon_name | string | yes | The name of the component | | region_id | string | no | The region ID. If cluster_id is specified, this parameter is ignored. The region_id, cluster_type, profile, cluster_spec, and… | | cluster_type | string | no | The cluster type. If cluster_id is specified, this parameter is ignored. The region_id, cluster_type, profile, cluster_spec, and… | | profile | string | no | The cluster subtype. If cluster_id is specified, this parameter is ignored. The region_id, cluster_type, profile, cluster_spec, and… | | cluster_spec | string | no | The cluster specifications. If cluster_id is specified, this parameter is ignored. The region_id, cluster_type, profile, cluster_spec, and… | | cluster_version | string | no | The cluster version. If cluster_id is specified, this parameter is ignored. The region_id, cluster_type, profile, cluster_spec, and… | | cluster_id | string | no | The cluster ID. If you specify a cluster ID, the system queries the components available for the cluster and ignores other parameters | | version | string | no | The component version. If this parameter is not specified, the latest available version of the component is queried | ### Queries self-healing rules `GET https://zieapi.vercel.app/v1/cloud:aliyun-cs/describe-auto-repair-policy` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | cluster_id | string | yes | The cluster ID | | policy_id | string | yes | The self-healing rule ID | ### Retrieves the script for adding existing nodes to a cluster node pool. If you need to add existing ECS… `POST https://zieapi.vercel.app/v1/cloud:aliyun-cs/describe-cluster-attach-scripts` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | ClusterId | string | yes | The cluster ID | | arch | string | no | The CPU architecture of the node. Valid values: `amd64`, `arm`, and `arm64`. Default value: `amd64`. This parameter is required when the… | | expired | integer | no | The expiration time of the generated token, in UNIX timestamp format. For example, 1739980800 indicates 2025-02-20 00:00:00 | | format_disk | string | no | Specifies whether to mount data cloud disks to the instance when manually adding existing instances to the cluster, storing containers and… | | keep_instance_name | string | no | Specifies whether to retain the instance name when adding existing instances to the cluster. If the instance name is not retained, the… | | nodepool_id | string | no | The node pool ID. When adding a node, you can add the node to the specified node pool. If you do not specify a node pool ID, the node is… | | one_time_token | string | no | The one_time_token | | options | string | no | The access configuration parameters of the node. This parameter is required when the cluster type is managed edge | | rds_instances | array | no | If you specify a list of RDS instances, the ECS nodes in the cluster are automatically added to the RDS whitelist | ### Queries the details of a specified cluster by cluster ID `GET https://zieapi.vercel.app/v1/cloud:aliyun-cs/describe-cluster-detail` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | ClusterId | string | yes | The cluster ID | ### Queries the events of a specified cluster. Cluster operation events include cluster creation, cluster… `GET https://zieapi.vercel.app/v1/cloud:aliyun-cs/describe-cluster-events` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | ClusterId | string | yes | The cluster ID | | page_size | integer | no | The maximum number of entries to return on each page. Valid values: 1 to 100. Default value: 50 | | page_number | integer | no | The page number | | next_token | string | no | The pagination token. Set the value to the next_token value returned from the previous API call | | max_results | integer | no | The maximum number of results to return for a single request | | task_id | string | no | The ID of the task to query | ### Retrieves the log data of a cluster for root cause analysis and tracing when cluster issues occur `GET https://zieapi.vercel.app/v1/cloud:aliyun-cs/describe-cluster-logs` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | ClusterId | string | yes | The cluster ID | ### Queries the configuration of a specified node pool in a cluster `GET https://zieapi.vercel.app/v1/cloud:aliyun-cs/describe-cluster-node-pool-detail` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | ClusterId | string | yes | The cluster ID | | NodepoolId | string | yes | The node pool ID | ### Queries all node pools in a cluster `GET https://zieapi.vercel.app/v1/cloud:aliyun-cs/describe-cluster-node-pools` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | ClusterId | string | yes | The cluster ID | | NodepoolName | string | no | The node pool name | ### Queries the list of nodes that meet the specified conditions `GET https://zieapi.vercel.app/v1/cloud:aliyun-cs/describe-cluster-nodes` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | ClusterId | string | yes | The cluster ID | | instanceIds | string | no | The list of node instance IDs. Separate multiple values with commas (,) | | nodepool_id | string | no | The node pool ID | | state | string | no | The running states of the cluster nodes used for filtering. Valid values: `all`: does not filter nodes by running state and queries nodes… | | pageSize | string | no | The maximum number of records to return per page. Valid values: 1 to 100. Default value: 10 | | pageNumber | string | no | The page number of the current query. Default value: 1 | | nodeNames | string | no | The list of node names used for filtering. Separate multiple values with commas (,) | | nodeIps | string | no | The list of node IP addresses used for filtering. Separate multiple values with commas (,) | | nodeLabels | string | no | The node labels used for filtering. Specify the labels as key=value pairs separated by commas (,). Multiple labels are evaluated with the… | ### When you use Container Service for Kubernetes (ACK), you also use resources from other associated Alibaba… `GET https://zieapi.vercel.app/v1/cloud:aliyun-cs/describe-cluster-resources` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | ClusterId | string | yes | The cluster ID. For information about how to view the cluster ID, see https://help.aliyun.com/document_detail/89446.html. You can also… | | with_addon_resources | string | no | Specifies whether to also query resources created by cluster components. true: Queries the resources. false: Does not query the resources | ### Queries a list of tasks in a cluster `GET https://zieapi.vercel.app/v1/cloud:aliyun-cs/describe-cluster-tasks` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | cluster_id | string | yes | The cluster ID | | page_size | integer | no | The number of items per page | | page_number | integer | no | The page number | | next_token | string | no | The pagination token. Set the value to the next_token parameter value returned from the previous API call | | max_results | integer | no | The maximum number of results to return per request | ### KubeConfig is used to configure access credentials for ACK clusters on the client. It contains identity and… `GET https://zieapi.vercel.app/v1/cloud:aliyun-cs/describe-cluster-user-kubeconfig` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | ClusterId | string | yes | The cluster ID | | PrivateIpAddress | string | no | Specifies whether to obtain the internal network connection configuration. Valid values: `true`: Obtains only the internal network… | | TemporaryDurationMinutes | integer | no | The validity period of the temporary KubeConfig. Unit: minutes. Valid values: 15 (15 minutes) to 4320 (3 days). If you do not set this… | ### Queries the details of security vulnerabilities in a cluster by cluster ID, including vulnerability names,… `GET https://zieapi.vercel.app/v1/cloud:aliyun-cs/describe-cluster-vuls` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | cluster_id | string | yes | The cluster ID | ### Queries all clusters in a specified region `GET https://zieapi.vercel.app/v1/cloud:aliyun-cs/describe-clusters-for-region` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | name | string | no | Fuzzy matches clusters by cluster name | | cluster_type | string | no | The type of cluster to query. Valid values: Kubernetes: ACK dedicated cluster. ManagedKubernetes: ACK managed cluster types, including ACK… | | page_size | integer | no | The number of records per page | | page_number | integer | no | The page number | | profile | string | no | The subtype of cluster to query. Valid values: Default: ACK managed cluster, including ACK Pro and ACK Basic. Edge: ACK Edge cluster,… | | cluster_spec | string | no | The specification of the cluster to query. Valid values: `ack.standard`: Basic `ack.pro.small`: Pro `ack.pro.xlarge`: Pro XL… | | cluster_id | string | no | The cluster ID | | region_id | string | yes | The region ID | ### Queries a list of ACK clusters that match specified conditions, such as cluster type and cluster… `GET https://zieapi.vercel.app/v1/cloud:aliyun-cs/describe-clusters-v1` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | name | string | no | The cluster name. Fuzzy match is supported | | cluster_type | string | no | The cluster type. Valid values: Kubernetes: ACK dedicated cluster. ManagedKubernetes: ACK managed clusters, including ACK managed clusters… | | page_size | integer | no | The number of entries to return on each page | | page_number | integer | no | The page number of the current page | | profile | string | no | The cluster subtype. This parameter is valid only when cluster_type is set to ManagedKubernetes. Valid values: Default: ACK serverless… | | cluster_spec | string | no | The cluster specification. This parameter is valid when cluster_type is set to ManagedKubernetes and profile is configured. Valid values:… | | region_id | string | no | The region of the cluster. Specify this parameter to filter clusters by region | | cluster_id | string | no | The cluster ID | ### Queries the details of cluster operation events, such as cluster creation, cluster modification, node pool… `GET https://zieapi.vercel.app/v1/cloud:aliyun-cs/describe-events` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | cluster_id | string | no | The cluster ID | | type | string | no | The event type. If you do not specify this parameter, events of all types are queried. Valid values: `cluster_create`: Cluster creation.… | | page_size | integer | no | The maximum number of results to return per page. Valid values: 1 to 100. Default value: 50 | | page_number | integer | no | The page number for paging in the paged query | | next_token | string | no | The pagination token. Set this parameter to the NextToken value returned from the previous API call | | max_results | integer | no | The maximum number of results to return for a single request | ### Queries the list of all events in a specified region `GET https://zieapi.vercel.app/v1/cloud:aliyun-cs/describe-events-for-region` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | cluster_id | string | no | The cluster ID | | page_size | integer | no | The maximum number of results to return per page. Valid values: 1 to 100. Default value: 50 | | page_number | integer | no | The page number | | next_token | string | no | The query token. The value is the next_token parameter value returned by the previous API call | | max_results | integer | no | The maximum number of results to return for a single request | | region_id | string | yes | The region ID | ### Queries the details of Kubernetes versions, including version information, release dates, expiration dates,… `GET https://zieapi.vercel.app/v1/cloud:aliyun-cs/describe-kubernetes-version-metadata` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | Region | string | yes | The ID of the region where the cluster is deployed | | ClusterType | string | yes | The cluster type. Valid values: `Kubernetes`: ACK dedicated cluster. `ManagedKubernetes`: ACK managed cluster, including ACK Pro clusters,… | | KubernetesVersion | string | no | The Kubernetes version of the cluster. This version is consistent with the Kubernetes community baseline version. We recommend that you… | | Profile | string | no | The cluster profile. Valid values: `Default`: cluster for non-edge scenarios. `Edge`: cluster for edge scenarios. `Serverless`: ASK… | | runtime | string | no | The runtime type. You can specify a runtime type to filter system images supported by the runtime. Valid values: `docker`: Docker runtime.… | | Mode | string | no | The query mode. Valid values: `supported`: Supported versions. `creatable`: Versions available for cluster creation. If you specify… | | QueryUpgradableVersion | string | no | Specifies whether to query the upgradable versions of the cluster version. This parameter takes effect only when the KubernetesVersion… | ### Queries the security vulnerability details of a node pool by node pool ID by calling the… `GET https://zieapi.vercel.app/v1/cloud:aliyun-cs/describe-node-pool-vuls` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | cluster_id | string | yes | The cluster ID | | nodepool_id | string | yes | The node pool ID | | necessity | string | no | The severity levels of vulnerabilities to query. Separate multiple levels with commas (,). Valid values: `asap`: high `later`: medium… | ### The container security policies for ACK clusters provide a rich set of built-in rule libraries, including… `GET https://zieapi.vercel.app/v1/cloud:aliyun-cs/describe-policies` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | ### ACK cluster container security policies provide a rich set of built-in rule libraries, including Compliance,… `GET https://zieapi.vercel.app/v1/cloud:aliyun-cs/describe-policy-details` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | policy_name | string | yes | The name of the policy governance rule | ### Queries the details of policy governance in a specified ACK cluster. Container security policies for ACK… `GET https://zieapi.vercel.app/v1/cloud:aliyun-cs/describe-policy-governance-in-cluster` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | cluster_id | string | yes | The ID of the target cluster | ### You can select a security policy type in an ACK cluster, configure the related enforcement actions and… `GET https://zieapi.vercel.app/v1/cloud:aliyun-cs/describe-policy-instances` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | cluster_id | string | yes | The ID of the target cluster | | policy_name | string | no | The name of the policy governance rule | | instance_name | string | no | The name of the policy instance | ### Queries the instance deployment status for different policy types in a cluster, including the number of… `GET https://zieapi.vercel.app/v1/cloud:aliyun-cs/describe-policy-instances-status` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | cluster_id | string | yes | The ID of the target cluster | ### Queries the list of regions `GET https://zieapi.vercel.app/v1/cloud:aliyun-cs/describe-regions` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | clusterType | string | no | The cluster type | | profile | string | no | The subtype of managed clusters | | acceptLanguage | string | no | Filters the returned results by language (Chinese or English) | ### Queries whether deletion protection is enabled for specified resources in a cluster. Supported resources… `GET https://zieapi.vercel.app/v1/cloud:aliyun-cs/describe-resources-delete-protection` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | ClusterId | string | yes | The ID of the ACK cluster | | ResourceType | string | yes | The type of the resource to query. Valid values: namespaces: namespace. services: service | | namespace | string | no | The namespace of the resource to query. This parameter is required when resource_type is set to services. If this parameter is not… | | resources | string | no | The names of the resources to query. Separate multiple resource names with commas (,). If resource_type is set to namespaces, specify… | ### As a cluster permission management administrator, you can use an Alibaba Cloud account to issue KubeConfig… `GET https://zieapi.vercel.app/v1/cloud:aliyun-cs/describe-subaccount-k8s-cluster-user-config` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | ClusterId | string | yes | The cluster ID | | Uid | string | yes | The ID of the specified Resource Access Management (RAM) user or RAM role within the Alibaba Cloud account | | PrivateIpAddress | string | no | Specifies whether to obtain the internal network connection configuration. Valid values: `true`: Obtains only the KubeConfig credentials… | | TemporaryDurationMinutes | integer | no | The validity period of the temporary KubeConfig. Unit: minutes. Valid values: [15, 4320], which is up to 3 days. If you do not set this… | ### Queries the details of a cluster task, such as the task type, running status, and running stage `GET https://zieapi.vercel.app/v1/cloud:aliyun-cs/describe-task-info` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | task_id | string | yes | The task ID | ### An orchestration template defines and describes a set of Kubernetes cluster resources in a declarative… `GET https://zieapi.vercel.app/v1/cloud:aliyun-cs/describe-template-attribute` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | TemplateId | string | yes | The template ID | | template_type | string | no | The templatetype. If the value is set to `kubernetes`, the template is displayed on the Orchestration Templates page in the console. If… | ### An orchestration template defines and describes a group of Kubernetes cluster resources in a declarative… `GET https://zieapi.vercel.app/v1/cloud:aliyun-cs/describe-templates` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | template_type | string | no | The templatetype. If the value is set to `kubernetes`, the template is displayed on the Orchestration Templates page in the console. If… | | page_num | integer | no | The page number to return when paginating query results. Default value: 1 | | page_size | integer | no | The number of entries per page when paginating query results. Default value: 10 | ### Queries triggers that meet the specified conditions `GET https://zieapi.vercel.app/v1/cloud:aliyun-cs/describe-trigger` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | cluster_id | string | yes | The cluster ID | | Namespace | string | yes | The namespace to which the application belongs | | Type | string | no | The trigger type. Valid values: `deployment`: a trigger for a stateless application. `application`: a trigger for an application in Open… | | Name | string | yes | The application name | | action | string | no | The trigger action. Valid values: `redeploy`: redeploys the application. If you do not specify a trigger action, the query results are not… | ### In an ACK cluster, you can use Kubernetes namespaces to achieve logically isolated permissions and resources… `GET https://zieapi.vercel.app/v1/cloud:aliyun-cs/describe-user-cluster-namespaces` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | ClusterId | string | yes | The cluster ID | ### In ACK clusters, you can create and assign different access permissions to different Resource Access… `GET https://zieapi.vercel.app/v1/cloud:aliyun-cs/describe-user-permission` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | uid | string | yes | The ID of the Resource Access Management (RAM) user or RAM role. To query the permissions of a RAM user, specify the UID of the RAM user.… | ### Queries the quotas of ACK clusters, node pools, and nodes. To increase a quota, go to Quota Center to submit… `GET https://zieapi.vercel.app/v1/cloud:aliyun-cs/describe-user-quota` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | ### Alibaba Cloud security products periodically scan for security vulnerabilities on ECS nodes and provide… `POST https://zieapi.vercel.app/v1/cloud:aliyun-cs/fix-node-pool-vuls` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | cluster_id | string | yes | The cluster ID | | nodepool_id | string | yes | The node pool ID | | auto_restart | string | no | Specifies whether to allow node restarts. true: Node restarts are allowed. false: Node restarts are not allowed | | nodes | array | no | The list of node names to fix. If this parameter is not specified, all nodes in the node pool are fixed by default | | rollout_policy | object | no | The rolling fix policy | | vuls | array | no | The list of vulnerabilities | ### Queries the details of a specified component instance in a cluster, including the version, parameter… `GET https://zieapi.vercel.app/v1/cloud:aliyun-cs/get-cluster-addon-instance` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | cluster_id | string | yes | The cluster ID | | instance_name | string | yes | The component instance name | ### Queries whether the API server audit feature is enabled for a cluster and retrieves the Simple Log Service… `GET https://zieapi.vercel.app/v1/cloud:aliyun-cs/get-cluster-audit-project` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | clusterid | string | yes | The ACK cluster ID | ### Queries the details of a specific check task for a Kubernetes cluster. The intelligent O&M platform for… `GET https://zieapi.vercel.app/v1/cloud:aliyun-cs/get-cluster-check` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | cluster_id | string | yes | The cluster ID | | check_id | string | yes | The check ID. You can call the https://help.aliyun.com/document_detail/2667902.html operation to obtain the check ID | ### Retrieves the diagnostic check items of a cluster `GET https://zieapi.vercel.app/v1/cloud:aliyun-cs/get-cluster-diagnosis-check-items` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | cluster_id | string | yes | The cluster ID | | diagnosis_id | string | yes | The diagnosis ID | | language | string | no | The query language | ### Retrieves the diagnosis result of a cluster `GET https://zieapi.vercel.app/v1/cloud:aliyun-cs/get-cluster-diagnosis-result` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | cluster_id | string | yes | The cluster ID | | diagnosis_id | string | yes | The diagnosis ID | | language | string | no | The query language | ### Retrieves the inspection configuration of a cluster `GET https://zieapi.vercel.app/v1/cloud:aliyun-cs/get-cluster-inspect-config` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | clusterId | string | yes | The cluster ID | ### Retrieves the details of a cluster inspection report `GET https://zieapi.vercel.app/v1/cloud:aliyun-cs/get-cluster-inspect-report-detail` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | clusterId | string | yes | The cluster ID | | reportId | string | yes | The inspection report ID | | language | string | no | The query language. Valid values: zh_CN en_US | | category | string | no | The category of the inspection item. Valid values: security: security and compliance performance: performance and efficiency stability:… | | targetType | string | no | The object type. Only check items that match the object type are returned | | level | string | no | The level of the inspection item. Valid values: advice: advice warning: low risk error: medium risk critical: high risk | | enableFilter | string | no | Specifies whether to filter inspection items. If set to true, only abnormal inspection items with a result of true are returned | | nextToken | string | no | The pagination token | | maxResults | integer | no | The maximum number of entries per page. Maximum value: 50 | ### By default, Resource Access Management (RAM) users or roles that are not cluster creators and have not been… `POST https://zieapi.vercel.app/v1/cloud:aliyun-cs/grant-permissions` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | uid | string | yes | The ID of the Resource Access Management (RAM) user or RAM role | | body | array | no | The request body parameters | ### To enhance Kubernetes capabilities, ACK clusters support various components, such as managed core… `POST https://zieapi.vercel.app/v1/cloud:aliyun-cs/install-cluster-addons` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | ClusterId | string | yes | The cluster ID | | body | array | no | The request body parameters | ### Installs node components on specified nodes with custom configurations `POST https://zieapi.vercel.app/v1/cloud:aliyun-cs/install-node-pool-components` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | clusterId | string | yes | The cluster ID | | nodePoolId | string | yes | The node pool ID | | components | array | no | The list of node components | | nodeNames | array | no | The list of node names specified for the rolling update. Default value: all nodes | | rollingPolicy | object | no | The rolling update configuration | ### Invokes the ListAddons operation to retrieve a list of active components based on specified parameters such… `GET https://zieapi.vercel.app/v1/cloud:aliyun-cs/list-addons` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | region_id | string | no | The region ID. If cluster_id is specified, this parameter is ignored. The region_id, cluster_type, profile, cluster_spec, and… | | cluster_type | string | no | The cluster type. If cluster_id is specified, this parameter is ignored. The region_id, cluster_type, profile, cluster_spec, and… | | profile | string | no | The cluster subtype. If cluster_id is specified, this parameter is ignored. The region_id, cluster_type, profile, cluster_spec, and… | | cluster_spec | string | no | The cluster specification. If cluster_id is specified, this parameter is ignored. The region_id, cluster_type, profile, cluster_spec, and… | | cluster_version | string | no | The cluster version. If cluster_id is specified, this parameter is ignored. The region_id, cluster_type, profile, cluster_spec, and… | | cluster_id | string | no | The cluster ID. If you specify a cluster ID, the available add-on components for the cluster are returned, and all other parameters are… | ### Retrieves a list of self-healing rules `GET https://zieapi.vercel.app/v1/cloud:aliyun-cs/list-auto-repair-policies` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | cluster_id | string | yes | The cluster ID | ### Queries the list of resources contained in an installed cluster component instance, including Kubernetes… `GET https://zieapi.vercel.app/v1/cloud:aliyun-cs/list-cluster-addon-instance-resources` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | cluster_id | string | yes | The cluster ID | | instance_name | string | yes | The name of the component instance | ### Queries the list of component instances installed in a specified cluster and retrieves related information,… `GET https://zieapi.vercel.app/v1/cloud:aliyun-cs/list-cluster-addon-instances` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | cluster_id | string | yes | The cluster ID | ### Queries the list of cluster checks and related information, such as the check type, status, creation time,… `GET https://zieapi.vercel.app/v1/cloud:aliyun-cs/list-cluster-checks` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | cluster_id | string | yes | The cluster ID | | type | string | no | The check type. Valid values: ClusterMigrate: cluster migration MasterUpgrade: cluster control plane upgrade NodePoolUpgrade: node pool… | | target | string | no | Filters specific check objects | ### Retrieves the list of cluster inspection reports `GET https://zieapi.vercel.app/v1/cloud:aliyun-cs/list-cluster-inspect-reports` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | clusterId | string | yes | The cluster ID | | nextToken | string | no | The pagination token | | maxResults | integer | no | The maximum number of results to return. The maximum value is 50 | ### Queries the list and status of user KubeConfigs issued for the current cluster `GET https://zieapi.vercel.app/v1/cloud:aliyun-cs/list-cluster-kubeconfig-states` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | ClusterId | string | yes | The cluster ID | | pageNumber | integer | no | The page number. Valid values: integers greater than or equal to 1. Default value: 1 | | pageSize | integer | no | The number of entries per page. Valid values: 1 to 50. Default value: 10 | | cloudServiceKubeConfig | string | no | Specifies whether to query the list of KubeConfigs for cloud service roles in the cluster. Valid values: true: Queries the list of… | ### Queries the status of node components on nodes `GET https://zieapi.vercel.app/v1/cloud:aliyun-cs/list-node-pool-component-instance-nodes` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | cluster_id | string | yes | The cluster ID | | nodepool_id | string | yes | The node pool ID | | name | string | yes | The component name | | version | string | no | Filters nodes by the specified node component version | | config_revision | string | no | Filters nodes by the specified configuration version number of the node component | | node_names | string | no | Specifies the list of node names to query (JSON-encoded) | | max_results | integer | no | The maximum number of records to return in a single response for pagination. Default value: 20 | | next_token | string | no | The pagination cursor. Do not specify this parameter for the first request. For subsequent requests, specify the token returned in the… | ### Queries node component instances `GET https://zieapi.vercel.app/v1/cloud:aliyun-cs/list-node-pool-component-instances` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | cluster_id | string | yes | The cluster ID | | nodepool_id | string | yes | The node pool ID | | next_token | string | no | The pagination token | | max_results | integer | no | The maximum number of results to return. Default value: 200 | ### Queries the node components that can be installed in a node pool `GET https://zieapi.vercel.app/v1/cloud:aliyun-cs/list-node-pool-components` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | cluster_id | string | yes | The cluster ID | | nodepool_id | string | no | The node pool ID. If you specify a node pool ID, the system queries the list of components available for the node pool and ignores other… | | nodepool_type | string | no | The node pool type. This parameter is required if nodepool_id is not specified | | instance_types | string | no | The instance types of the node pool. This parameter is required if nodepool_id is not specified (JSON-encoded) | | image_id | string | no | The image ID of the node pool. Either this parameter or image_type is required if nodepool_id is not specified | | image_type | string | no | The image type of the node pool. Either this parameter or image_id is required if nodepool_id is not specified | | next_token | string | no | The pagination token | | max_results | integer | no | The maximum number of results to return. Default value: 200 | ### Retrieves a list of automated O&M execution plans `GET https://zieapi.vercel.app/v1/cloud:aliyun-cs/list-operation-plans` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | cluster_id | string | no | The cluster ID | | type | string | no | The execution plan type | ### Queries the latest 100 automated O&M execution plans in a specified region. When features such as Auto Mode… `GET https://zieapi.vercel.app/v1/cloud:aliyun-cs/list-operation-plans-for-region` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | region_id | string | yes | The region ID | | cluster_id | string | no | Filters the results by cluster ID | | type | string | no | Filters the results by execution plan type | | state | string | no | Filters the results by execution plan state | ### You can add tag key-value pairs to clusters so that cluster developers or O&M engineers can more flexibly… `GET https://zieapi.vercel.app/v1/cloud:aliyun-cs/list-tag-resources` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | resource_ids | string | yes | The list of resource IDs to query (JSON-encoded) | | resource_type | string | yes | The resource type. CLUSTER: cluster | | region_id | string | yes | The region ID | | tags | string | no | The list of tags to query. A maximum of 20 items can be specified (JSON-encoded) | | next_token | string | no | The token for the next query | ### Queries the KubeConfig status list of all clusters for the current user. You can call this operation to view… `GET https://zieapi.vercel.app/v1/cloud:aliyun-cs/list-user-kube-config-states` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | Uid | string | yes | The ID of the specified Resource Access Management (RAM) user or RAM role within the Alibaba Cloud account | | page_number | integer | no | The current page number. Valid values: greater than or equal to 1. Default value: 1 | | page_size | integer | no | The number of results per page. Valid values: 1 to 100. Default value: 50 | ### Migrates a cluster `POST https://zieapi.vercel.app/v1/cloud:aliyun-cs/migrate-cluster` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | cluster_id | string | yes | The cluster ID | | oss_bucket_endpoint | string | no | The bucket endpoint | | oss_bucket_name | string | no | The bucket name | ### Modifies a self-healing rule `POST https://zieapi.vercel.app/v1/cloud:aliyun-cs/modify-auto-repair-policy` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | cluster_id | string | yes | The ID of the target cluster | | policy_id | string | yes | The ID of the self-healing rule | | name | string | no | The name of the self-healing rule | | rules | array | no | The list of self-healing sub-rules | ### Modifies the configuration of an ACK cluster `POST https://zieapi.vercel.app/v1/cloud:aliyun-cs/modify-cluster` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | ClusterId | string | yes | The cluster ID | | access_control_list | array | no | The access control list (ACL) for the API server SLB of a registered cluster | | api_server_custom_cert_sans | object | no | The custom API server certificate Subject Alternative Names (SANs). This parameter adds custom IP addresses or domain names to the SAN… | | api_server_eip | string | no | Specifies whether the cluster is attached with an EIP for public network access to the API server. Valid values: `true`: The cluster is… | | api_server_eip_id | string | no | The instance ID of the EIP attached to the cluster API server. This parameter takes effect only when `api_server_eip` is set to `true` | | client_token | string | no | The client token | | cluster_name | string | no | The custom cluster name. The name must be 1 to 63 characters in length and can contain digits, Chinese characters, letters, and hyphens… | | cluster_spec | string | no | The cluster specification when `cluster_type` is set to `ManagedKubernetes` and `profile` is configured. Valid values: `ack.pro.small`:… | | control_plane_config | object | no | The control plane configuration for dedicated clusters | | control_plane_endpoints_config | object | no | The cluster connection configuration | | deletion_protection | string | no | Specifies whether to enable deletion protection for the cluster. This prevents accidental deletion of the cluster through the console or… | | enable_rrsa | string | no | Specifies whether to enable or disable the RRSA feature. Only managed clusters support this parameter. Valid values: `true`: Enable.… | | ingress_domain_rebinding | string | no | Specifies whether to rebind the test domain name of the cluster. Valid values: `true`: Rebinds the test domain name of the cluster.… | | ingress_loadbalancer_id | string | no | The instance ID of the SLB for the cluster to be modified | | instance_deletion_protection | string | no | Specifies whether to enable instance deletion protection. This prevents accidental deletion of nodes through the console or API. Valid… | | maintenance_window | object | no | The O&M window configuration for the cluster. This feature takes effect only in ACK Pro managed clusters | | operation_policy | object | no | The automatic O&M policy for the cluster | | resource_group_id | string | no | The resource group ID of the cluster | | security_group_id | string | no | The control plane security group ID. If you have configured blocking rules in the security group, make sure the security group rules allow… | | system_events_logging | object | no | The system event storage configuration | | timezone | string | no | The cluster time zone. See https://help.aliyun.com/document_detail/354879.html. After the time zone is changed, the cluster inspection… | | vswitch_ids | array | no | The control plane vSwitches of the cluster. For dedicated clusters, the change applies to newly scaled-out control plane nodes. For… | ### Modifies the configuration of an installed cluster component instance. Modifying the configuration may… `POST https://zieapi.vercel.app/v1/cloud:aliyun-cs/modify-cluster-addon` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | cluster_id | string | yes | The cluster ID | | component_id | string | yes | The component ID | | config | string | no | The custom parameter settings | ### Updates the configuration of a node pool based on the node pool ID by calling the ModifyClusterNodePool… `POST https://zieapi.vercel.app/v1/cloud:aliyun-cs/modify-cluster-node-pool` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | ClusterId | string | yes | The cluster ID | | NodepoolId | string | yes | The node pool ID | | auto_scaling | object | no | The auto scaling configuration | | concurrency | string | no | Specifies whether to enable concurrency | | eflo_node_group | object | no | The Lingjun AI Computing Service node pool configuration. (Not effective) | | kubernetes_config | object | no | The cluster-related configuration | | management | object | no | The managed node pool configuration | | nodepool_info | object | no | The node pool configuration | | scaling_group | object | no | The scaling group configuration of the node pool | | tee_config | object | no | The confidential computing cluster configuration | | update_nodes | string | no | Specifies whether to synchronously update node labels and taints | ### You can add tag key-value pairs to clusters so that cluster developers or O&M engineers can categorize and… `POST https://zieapi.vercel.app/v1/cloud:aliyun-cs/modify-cluster-tags` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | ClusterId | string | yes | The cluster ID | | body | array | no | The data to update | ### Modifies the node configurations in a cluster node pool, such as kubelet configurations and rolling update… `POST https://zieapi.vercel.app/v1/cloud:aliyun-cs/modify-node-pool-node-config` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | ClusterId | string | yes | The cluster ID | | NodepoolId | string | yes | The node pool ID | | containerd_config | object | no | The containerd runtime configuration | | kubelet_config | object | no | The kubelet parameter settings | | node_names | array | no | The list of nodes to upgrade | | os_config | object | no | The operating system parameter settings | | rolling_policy | object | no | The rolling update configuration | ### Updates a policy rule instance in a specified cluster, such as the governance action (alert or block) and… `POST https://zieapi.vercel.app/v1/cloud:aliyun-cs/modify-policy-instance` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | cluster_id | string | yes | The ID of the target cluster | | policy_name | string | yes | The name of the policy rule | | action | string | no | The governance action of the rule. Valid values: `deny`: blocks non-compliant deployments. `warn`: generates alerts | | instance_name | string | no | The instance ID of the policy rule instance | | namespaces | array | no | The namespaces to which the policy applies. An empty value indicates all namespaces | | parameters | object | no | The configuration parameters of the current rule instance. For more information about parameter settings rules, see… | ### When you use Container Service for Kubernetes (ACK) for the first time, you must call the OpenAckService… `POST https://zieapi.vercel.app/v1/cloud:aliyun-cs/open-ack-service` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | type | string | no | The type of service to activate. Valid values: `propayasgo`: Container Service for Kubernetes (including ACK managed clusters and ACK… | ### Pauses a running cluster task `POST https://zieapi.vercel.app/v1/cloud:aliyun-cs/pause-task` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | task_id | string | yes | The task ID | ### Removes nodes from a node pool in a cluster and adjusts the expected number of nodes when you no longer need… `POST https://zieapi.vercel.app/v1/cloud:aliyun-cs/remove-node-pool-nodes` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | ClusterId | string | yes | The cluster ID | | NodepoolId | string | yes | The node pool ID | | release_node | string | no | Specifies whether to release the nodes. Valid values: true: Release the nodes. false: Do not release the nodes | | drain_node | string | no | Specifies whether to drain the nodes. Valid values: true: Drain the nodes. false: Do not drain the nodes | | nodes | string | no | [Deprecated] The list of nodes to remove. This parameter is deprecated. Use `instance_ids` instead. (JSON-encoded) | | instance_ids | string | no | The list of instances to remove (JSON-encoded) | | concurrency | string | no | Specifies whether to remove nodes concurrently. true: Nodes are concurrently removed from the scaling group. false: Nodes are sequentially… | ### Repairs nodes in a cluster node pool `POST https://zieapi.vercel.app/v1/cloud:aliyun-cs/repair-cluster-node-pool` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | cluster_id | string | yes | The cluster ID | | nodepool_id | string | yes | The node pool ID | | auto_restart | string | no | [Deprecated] Specifies whether to allow instance restart | | nodes | array | no | The list of nodes | | operations | array | no | The repair operations to perform. If not specified, all repair operations are performed by default. In most scenarios, you do not need to… | ### Resumes a paused cluster task `POST https://zieapi.vercel.app/v1/cloud:aliyun-cs/resume-task` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | task_id | string | yes | The task ID | ### If you want to revoke the cluster KubeConfig credential owned by the currently logged-on Alibaba Cloud… `POST https://zieapi.vercel.app/v1/cloud:aliyun-cs/revoke-k8s-cluster-kube-config` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | ClusterId | string | yes | The cluster ID | ### The Container Intelligence O&M platform provides a wide range of Kubernetes cluster check capabilities,… `POST https://zieapi.vercel.app/v1/cloud:aliyun-cs/run-cluster-check` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | cluster_id | string | yes | The cluster ID | | options | object | no | The check options | | target | string | no | The check target. If the check type parameter `type` is set to `NodePoolUpgrade`, this parameter must be set to the node pool ID. If other… | | type | string | yes | The check type | ### Initiates a cluster inspection and creates an inspection report `POST https://zieapi.vercel.app/v1/cloud:aliyun-cs/run-cluster-inspect` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | clusterId | string | yes | The cluster ID | | clientToken | string | no | The idempotence token | ### Executes O&M operations on a node `POST https://zieapi.vercel.app/v1/cloud:aliyun-cs/run-node-operation` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | clusterId | string | yes | The cluster ID | | nodepoolId | string | yes | The node pool ID | | nodeName | string | yes | The node on which the O&M operation is executed | | operationAction | string | yes | The name of the O&M action to execute | | operationArgs | array | no | The list of parameters accepted by the O&M action | ### Scales out a node pool by adding nodes to ensure that the number of nodes is sufficient to support your… `POST https://zieapi.vercel.app/v1/cloud:aliyun-cs/scale-cluster-node-pool` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | ClusterId | string | yes | The cluster ID | | NodepoolId | string | yes | The node pool ID | | count | integer | no | The number of nodes to add. For example, if the node pool currently has 2 nodes and you set this parameter to 2, the node pool will have 4… | ### Scans for potential security vulnerabilities in an ACK cluster, including container workload… `POST https://zieapi.vercel.app/v1/cloud:aliyun-cs/scan-cluster-vuls` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | cluster_id | string | yes | The cluster ID | ### Starts a specified alert rule `POST https://zieapi.vercel.app/v1/cloud:aliyun-cs/start-alert` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | ClusterId | string | yes | The cluster ID. You can call ListClusters to obtain the cluster ID | | alert_rule_group_name | string | no | The alert rule group name | | alert_rule_name | string | no | The alert rule name | ### Stops alert rules in the ACK alert center. You can stop an entire alert rule group or a single alert rule `POST https://zieapi.vercel.app/v1/cloud:aliyun-cs/stop-alert` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | ClusterId | string | yes | The cluster ID. You can call https://help.aliyun.com/document_detail/87116.html to obtain the cluster ID | | alert_rule_group_name | string | no | The alert rule group name | | alert_rule_name | string | no | The alert rule name | ### Synchronizes a cluster node pool, including node pool metadata and node information within the node pool `POST https://zieapi.vercel.app/v1/cloud:aliyun-cs/sync-cluster-node-pool` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | ClusterId | string | yes | The cluster ID | ### Adds tag key-value pairs to clusters so that cluster developers or O&M engineers can more flexibly… `POST https://zieapi.vercel.app/v1/cloud:aliyun-cs/tag-resources` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | region_id | string | yes | The region ID of the resource | | resource_ids | array | yes | The list of resource IDs. You can specify up to 50 resource IDs | | resource_type | string | yes | The resource type. CLUSTER: cluster | | tags | array | yes | The tag key-value pairs of the resource. You can specify up to 20 tag key-value pairs. Note: Once a value is specified, it cannot be an… | ### Uninstalls specified components from a cluster when they are no longer needed. You can call this operation… `POST https://zieapi.vercel.app/v1/cloud:aliyun-cs/un-install-cluster-addons` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | ClusterId | string | yes | The cluster ID | | addons | array | no | The list of components | ### Deletes resource tags when you no longer need the tag key-value pairs of a cluster `POST https://zieapi.vercel.app/v1/cloud:aliyun-cs/untag-resources` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | region_id | string | yes | The region ID of the resource | | resource_ids | string | yes | The list of resource IDs. You can specify up to 50 resource IDs (JSON-encoded) | | resource_type | string | yes | The resource type. CLUSTER: cluster | | tag_keys | string | yes | The list of tag keys for the resource. You can specify up to 20 tag keys (JSON-encoded) | | all | string | no | Specifies whether to delete all custom tags. This parameter takes effect only when `tag_keys` is empty. Valid values: `true`: Deletes all… | ### When you need to record Kubernetes API requests and their results to trace cluster operation history and… `POST https://zieapi.vercel.app/v1/cloud:aliyun-cs/update-cluster-audit-log-config` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | clusterid | string | yes | The cluster ID | | disable | string | no | Specifies whether to disable the cluster audit log feature. Valid values: false: Enables the audit log feature or updates the audit log… | | sls_project_name | string | no | The https://help.aliyun.com/document_detail/48873.html that contains the https://help.aliyun.com/document_detail/48874.html for cluster… | ### Updates the cluster inspection configuration `POST https://zieapi.vercel.app/v1/cloud:aliyun-cs/update-cluster-inspect-config` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | clusterId | string | yes | The cluster ID | | disabledCheckItems | array | no | The list of disabled inspection items | | enabled | string | no | Specifies whether to enable inspection | | scheduleTime | string | no | The inspection schedule defined by using the RFC 5545 Recurrence Rule syntax. You must specify BYHOUR and BYMINUTE. Only FREQ=DAILY is… | ### Updates the contact group for an alert rule set in an ACK cluster `POST https://zieapi.vercel.app/v1/cloud:aliyun-cs/update-contact-group-for-alert` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | ClusterId | string | yes | The cluster ID. You can call the ListCluster operation to obtain the cluster ID | | alert_rule_group_name | string | no | The name of the alert metric contact group | | contact_group_ids | array | no | The list of contact group IDs | | cr_name | string | no | The name of the CR instance | | namespace | string | no | The namespace in which the resource resides | ### ACK managed clusters support collecting control plane component logs and delivering them to your Simple Log… `POST https://zieapi.vercel.app/v1/cloud:aliyun-cs/update-control-plane-log` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | ClusterId | string | yes | The cluster ID | | aliuid | string | no | The Alibaba Cloud account ID | | components | array | no | The list of components for which control plane logging is enabled | | log_project | string | no | The name of the SLS project used to store control plane component logs. Default value: k8s-log-$Cluster ID | | log_ttl | string | no | The log retention period in the SLS Logstore. Valid values: 1 to 3000. Unit: days. Default value: 30 days | ### Updates the custom expiration time of a KubeConfig credential issued by an ACK cluster. The default… `POST https://zieapi.vercel.app/v1/cloud:aliyun-cs/update-k8s-cluster-user-config-expire` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | ClusterId | string | yes | The cluster ID | | expire_hour | integer | yes | The custom expiration time specified by the user. Unit: hours. Valid values: [1, 876000], which indicates a maximum of 100 years | | user | string | yes | The Resource Access Management (RAM) user ID | ### Updates the encryption at rest configuration for Secrets in a specified cluster `POST https://zieapi.vercel.app/v1/cloud:aliyun-cs/update-kmsencryption` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | ClusterId | string | yes | The cluster ID | | disable_encryption | string | no | Specifies whether to disable the encryption at rest feature for Secrets. `true`: Disables the encryption at rest feature. `false`: Enables… | | kms_key_id | string | no | The KMS key ID used for the encryption at rest feature for Secrets. You cannot use a service key. You must use a master key or a customer… | ### Updates a node component `POST https://zieapi.vercel.app/v1/cloud:aliyun-cs/update-node-pool-component` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://cs.ap-southeast-1.aliyuncs.com | | clusterId | string | yes | The cluster ID | | nodepoolId | string | yes | The node pool ID | | config | object | no | The configuration of the node component | | disableRolling | string | no | Specifies whether to disable rolling updates. Default value: false. When set to false, updating the baseline configuration triggers a… | | name | string | no | The name of the node component | | nodeNames | array | no | The list of nodes to include in the rolling update. By default, all nodes are included | | rollingPolicy | object | no | The rolling update configuration | | version | string | no | The version of the node component | …and 8 more. See the OpenAPI spec. ## Example ``` curl "https://zieapi.vercel.app/v1/cloud:aliyun-cs/attach-instances" \ -H "x-api-key: $APIZIE_KEY" \ -H "x-upstream-key: $PROVIDER_KEY" ``` ## FAQ ### How do I call the Alibaba Cloud Container Service for Kubernetes API? Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:aliyun-cs/attach-instances with the header x-api-key. Every endpoint returns { project, data, timestamp }. ### Is the Alibaba Cloud Container Service for Kubernetes API free on Apizie? Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud Container Service for Kubernetes itself also needs your own key from aliyuncs.com. ### Can AI agents use the Alibaba Cloud Container Service for Kubernetes API? Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-cs. ### What is the status of the Alibaba Cloud Container Service for Kubernetes API? Needs your own provider key (bring your own key)