The following tables list the API operations available for use in Container Service for Kubernetes (ACK).
Important Before you call the API operations to manage ACK clusters, make sure that you have read and agree to Before you start.
Clusters
| API | Description: |
|---|---|
| Call the CreateCluster operation to create an ACK dedicated cluster. | |
| Call the CreateCluster operation to create an ACK managed cluster and add a specified number of nodes to the cluster. | |
| Call the CreateCluster operation to create a ASK cluster. | |
| Call the CreateCluster operation to create an ACK edge cluster. | |
Create a dedicated Kubernetes cluster that supports sandboxed containers | Call the CreateCluster operation to create an ACK dedicated cluster that runs sandboxed containers. |
Create an ACK standard cluster that supports sandboxed containers | Call the CreateCluster operation to create an ACK managed cluster that runs sandboxed containers. |
| Call the DescribeClustersV1 operation to query all Swarm clusters and Kubernetes clusters that are created by the current account. | |
| Call the DescribeClusterDetail operation to query the details of a specified ACK cluster by cluster ID. | |
| Call the DescribeClusterResources operation to query all resources in a specified ACK cluster. | |
| Call the DescribeExternalAgent operation to query the agent configurations of a registered cluster. | |
| Call the DescribeClusterLogs operation to query the log of a specified ACK cluster. | |
| Call the DescribeClusterNodes operation to query the nodes in a specified ACK cluster. | |
| DescribeTaskInfo | Call the DescribeTaskInfo operation to query the details of a task by task ID. |
| Call the DescribeClusterUserKubeconfig operation to obtain the kubeconfig file of a specified ACK cluster. The kubeconfig file stores details of the account that is used to log on to the ACK cluster. | |
Query information about a Kubernetes version supported by ACK | Call the DescribeKubernetesVersionMetadata operation to query the details of a specified Kubernetes version that is supported by ACK. |
| Call the DescribeUserQuota operation to query the resource quotas of the current account. | |
| Call the DescribeEvents operation to query the operations performed by users. | |
| Call the AttachInstances operation to add existing Edge Node Service (ENS) instances to a specified ACK edge cluster. | |
| Call the ModifyCluster operation to modify the configurations of a specified ACK cluster. | |
Migrate workloads from an ACK standard cluster to an ACK Pro cluster | Call the MigrateCluster operation to migrate workloads from a standard managed cluster to a professional managed cluster. |
| Call the DeleteCluster operation to delete an ACK cluster by cluster ID and release all nodes in the cluster. | |
| Configure auto scaling | Call the CreateAutoscalingConfig operation to configure auto scaling. |
Permissions
| API | Description: |
|---|---|
| Call the DescribeUserPermission operation to query the permissions that are granted to a specified Resource Access Management (RAM) user to manage ACK clusters. | |
| Call the GrantPermissions operation to grant a specified RAM user the permissions to manage ACK clusters. | |
| Call the UpdateK8sClusterUserConfigExpire operation to renew the kubeconfig file of a cluster. |
Node pools
| API | Description: |
|---|---|
| Call the CreateClusterNodePool operation to create a node pool in a specified ACK cluster. | |
| Call the ModifyClusterNodePool operation to scale a node pool. | |
| Call the ModifyClusterNodePool operation to update the configurations of a specified node pool. | |
| Call the DescribeClusterNodePools operation to query the details of all node pools in a specified ACK cluster. | |
| Call the DescribeClusterNodePoolDetail operation to query the details of a specified node pool in an ACK cluster. | |
| Call the AttachInstances operation to add existing Elastic Compute Service (ECS) instances to a specified ACK cluster. | |
| Call the DescribeClusterAttachScripts operation to add an existing node to a specified ACK edge cluster. This operation returns a unique and executable script. You can run the script on an existing node to add the node to the ACK edge cluster. | |
| Call the RepairClusterNodePool operation to fix issues on nodes in a node pool. | |
| Remove nodes from a node pool | Call the RemoveNodePoolNodes operation to remove specified nodes from an ACK cluster. |
| Delete a node pool | Call the DeleteClusterNodepool operation to delete a node pool. |
Upgrades
| API | Description: |
|---|---|
| Call the UpgradeCluster operation to upgrade an ACK cluster. | |
| Call the GetUpgradeStatus operation to query the upgrade status of an ACK cluster. | |
| Call the PauseClusterUpgrade operation to pause the upgrade of an ACK cluster. | |
| Call the CancelClusterUpgrade operation to cancel the upgrade of an ACK cluster. | |
| Call the ResumeUpgradeCluster operation to resume the upgrade of an ACK cluster. |
Applications
| API | Description: |
|---|---|
| CreateTemplate | Call the CreateTemplate operation to create an application template. |
| DescribeTemplates | Call the DescribeTemplates operation to query application templates. |
| DescribeTemplateAttribute | Call the DescribeTemplateAttribute operation to query the details of a specified application template. |
| Call the UpdateTemplate operation to update an application template. | |
| Call the DeleteTemplate operation to delete a specified application template. | |
| Create an application trigger | Call the CreateTrigger operation to create an application trigger. |
| Query an application trigger | Call the DescribeTrigger operation to query an application trigger. |
| Delete an application trigger | Call DeleteTrigger to delete an application trigger. |
Components
| API | Description: |
|---|---|
| Call the InstallClusterAddons operation to install components in a specified ACK cluster. | |
| Call the DescribeAddons operation to query the details of components that are installed in ACK clusters. | |
| Call the DescribeClusterAddonsVersion operation to query the versions of components in a specified ACK cluster. | |
| Call the DescribeClusterAddonsUpgradeStatus operation to query the upgrade status of multiple components at a time. | |
| Call the DescribeClusterAddonMetadata operation to query the metadata of a specified component version. The metadata includes the component version and available parameters. | |
| Call the ModifyClusterAddon operation to modify the configuration of a component that is installed in a cluster. After you call this operation, the component may be redeployed and restarted. We recommend that you evaluate the impact before you call this operation. | |
| Update a component in a cluster | Call the UpgradeClusterAddons operation to upgrade a component to the specified version in a specified ACK cluster. |
| Call the UnInstallClusterAddons operation to uninstall components from a specified ACK cluster. |
Labels
| API | Description: |
|---|---|
| Call the TagResources operation to add labels to a specified ACK cluster. | |
| Call the ModifyClusterTags operation to modify the labels of a specified ACK cluster. | |
| Call the ListTagResources operation to query the labels of the specified resources. | |
| Call the UntagResources operation to remove labels from a specified ACK cluster. |
Policies
| API | Description: |
|---|---|
| Call the DeployPolicyInstance operation to deploy a policy instance in a specified ACK cluster. | |
| Call the DescribePolicies operation to query policies. | |
| Call the ModifyPolicyInstance operation to update a policy instance in a specified ACK cluster. | |
| Call the DeletePolicyInstance operation to delete policy instances from an ACK cluster. | |
| Call the DescribePolicyDetails to query information about a policy. | |
| Call the DescribePolicyGovernanceInCluster to query information about policies in an ACK cluster. | |
Query a specified policy instance that is deployed in an ACK cluster | Call the DescribePolicyInstances operation to query a specified policy instance that is deployed in an ACK cluster. |
| Call the DescribePolicyInstancesStatus operation to query information about policy instances in a Container Service for Kubernetes (ACK) cluster. The information includes the number of instances deployed from each policy and the number of policy instances of each severity level. |