API standards and multilingual preset SDKs
The OpenAPI of this product (CS/2015-12-15) uses the ROA signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.
Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.
Custom signature scenarios
If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.
Account and security preparation
Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.
API catalog
|
API |
Title |
Description |
| OpenAckService | Activate container service for kubernetes | When you use Container Service for Kubernetes (ACK) for the first time, you must call the OpenAckService operation to activate the service. |
| DescribeRegions | Query regions | Queries the list of regions. |
Cluster
|
API |
Title |
Description |
| CreateCluster | Create a cluster | You can create ACK clusters through OpenAPI, including ACK managed clusters, ACK Serverless clusters, ACK Edge clusters, and registered clusters. When creating a cluster, you will configure the cluster information, cluster components, and ACK-related cloud resources. |
| DeleteCluster | Delete a cluster | If you no longer need a cluster, delete the cluster and choose whether to delete or retain the associated resources. Before you delete a cluster, manually clean up workloads (Deployments, StatefulSets, Jobs, and CronJobs). Otherwise, the cluster deletion may fail. |
| ModifyCluster | Modify Cluster Configuration | You can call the ModifyCluster operation to modify the configuration of an ACK cluster. |
| UpgradeCluster | Upgrade a cluster | To avoid potential security and stability risks of expired cluster versions and to use new features of the latest cluster versions, upgrade your clusters in accordance with the ACK cluster version release schedule. You can call the UpgradeCluster operation to manually upgrade a cluster. |
| DescribeClustersV1 | Query cluster list | You can invoke the DescribeClustersV1 operation to query the list of ACK clusters that meet conditional criteria (such as cluster type and cluster specification) under the current account. |
| DescribeClustersForRegion | Query clusters in a specified region | Queries all clusters in a specified region. |
| DescribeClusterDetail | Query the information of a specified cluster | You can call the DescribeClusterDetail API to query the detailed information of a specified cluster by cluster ID. |
| DescribeClusterResources | Query associated resources of a specified cluster | When you use Container Service for Kubernetes (ACK), you also use resources from other associated Alibaba Cloud services. You can call the DescribeClusterResources operation to query the associated resources of a specified cluster, such as VPCs and SLBs. To query node pool or node resources, call the DescribeClusterNodePools or DescribeClusterNodes operation. |
| DescribeKubernetesVersionMetadata | Query detailed information about Kubernetes versions | You can call the DescribeKubernetesVersionMetadata operation to query detailed information about Kubernetes versions, including version information, release dates and expiration dates, compatible operating systems, and container runtimes. |
| DescribeUserClusterNamespaces | Query namespaces visible to a RAM user or role in a cluster | In ACK clusters, you can use Kubernetes namespaces to achieve logically isolated permissions and resources for cluster users. Users who are granted RBAC permissions only for a specified namespace cannot access resources in other namespaces of the cluster. You can invoke the DescribeUserClusterNamespaces operation to query the namespaces for which the current Resource Access Management (RAM) user or role has been granted RBAC access permissions in a specified ACK cluster. |
| DescribeClusterLogs | Query cluster logs | Retrieves the log data of a cluster for root cause analysis and tracing when cluster issues occur. |
| DescribeUserQuota | Query cluster quotas | Queries the quotas of ACK clusters, node pools, and nodes. To increase a quota, go to Quota Center to submit a request. |
| MigrateCluster | Migrate a basic cluster to pro | ACK ACK clusters are an evolution of ACK Basic clusters, inheriting all the advantages of managed clusters, such as managed control planes and high-availability control planes. ACK ACK clusters further enhance cluster reliability, security, and scheduling capabilities, and support SLAs with compensation standards. ACK ACK clusters are suitable for enterprise customers who run large-scale workloads in production environments and have high requirements for stability and security. You can call the MigrateCluster operation to migrate an ACK Basic cluster to an ACK ACK cluster. |
| DescribeClusterUserKubeconfig | Query cluster kubeConfig | KubeConfig is used to configure access credentials for ACK clusters on the client. It contains identity and authentication data for accessing the target cluster. When you use kubectl for cluster management, you must first connect to the cluster by using KubeConfig. You can invoke the DescribeClusterUserKubeconfig operation to query the KubeConfig of a specified cluster. |
| DescribeSubaccountK8sClusterUserConfig | Obtain the cluster kubeConfig of a specified RAM user or role by using an Alibaba Cloud account | As a cluster permission management administrator, you can use an Alibaba Cloud account to issue KubeConfig credentials that contain identity information for a specified Resource Access Management (RAM) user or RAM role within the account. These credentials are used to connect to ACK clusters. You can invoke the DescribeSubaccountK8sClusterUserConfig operation to issue or retrieve the KubeConfig for any RAM user or role within the account. |
| ListUserKubeConfigStates | Query kubeConfig status list of all clusters for a specified user | Queries the KubeConfig status list of all clusters for the current user. If you want to view the KubeConfig issuance status of each cluster for the current user, you can call this operation to retrieve the KubeConfig status list of all clusters. |
| ListClusterKubeconfigStates | Query the list of issued kubeConfigs for a specified cluster | Queries the list and status of KubeConfigs that have been issued to users in a specified cluster. You can call this operation to view the access control status of the current cluster. |
| UpdateK8sClusterUserConfigExpire | Update the expiration time of user-defined configuration | The default expiration time of the KubeConfig issued by an ACK cluster is 3 years. You can use an Alibaba Cloud account to customize the configuration by invoking the UpdateK8sClusterUserConfigExpire operation to specify the expiration time (1 to 876,000 hours) of the KubeConfig issued to a Resource Access Management (RAM) user or role in an ACK cluster. |
| RevokeK8sClusterKubeConfig | Revoke kubeConfig of the current user | If you want to revoke the cluster KubeConfig credential owned by the currently logged-on Alibaba Cloud account or Resource Access Management (RAM) user, you can call the RevokeK8sClusterKubeConfig operation to revoke it. After the revocation succeeds, the cluster generates a new KubeConfig, and the original KubeConfig becomes invalid. |
| CleanClusterUserPermissions | Clean up kubeConfig credentials and RBAC permissions for a specified user in a specified cluster | Cleans up KubeConfig credentials and RBAC permissions that have been issued to a specified user in a specified cluster. You can call this operation to revoke authorization for KubeConfig credentials that pose security risks. |
| CleanUserPermissions | Clean up issued kubeConfig credentials and RBAC permissions for a specified user across all clusters | Cleans up KubeConfig credentials and revokes RBAC permissions for a specified user. If you want to clean up KubeConfig credentials and revoke authorization for risky users such as those who have left the organization or whose accounts have been frozen, call CleanUserPermissions to clean up the issued KubeConfig credentials and RBAC permissions for the specified user. |
Node pool
|
API |
Title |
Description |
| CreateClusterNodePool | Create a node pool | A node pool is a logical collection of nodes that share the same attributes, allowing unified management and operations such as node upgrades and elastic scaling. You can further use the automated O&M capabilities of node pools, including automatic OS CVE vulnerability patching, automatic faulty node recovery, and automatic kubelet and containerd version upgrades, to reduce O&M costs. You can call CreateClusterNodePool to create a node pool for a cluster. |
| DeleteClusterNodepool | Delete a node pool | Deletes a node pool that is no longer in use. When a node pool is deleted, all pods on the nodes are deleted, which may trigger descheduling. If descheduling cannot be performed, your services may be affected. Make sure that the cluster has sufficient resources for descheduling. |
| DescribeClusterNodePoolDetail | Query node pool configuration | Queries the configuration of a specified node pool in a cluster by node pool ID. |
| DescribeClusterNodePools | Query node pools | Queries all node pools in a cluster. |
| DescribeNodePoolVuls | Query node pool vulnerabilities | Queries the security vulnerability details of a node pool by node pool ID by calling the DescribeNodePoolVuls operation. The details include vulnerability names and severity levels. Regularly scan node pools for security vulnerabilities to improve cluster security. |
| ModifyClusterNodePool | Modify node pool configuration | Modifies the configuration of a node pool by node pool ID by calling the ModifyClusterNodePool operation. |
| ScaleClusterNodePool | Scale out a node pool | Scales out a node pool by adding nodes to ensure that the number of nodes is sufficient to support your workloads. |
| AttachInstancesToNodePool | Add existing nodes to a node pool | Adds existing ECS instances to a node pool in an ACK cluster. You can call this operation to add existing ECS instances as worker nodes to an ACK cluster or to re-add node instances to a node pool after they have been removed. |
| RemoveNodePoolNodes | Remove nodes from a node pool | Removes nodes from a node pool in a cluster and adjusts the expected number of nodes. When removing nodes, you can specify whether to release the associated ECS instances and whether to drain the nodes. Removing nodes involves pod migration, which may affect your services. Perform this operation during off-peak hours and back up your data in advance. |
| UpgradeClusterNodepool | Upgrade a node pool | Upgrades the kubelet version (which should match the control plane version), operating system version, or container runtime version of a specified cluster node pool. |
| RepairClusterNodePool | Repair node pool nodes | Repairs nodes in a cluster node pool. |
| FixNodePoolVuls | Fix node pool vulnerabilities | Alibaba Cloud security products periodically scan ECS nodes for security vulnerabilities and provide corresponding remediation suggestions and methods. Some CVE fixes may require node restarts. Ensure that the cluster has sufficient nodes for drain operations. You can call the FixNodePoolVuls operation to fix node security vulnerabilities in a specified cluster node pool and improve the security of cluster nodes. |
| ModifyNodePoolNodeConfig | Modify node pool node configurations | Modifies the node configurations in a cluster node pool, such as kubelet configurations and rolling update configurations. Modifying node configurations applies changes in batches and restarts kubelet, which may affect node operations and workload execution. Perform this operation during off-peak hours. |
| SyncClusterNodePool | Synchronize a node pool | Synchronizes a cluster node pool, including node pool metadata and information about the nodes in the node pool. |
| DescribeClusterAttachScripts | Query the script for adding existing nodes to a cluster node pool | If you need to add existing ECS instances to an ACK cluster as worker nodes, or re-add node instances to a node pool after they are removed, ACK allows you to manually add existing nodes to a node pool. Calls the DescribeClusterAttachScripts operation to obtain the script for adding existing nodes. |
| CreateAutoscalingConfig | Create an elastic scaling configuration | Creates an elastic scaling configuration that allows the system to automatically increase or decrease compute resources based on the configured scaling rules to meet the workload demands of your cluster. During the creation procedure, you can specify scaling metrics and thresholds, scale-out order, cool-down period, and more. |
Node
|
API |
Title |
Description |
| DescribeClusterNodes | Query cluster nodes | Queries the list of nodes that meet the specified conditions in a cluster. |
| DeleteClusterNodes | Delete cluster nodes | When you no longer need cluster nodes to continue working, you can call the DeleteClusterNodes operation to remove nodes from the cluster. When removing nodes, you can choose whether to simultaneously release the ECS instances and whether to automatically drain the nodes. |
| AttachInstances | Add existing ECS instances to a cluster | Adds existing Elastic Compute Service (ECS) instances to a Container Service for Kubernetes (ACK) cluster. You can call the AttachInstances operation to add ECS instances to an ACK cluster as worker nodes after purchasing the instances, or to re-add node instances to a node pool after they are removed. |
Component
|
API |
Title |
Description |
| InstallClusterAddons | Install cluster components | To enhance Kubernetes capabilities, ACK clusters support various components, such as managed core components, application components, logging and monitoring components, networking components, storage components, and security components. You can call the InstallClusterAddons operation to install components by specifying the component name and version. |
| UnInstallClusterAddons | Uninstall cluster components | Uninstalls specified components from a cluster when they are no longer needed, with the option to delete associated Alibaba Cloud resources. |
| ListAddons | Query available components | Queries the list of available components based on specified parameters such as region, cluster type, cluster subtype (profile), and cluster version. You can also retrieve detailed component information, including whether a component is managed, the schema of supported custom parameters, and compatible operating system architectures. |
| ListClusterAddonInstances | List installed component instances of a cluster | Lists the component instances installed in a specified cluster and queries related information about the component instances, such as the component version and status. |
| GetClusterAddonInstance | Query component instance information in a cluster | Queries the details of a specified component instance in a cluster, including the version, parameter settings, and logging feature status of the component instance. |
| DescribeAddon | Query information about a specified component | You can call the DescribeAddon operation to query information about a specified component based on parameters such as region, cluster type, cluster subtype (profile), cluster version, and component name. The returned information includes whether the component is managed, component category, supported custom parameter schema, compatible OS architectures, and the minimum cluster version required by the component version. |
| ModifyClusterAddon | Modify cluster component instance configuration | Modifies the configuration of an installed cluster component instance. Modifying configurations may affect your services. Evaluate the impact before performing this operation during off-peak hours and back up relevant data in advance. |
| UpgradeClusterAddons | Upgrade cluster component instances | Upgrades the versions of cluster component instances so that you can benefit from the feature optimizations in the new versions. |
| ListClusterAddonInstanceResources | Query resources of a cluster component instance | Queries the list of resources contained in an installed cluster component instance, including Kubernetes cluster resources and Helm release instances. |
Permission
|
API |
Title |
Description |
| DescribeUserPermission | Query cluster authorization information of a RAM user or role | In ACK clusters, you can create and assign different access permissions to different Resource Access Management (RAM) users or roles to ensure secure access control and resource isolation. You can invoke the DescribeUserPermission operation to query the details of cluster permissions granted to a RAM user or role, including accessible resources, permission scope, preset role types, and permission sources. |
| GrantPermissions | Update all RBAC permissions of a RAM user or role | By default, Resource Access Management (RAM) users or roles that are not cluster creators and have not been granted access permissions across all cluster dimensions do not have any RBAC permissions in a cluster. You can invoke the GrantPermissions operation to update the RBAC access permissions of a RAM user or role, including accessible resources, permission scope, and preset role types, to better manage cluster management security and access control. |
| UpdateUserPermissions | Update RBAC permissions of a specified RAM user or role | In an ACK cluster, non-cluster creators, Resource Access Management (RAM) users, and RAM roles have no RBAC permissions by default. You can invoke the UpdateUserPermissions operation to update the RBAC access permissions of a RAM user or role, including accessible resources, permission scope, and preset role types, to better manage cluster management and secure access control. |
| CheckServiceRole | Check service role authorization status | Checks whether the current service account has been granted the specified service role permissions. Container Service for Kubernetes (ACK) can call other cloud services (such as ECS, OSS, NAS, and SLB) that are associated with service roles only after the corresponding role permissions are granted. |
Security
|
API |
Title |
Description |
| ScanClusterVuls | Scan cluster security vulnerabilities | You can call the ScanClusterVuls operation to scan for potential security vulnerabilities in an ACK cluster, including container workload vulnerabilities, third-party software vulnerabilities, CVE vulnerabilities, WebCMS vulnerabilities, and Windows operating system vulnerabilities. Regularly scan your cluster for security vulnerabilities to improve cluster security. |
| DescribeClusterVuls | Query cluster security vulnerability information | You can call the DescribeClusterVuls operation to query the details of security vulnerabilities in a cluster by cluster ID, including vulnerability names, types, and severity levels. Regularly scan your cluster for security vulnerabilities to improve cluster security. |
| UpdateResourcesDeleteProtection | Update the deletion protection status of a specified resource | Updates the deletion protection status of a specified resource. Currently supported resource types include namespaces and services. You can call this operation to enable deletion protection for namespaces or services that involve critical business or sensitive data to avoid maintenance costs caused by accidental deletion. |
| DescribeResourcesDeleteProtection | Query whether deletion protection is enabled for a specified resource | Queries whether deletion protection is enabled for a specified resource in a cluster. Resources that support deletion protection include namespaces and services. |
| DeployPolicyInstance | Deploy a policy instance | Deploys a policy instance in a specified namespace of a specified cluster. You can select a security policy type in an ACK cluster, configure the governance action (alerting or blocking) and the namespace scope for the policy instance to create and deploy a policy instance. |
| ModifyPolicyInstance | Update a policy rule instance | Updates a policy rule instance in a specified cluster. You can modify the governance action (alert or block) and the scope of namespaces to which the policy instance applies. |
| DeletePolicyInstance | Delete a policy rule instance | Deletes a policy rule instance from a specified cluster. |
| DescribePolicies | Query the list of policy governance rule libraries | ACK cluster container security policies provide a comprehensive built-in rule library that includes Compliance, Infra, K8s-general, and PSP categories to ensure the secure operation of containers in production environments. You can call the DescribePolicies operation to query the list of policy governance rule libraries. |
| DescribePolicyDetails | Query details of a specified policy governance rule | ACK cluster container security policies provide a rich set of built-in rule libraries, including Compliance, Infra, K8s-general, and PSP, to ensure the secure operation of containers in production environments. You can call the DescribePolicyDetails operation to query the details of a specified policy governance rule, such as the rule template description, governance action, and governance severity level. |
| DescribePolicyGovernanceInCluster | Query policy governance details of a cluster | ACK cluster container security policies provide a rich set of built-in rule libraries, including Compliance, Infra, K8s-general, and PSP, to ensure the secure operation of containers in production environments. You can call the DescribePolicyGovernanceInCluster operation to query detailed policy governance information for a specified cluster, such as the count of enabled policies at different severity levels, policy governance audit logs, and interception and alert details. |
| DescribePolicyInstances | List policy instances | You can select a security policy type in an ACK cluster, configure the related enforcement actions and scope, and create and deploy a policy instance. You can call the DescribePolicyInstances operation to retrieve the details of specified policy instances in a cluster, such as the policy description and governance level. |
| DescribePolicyInstancesStatus | View policy instance deployment details | Queries the deployment status of policy instances for different policy types in a cluster, including the number of enabled instances for each policy rule and the number of enabled policy types at different governance levels. |
Cluster inspection and diagnostics
|
API |
Title |
Description |
| RunClusterCheck | Initiate a cluster check | The intelligent O&M platform for containers provides a wide range of Kubernetes cluster check capabilities, including cluster upgrade checks, cluster migration checks, component installation checks, component upgrade checks, and node pool checks. Before an upgrade, migration, or installation operation is performed, the platform automatically triggers a check. You can perform the change operation only after the check is passed. You can also manually call the RunClusterCheck operation to perform a cluster check. Periodically check and maintain your clusters to prevent security risks. |
| ListClusterChecks | List all cluster checks | The intelligent O&M platform for containers provides comprehensive Kubernetes cluster check capabilities, including cluster upgrade checks, cluster migration checks, component installation checks, component upgrade checks, and node pool checks. You can call the ListClusterChecks operation to query the list of cluster checks and related information by cluster ID, such as check type, status, creation time, and completion time. |
| GetClusterCheck | Query information about a specified cluster check | The intelligent O&M platform for containers provides comprehensive Kubernetes cluster check capabilities, including cluster upgrade checks, cluster migration checks, component installation checks, component upgrade checks, and node pool checks. You can call the GetClusterCheck operation to query information about a specified check task based on the cluster ID and check task ID, such as the check status, specific check items, and check creation and completion time. |
| CreateClusterInspectConfig | Create cluster inspection configuration | Creates a cluster inspection configuration. |
| UpdateClusterInspectConfig | Update cluster inspection configuration | Updates the cluster inspection configuration. |
| GetClusterInspectConfig | Retrieve cluster inspection configuration | Retrieves the inspection configuration of a cluster. |
| RunClusterInspect | Create a cluster inspection report | Initiates a cluster inspection and creates an inspection report. |
| ListClusterInspectReports | Retrieve cluster inspection report list | Retrieves a list of cluster inspection reports. |
| GetClusterInspectReportDetail | Get cluster inspection report details | Retrieves the details of a cluster inspection report. |
| DeleteClusterInspectConfig | Delete a cluster inspection configuration | Deletes a cluster inspection configuration. |
| CreateClusterDiagnosis | Initiate cluster diagnosis | Initiates a cluster diagnosis. |
| GetClusterDiagnosisResult | Query cluster diagnosis result | Retrieves the diagnosis result of a cluster. |
| GetClusterDiagnosisCheckItems | Query cluster diagnostic check items | Retrieves the diagnostic check items of a cluster. |
Orchestration template
|
API |
Title |
Description |
| CreateTemplate | Create an orchestration template | An orchestration template defines and describes a set of Kubernetes cluster resources in a declarative manner, specifying how applications should run or be configured. You can use these templates to automate the deployment and cluster management of resources, such as Pods, Services, Deployments, ConfigMaps, and PersistentVolumes. You can invoke the CreateTemplate operation to create an orchestration template. |
| DescribeTemplateAttribute | Query details of a specified orchestration template | An orchestration template defines and describes a set of Kubernetes cluster resources in a declarative manner, specifying how applications should run or be configured. You can call the DescribeTemplateAttribute operation to query the details of a specified orchestration template, including access permissions, YAML content, and labels. |
| DescribeTemplates | Query all orchestration templates | An orchestration template defines and describes a set of Kubernetes cluster resources in a declarative manner, specifying how applications should run or be configured. You can call the DescribeTemplates operation to retrieve a list of created orchestration templates and query detailed information about the templates, including access permissions, YAML content, and tags. |
| UpdateTemplate | Update an orchestration template | An orchestration template defines and describes a set of Kubernetes cluster resources in a declarative manner, specifying how applications should run or be configured. Calls the UpdateTemplate operation to update an orchestration template configuration. |
| DeleteTemplate | Delete an orchestration template | Deletes an orchestration template when you no longer need it. |
Trigger
|
API |
Title |
Description |
| CreateTrigger | Create a trigger | Configures a trigger for a cluster application. The trigger redeploys pods when specified conditions are met. |
| DeleteTrigger | Delete a trigger | Deletes an application trigger when it is no longer needed. |
| DescribeTrigger | Query triggers | Queries triggers that meet the specified conditions. |
Tag
|
API |
Title |
Description |
| ListTagResources | Query the tag list of a cluster | You can add tag key-value pairs to clusters so that cluster developers or O&M engineers can classify and manage clusters more flexibly, and better support requirements such as monitoring, cost analysis, and multi-tenant data isolation. You can call the ListTagResources operation to obtain a list of resource tags and query detailed tag information, such as key-value pairs and associated clusters. |
| TagResources | Attach tags to a cluster | Adds tag key-value pairs to clusters so that cluster developers or O&M engineers can categorize and manage clusters more flexibly, and better support monitoring, cost analysis, and tenant isolation requirements. You can call the TagResources operation to attach tags to clusters. |
| UntagResources | Delete cluster tags | Deletes resource tags when you no longer need the tag key-value pairs for a cluster. You can call the UntagResources operation to delete resource tags. |
| ModifyClusterTags | Update all cluster tags | You can add tag key-value pairs to clusters so that cluster developers or O&M engineers can categorize and manage clusters more flexibly, and better support requirements such as monitoring, cost analysis, and tenant isolation. You can call the ModifyClusterTags operation to modify cluster tags. |
Alert
|
API |
Title |
Description |
| StartAlert | Start an alert rule | Starts a specified alert rule. |
| UpdateContactGroupForAlert | Update alert metric contact group | Updates the contact group for an alert rule set in an ACK cluster. |
| StopAlert | Stop alert rules | Stops alert rules in the ACK alert center. You can stop an entire alert rule group or a single alert rule. |
| DeleteAlertContact | Delete alert contacts | Deletes alert contacts from ACK. |
| DeleteAlertContactGroup | Delete alert contact group | Delete ACK alert contact group |
Log
|
API |
Title |
Description |
| UpdateControlPlaneLog | Update control plane component log configuration of an ACK managed cluster | ACK managed clusters support collecting control plane component logs and delivering them to your Simple Log Service (SLS) Log Project. Control plane components include Kube API Server, Kube Scheduler, Kube Controller Manager, Cloud Controller Manager, and other core components. You can call the UpdateControlPlaneLog operation to modify the control plane component log configuration, such as the log retention period and the components from which logs are collected. |
| CheckControlPlaneLogEnable | Query log configuration of control plane components for an ACK managed cluster | Queries the log configuration of control plane components for an ACK managed cluster. Control plane components include Kube API Server, Kube Scheduler, Kube Controller Manager, and Cloud Controller Manager. You can call the CheckControlPlaneLogEnable operation to query the current log configuration of control plane components, including the log retention period and the components from which logs are collected. |
| GetClusterAuditProject | Query the SLS project for cluster API server audit logs | Queries whether the API server audit feature is enabled for a cluster and retrieves the Simple Log Service (SLS) project that stores the API server audit logs. |
| UpdateClusterAuditLogConfig | Update cluster audit log configuration | When you need to record Kubernetes API requests and their results to trace cluster operation history or troubleshoot cluster issues, you can invoke the UpdateClusterAuditLogConfig operation to enable or shutdown the audit log feature for a specified ACK cluster and update the audit log configuration. |
Event
|
API |
Title |
Description |
| DescribeEventsForRegion | Query events in a specified region | Queries all events in a specified region. |
| DescribeEvents | Query event details | Cluster operation events include cluster creation, cluster modification, node pool creation, node pool scale-out, addon installation, and cluster upgrade. You can call the DescribeEvents operation to query the details of a specific type of event, including the event level, event status, and event time. |
| DescribeClusterEvents | Query events of a specified cluster | Cluster operation events include cluster creation, cluster modification, node pool creation, node pool scale-out, addon installation, and cluster upgrade. You can call the DescribeClusterEvents operation to retrieve the list of events that occurred in a specified cluster and query event details, including the event level, event status, and event time. |
Task
|
API |
Title |
Description |
| DescribeTaskInfo | Query task details | Queries the details of a cluster task, such as the task type, running status, and running stage. |
| PauseTask | PauseTask | You can call the PauseTask operation to pause a running cluster task. |
| ResumeTask | Resume a task | Resumes a paused cluster task. |
| CancelTask | Cancel a task | Cancels the execution of a cluster task. |
| DescribeClusterTasks | Query cluster tasks | Queries the task list of a cluster by calling the DescribeClusterTasks operation. |
O&M plan
|
API |
Title |
Description |
| ListOperationPlansForRegion | Query automated O&M execution plans in a specified region | Queries the most recent 100 automated O&M execution plans in a specified region. When features such as cluster intelligent managed mode (Auto Mode), automatic cluster upgrade, or node pool automated O&M are enabled, you can call this operation to query the O&M plans automatically generated by the system and their execution status, such as cluster upgrades and node pool CVE fixes. |
| ListOperationPlans | Query automated O&M execution plans | Retrieves a list of automated O&M execution plans. |
| CancelOperationPlan | Cancel an automated O&M task execution plan | Cancels an existing but unexecuted automated O&M task execution plan by calling CancelOperationPlan. |
Other
|
API |
Title |
Description |
| GetUpgradeStatus | (Deprecated) Query cluster upgrade status | Queries the upgrade status of a cluster by cluster ID. |
| PauseClusterUpgrade | (Deprecated) Pause a cluster upgrade | Pauses a cluster upgrade. |
| CancelClusterUpgrade | Cancel cluster upgrade (deprecated) | Cancels the upgrade of an ACK cluster that is in the upgrading state. |
| ResumeUpgradeCluster | (Deprecated) Resume cluster upgrade | Resumes the upgrade of a cluster that is in the upgrade-paused state based on the cluster ID. |
| DescribeAddons | (Deprecated) Query cluster component details | Queries the details of all components supported by the platform. |
| DescribeClusterAddonsVersion | (Deprecated) Query Cluster Component Versions | Queries the details of all installed components in a cluster by cluster ID. |
| DescribeClusterAddonInstance | (Deprecated) Query cluster component instance information | Calls DescribeClusterAddonInstance to query information about an installed cluster component, such as its version, status, and configuration. |
| DescribeClusterAddonMetadata | (Deprecated) Query cluster component metadata | Queries the version information of a specified component that can be used in a specific cluster, including the component version and configurable parameters. |
| DescribeClusterAddonsUpgradeStatus | (Deprecated) Query cluster component upgrade status | Queries the upgrade status of a component by component name. |
| UpdateNodePoolComponent | Update node component | Updates a node component. |
| InstallNodePoolComponents | Install node components | Installs components on nodes. You can configure and specify nodes on which to install components. |
| UpdateKMSEncryption | Update secret encryption at rest configuration | Updates the Secret encryption at rest configuration for a specified cluster by cluster ID. |
| CreateAutoRepairPolicy | Create a self-healing rule | Creates a self-healing rule. |
| DeleteAutoRepairPolicy | Delete an automatic fault recovery rule | Deletes an automatic fault recovery rule. |
| ModifyAutoRepairPolicy | Modify a self-healing rule | Modifies a self-healing rule. |
| DescribeAutoRepairPolicy | DescribeAutoRepairPolicy | Queries an auto-repair rule. |
| ListAutoRepairPolicies | Get the list of auto-repair policies | Retrieves the list of auto-repair policies. |