All Products
Search
Document Center

:List of operations by function

更新時間:Jan 16, 2024

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 Usage notes and instructions on high-risk operations.

Clusters

API

Description:

Create an ACK dedicated cluster

Call the CreateCluster operation to create an ACK dedicated cluster.

Create an ACK managed cluster

Call the CreateCluster operation to create an ACK managed cluster and add a specified number of nodes to the cluster.

Create an ACK Serverless cluster

Call the CreateCluster operation to create an ACK Serverless cluster.

Create an ACK Edge 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 basic cluster that supports sandboxed containers

Call the CreateCluster operation to create an ACK managed cluster that runs sandboxed containers.

Query a list of ACK clusters

Call the DescribeClustersV1 operation to query all Swarm clusters and Kubernetes clusters that are created by the current account.

DescribeClusterDetail

Call the DescribeClusterDetail operation to query the details of a specified ACK cluster by cluster ID.

Query resources in a cluster

Call the DescribeClusterResources operation to query all resources in a specified ACK cluster.

Query the agent of a cluster

Call the DescribeExternalAgent operation to query the agent configurations of a registered cluster.

DescribeClusterLogs

Call the DescribeClusterLogs operation to query the log of a specified ACK cluster.

Query nodes in a 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.

Query the kubeconfig file of a cluster

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.

DescribeKubernetesVersionMetadata

Call the DescribeKubernetesVersionMetadata operation to query the details of a specified Kubernetes version that is supported by ACK.

Query resource quotas

Call the DescribeUserQuota operation to query the resource quotas of the current account.

Query events in a cluster

Call the DescribeEvents operation to query the operations performed by users.

Add existing ENS nodes to a managed edge Kubernetes cluster

Call the AttachInstances operation to add existing Edge Node Service (ENS) instances to a specified ACK Edge cluster.

Modify cluster configurations

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.

Delete a 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:

Query the permissions that are granted to a RAM user or RAM role to manage ACK clusters

Call the DescribeUserPermission operation to query the permissions that are granted to a specified Resource Access Management (RAM) user to manage ACK clusters.

GrantPermissions

Call the GrantPermissions operation to grant a specified RAM user the permissions to manage ACK clusters.

Renew the kubeconfig file of a cluster

Call the UpdateK8sClusterUserConfigExpire operation to renew the kubeconfig file of a cluster.

Node pools

API

Description:

Create a node pool

Call the CreateClusterNodePool operation to create a node pool in a specified ACK cluster.

Scale a node pool

Call the ModifyClusterNodePool operation to scale a node pool.

Modify the configurations of a node pool

Call the ModifyClusterNodePool operation to update the configurations of a specified node pool.

Query node pools

Call the DescribeClusterNodePools operation to query the details of all node pools in a specified ACK cluster.

Query the details of a node pool

Call the DescribeClusterNodePoolDetail operation to query the details of a specified node pool in an ACK cluster.

Manually add an existing instance to a specified node pool

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.

Fix issues on nodes in a node pool

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:

UpgradeCluster

Call the UpgradeCluster operation to upgrade an ACK cluster.

Query the update status of a cluster

Call the GetUpgradeStatus operation to query the upgrade status of an ACK cluster.

PauseClusterUpgrade

Call the PauseClusterUpgrade operation to pause the upgrade of an ACK cluster.

CancelClusterUpgrade

Call the CancelClusterUpgrade operation to cancel the upgrade of an ACK cluster.

ResumeUpgradeCluster

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.

UpdateTemplate

Call the UpdateTemplate operation to update an application template.

DeleteTemplate

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:

Install a component in an ACK cluster

Call the InstallClusterAddons operation to install components in a specified ACK cluster.

DescribeAddons

Call the DescribeAddons operation to query the details of components that are installed in ACK clusters.

Query components

Call the DescribeClusterAddonsVersion operation to query the versions of components in a specified ACK cluster.

DescribeClusterAddonsUpgradeStatus

Call the DescribeClusterAddonsUpgradeStatus operation to query the upgrade status of multiple components at a time.

Query the metadata of a specified component version

Call the DescribeClusterAddonMetadata operation to query the metadata of a specified component version. The metadata includes the component version and available parameters.

Modify the configurations of a component

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.

UnInstallClusterAddons

Call the UnInstallClusterAddons operation to uninstall components from a specified ACK cluster.

Labels

API

Description:

TagResources

Call the TagResources operation to add labels to a specified ACK cluster.

ModifyClusterTags

Call the ModifyClusterTags operation to modify the labels of a specified ACK cluster.

Query the labels of specified resources

Call the ListTagResources operation to query the labels of the specified resources.

Removes the labels of specified ACK clusters

Call the UntagResources operation to remove labels from a specified ACK cluster.

Policies

API

Description:

Deploy a policy instance in a specified ACK cluster

Call the DeployPolicyInstance operation to deploy a policy instance in a specified ACK cluster.

Query policies

Call the DescribePolicies operation to query policies.

Update a policy instance in a specified ACK cluster

Call the ModifyPolicyInstance operation to update a policy instance in a specified ACK cluster.

Delete policy instances from a specified ACK cluster

Call the DeletePolicyInstance operation to delete policy instances from an ACK cluster.

Query information about a policy

Call the DescribePolicyDetails to query information about a policy.

Query information about policies in an ACK cluster

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.

Query information about policy instances 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.