This product(
CS/2015-12-15
) OpenAPI adopts ROA Signature style. See signature details in Description of the signature mechanism. We have packaged SDKs for common programming languages for developers. Developers can directly call the OpenAPI of this product by downloading the SDK without paying attention to the technical details. If the existing SDK cannot meet the usage requirements, you can connect through the signature mechanism. It will take about 5 working days. Therefore, it is recommended to join our DingTalk service group (11370001915) and sign under the guidance of experts. Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (SDK, CLI, etc.). For details see getAccessKey.
API catalog
API | Title | Description |
---|---|---|
OpenAckService | OpenAckService | You can call the OpenAckService operation to activate Container Service for Kubernetes (ACK). |
Cluster
API | Title | Description |
---|---|---|
CreateCluster | CreateCluster | Creates a Container Service for Kubernetes (ACK) cluster. For example, you can create an ACK managed cluster, ACK dedicated cluster, ACK Serverless cluster, ACK Edge cluster, or registered cluster. When you create an ACK cluster, you need to configure the cluster information, components, and cloud resources used by ACK. |
DeleteCluster | DeleteCluster | You can call the DeleteCluster operation to delete a cluster by cluster ID and release all nodes in the cluster. |
DescribeClustersV1 | DescribeClustersV1 | You can call the DescribeClustersV1 operation to query the details about all Container Service for Kubernetes (ACK) clusters. |
DescribeClusterDetail | DescribeClusterDetail | You can call the DescribeClusterDetail operation to query the details of a Container Service for Kubernetes (ACK) cluster by cluster ID. |
DescribeClusterResources | DescribeClusterResources | You can call the DescribeClusterResources operation to query all resources in a cluster by cluster ID. |
DescribeKubernetesVersionMetadata | DescribeKubernetesVersionMetadata | Queries the detailed information about Kubernetes versions, including the version number, release date, expiration date, compatible OSs, and runtime. |
DescribeUserClusterNamespaces | DescribeUserClusterNamespaces | Queries the Role-Based Access Control (RBAC) permissions that are granted to the current Resource Access Management (RAM) user or RAM role on a Container Service for Kubernetes (ACK) cluster. You can use Kubernetes namespaces to limit users from accessing resources in an ACK cluster. Users that are granted RBAC permissions only on one namespace cannot access resources in other namespaces. |
DescribeClusterLogs | DescribeClusterLogs | Queries the cluster log to help analyze cluster issues and locate the cause. |
RunClusterCheck | RunClusterCheck | You can call the RunClusterCheck operation to initiate cluster checks, such as cluster update prechecks. |
ListClusterChecks | ListClusterChecks | Queries the cluster check results of a Container Service for Kubernetes (ACK) cluster by specifying the ID of the cluster. For example, you can view the check method, status, start time, and end time of a cluster check task. Container Intelligence Service (CIS) provides a variety of cluster check capabilities to allow you to perform cluster update check, cluster migration check, component installation check, component update check, and node pool check. |
GetClusterCheck | GetClusterCheck | Queries a cluster check task by cluster ID and task ID. You can view the status, check items, creation time, and end time of the task. Container Intelligence Service (CIS) provides a variety of Kubernetes cluster check features, including cluster update check, cluster migration check, component installation check, component update check, and node pool check. |
ModifyCluster | ModifyCluster | You can call the ModifyCluster operation to modify the cluster configurations by cluster ID. |
MigrateCluster | MigrateCluster | Container Service for Kubernetes (ACK) Pro clusters are developed based on ACK Basic clusters. ACK Pro clusters provide all benefits of ACK managed clusters, such as fully-managed control planes and control plane high availability. In addition, ACK Pro clusters provide you with enhanced reliability, security, and schedulability. ACK Pro clusters are covered by the SLA that supports compensation clauses. ACK Pro clusters are suitable for large-scale businesses that require high stability and security in production environments. We recommend that you migrate from ACK Basic clusters to ACK Pro clusters. |
DescribeClusterUserKubeconfig | DescribeClusterUserKubeconfig | Kubeconfig files store identity and authentication information that is used by clients to access Container Service for Kubernetes (ACK) clusters. To use a kubectl client to manage an ACK cluster, you need to use the corresponding kubeconfig file to connect to the ACK cluster. We recommend that you keep kubeconfig files confidential and revoke kubeconfig files that are not in use. This helps prevent data leaks caused by the disclosure of kubeconfig files. |
DescribeSubaccountK8sClusterUserConfig | DescribeSubaccountK8sClusterUserConfig | You can use an Alibaba Cloud account to call the DescribeSubaccountK8sClusterUserConfig operation to obtain the cluster kubeconfig file of a RAM user or RAM role. |
UpdateK8sClusterUserConfigExpire | UpdateK8sClusterUserConfigExpire | Sets the validity period of a kubeconfig file used by a Resource Access Management (RAM) user or RAM role to connect to a Container Service for Kubernetes (ACK) cluster. The validity period ranges from 1 to 876,000 hours. You can call this API operation when you customize configurations by using an Alibaba Cloud account. The default validity period of a kubeconfig file is three years. |
ScanClusterVuls | ScanClusterVuls | Scans for vulnerabilities in a Container Service for Kubernetes (ACK) cluster, including workload vulnerabilities, third-party software vulnerabilities, CVE vulnerabilities, WebCMS vulnerabilities, and Windows vulnerabilities. We recommend that you scan your cluster on a regular basis to ensure cluster security. |
DescribeClusterVuls | DescribeClusterVuls | You can call the DescribeClusterVuls operation to query the vulnerability information of a cluster. |
Node Pool
API | Title | Description |
---|---|---|
CreateClusterNodePool | CreateClusterNodePool | You can call the CreateClusterNodePool operation to create a node pool for a Container Service for Kubernetes (ACK) cluster. |
DeleteClusterNodepool | DeleteClusterNodepool | null |
DescribeClusterNodePoolDetail | DescribeClusterNodePoolDetail | You can call the DescribeClusterNodePoolDetail.html operation to query the details about a node pool in a cluster by node pool ID. |
DescribeClusterNodePools | DescribeClusterNodePools | You can call the DescribeClusterNodePools operation to query node pools in a Container Service for Kubernetes (ACK) cluster. |
DescribeNodePoolVuls | DescribeNodePoolVuls | Queries the vulnerability information of a node pool, such as vulnerability names and severity levels, by specifying the ID of the node pool. We recommend that you periodically scan node pools for vulnerabilities to enhance cluster security. |
ModifyClusterNodePool | ModifyClusterNodePool | You can call the ModifyClusterNodePool operation to modify the configuration of a node pool. |
ScaleClusterNodePool | ScaleClusterNodePool | You can call the ScaleClusterNodePool operation to scale out a node pool by node pool ID. |
AttachInstancesToNodePool | AttachInstancesToNodePool | You can call the AttachInstancesToNodePool operation to add existing nodes to a node pool. |
RemoveNodePoolNodes | RemoveNodePoolNodes | Removes nodes from a node pool. |
UpgradeClusterNodepool | UpgradeClusterNodepool | You can call the UpgradeClusterNodepool operation to update the Kubernetes version, OS version, or container runtime version of the nodes in a node pool. |
RepairClusterNodePool | RepairClusterNodePool | You can call the RepairClusterNodePool operation to fix issues on specified nodes in a managed node pool. |
FixNodePoolVuls | FixNodePoolVuls | Patches node vulnerabilities in a node pool to enhance node security. Cloud Security provided by Alibaba Cloud periodically scans Elastic Compute Service (ECS) instances for vulnerabilities and provides suggestions on how to patch the detected vulnerabilities. Vulnerability patching may require node restarts. Make sure that your cluster has sufficient idle nodes for node draining. |
ModifyNodePoolNodeConfig | ModifyNodePoolNodeConfig | Modifies the configuration of a node pool, such as the kubelet configuration and node rolling update configuration. After you modify the node pool configuration, nodes are batch updated and the kubelet on each node is restarted. This may adversely affect the nodes and workloads. We recommend that you perform this operation during off-peak hours. |
SyncClusterNodePool | SyncClusterNodePool | Synchronizes the information about a node pool, including the metadata and node information of the node pool. |
DescribeClusterAttachScripts | DescribeClusterAttachScripts | Queries the script that is used to add existing nodes to a Container Service for Kubernetes (ACK) cluster. You can manually add existing Elastic Compute Service (ECS) instances to an ACK cluster as worker nodes or re-add the worker nodes that you have removed to a node pool. |
CreateAutoscalingConfig | CreateAutoscalingConfig | Creates a scaling configuration to allow the system to scale resources based on the given scaling rules. When you create a scaling configuration, you can specify the scaling metrics, thresholds, scaling order, and scaling interval. |
Node
API | Title | Description |
---|---|---|
DescribeClusterNodes | DescribeClusterNodes | null |
DeleteClusterNodes | DeleteClusterNodes | Removes nodes from a Container Service for Kubernetes (ACK) cluster. When you remove nodes, you can specify whether to release the Elastic Compute Service (ECS) instances and drain the nodes. When you remove nodes, pods on the nodes are migrated. This may adversely affect your businesses. We recommend that you back up data and perform this operation during off-peak hours. |
Add-ons
API | Title | Description |
---|---|---|
InstallClusterAddons | InstallClusterAddons | Installs a component by specifying the name and version of the component. To enhance Kubernetes capabilities, you can install a variety of components in Container Service for Kubernetes (ACK) clusters, such as fully-managed core components and application, logging and monitoring, network, storage, and security group components. |
UnInstallClusterAddons | UnInstallClusterAddons | You can call the UnInstallClusterAddons operation to uninstall the components in a cluster by component names. |
DescribeAddons | DescribeAddons | You can call the DescribeAddons operation to query the details about all components that are supported by Container Service for Kubernetes (ACK). |
DescribeClusterAddonsVersion | DescribeClusterAddonsVersion | You can call the DescribeClusterAddonsVersion operation to query the details about all components in a cluster by cluster ID. |
DescribeClusterAddonInstance | DescribeClusterAddonInstance | You can call the DescribeClusterAddonInstance operation to query the information about a cluster component, including the version, status, and configuration of the component. |
ModifyClusterAddon | ModifyClusterAddon | Modifies the configuration of a cluster component. This operation may affect your businesses. We recommend that you assess the impact, back up data, and perform the operation during off-peak hours. |
DescribeClusterAddonMetadata | DescribeClusterAddonMetadata | You can call the DescribeClusterAddonMetadata operation to query the metadata of a component version. The metadata includes the component version and available parameters. |
UpgradeClusterAddons | UpgradeClusterAddons | Updates cluster components to use new features and patch vulnerabilities. You must update cluster components one after one and update a component only after the previous one is successfully updated. Before you update a component, we recommend that you read the update notes for each component. Cluster component updates may affect your businesses. Assess the impact, back up data, and perform the update during off-peak hours. |
DescribeClusterAddonsUpgradeStatus | DescribeClusterAddonsUpgradeStatus | You can call the DescribeClusterAddonsUpgradeStatus operation to query the update progress of a component by component name. |
Upgrade
API | Title | Description |
---|---|---|
UpgradeCluster | UpgradeCluster | You can call the UpgradeCluster operation to upgrade a cluster by cluster ID. |
GetUpgradeStatus | GetUpgradeStatus | You can call the GetUpgradeStatus operation to query the update progress of a cluster by cluster ID. |
PauseClusterUpgrade | PauseClusterUpgrade | You can call the PauseClusterUpgrade operation to pause the update of a Container Service for Kubernetes (ACK) cluster. |
CancelClusterUpgrade | CancelClusterUpgrade | You can call the CancelClusterUpgrade operation to cancel the update of a cluster. |
ResumeUpgradeCluster | ResumeUpgradeCluster | You can call the ResumeUpgradeCluster operation to resume the update of a cluster by cluster ID. |
Permissions
API | Title | Description |
---|---|---|
DescribeUserPermission | DescribeUserPermission | You can call the DescribeUserPermission operation to query the permissions that are granted to a RAM user to manage clusters. |
GrantPermissions | GrantPermissions | You can call the GrantPermissions operation to grant a Resource Access Management (RAM) user the permissions to manage Container Service for Kubernetes (ACK) clusters. |
Template
API | Title | Description |
---|---|---|
CreateTemplate | CreateTemplate | Creates an orchestration template. An orchestration template defines and describes a group of Kubernetes resources. It declaratively describes the configuration of an application or how an application runs. You can use orchestration templates to manage resources in Kubernetes clusters and automate resource deployment, such as pods, Services, Deployments, ConfigMaps, and persistent volumes (PVs). |
DescribeTemplateAttribute | DescribeTemplateAttribute | An orchestration template defines and describes a group of Kubernetes resources. It declaratively describes the configuration of an application or how an application runs. You can call the DescribeTemplates API operation to query orchestration templates and their detailed information, including access permissions, YAML content, and labels. |
DescribeTemplates | DescribeTemplates | An orchestration template defines and describes a group of Kubernetes resources. It declaratively describes the configuration of an application or how an application runs. You can call the DescribeTemplates API operation to query orchestration templates and their detailed information, including access permissions, YAML content, and labels. |
UpdateTemplate | UpdateTemplate | You can call the UpdateTemplate operation to update an orchestration template by template ID. |
DeleteTemplate | DeleteTemplate | You can call the DeleteTemplate operation to delete an orchestration template by template ID. |
Trigger
API | Title | Description |
---|---|---|
CreateTrigger | CreateTrigger | You can call the CreateTrigger operation to create a trigger for an application. |
DeleteTrigger | DeleteTrigger | You can call the DeleteTrigger operation to delete an application trigger. |
DescribeTrigger | DescribeTrigger | You can call the DescribeTrigger operation to query triggers. |
Labels
API | Title | Description |
---|---|---|
ListTagResources | ListTagResources | Queries resource labels and the detailed information, such as the key-value pairs of the labels and the clusters to which the labels are added. You can use labels to classify and manage Container Service for Kubernetes (ACK) clusters in order to meet monitoring, cost analysis, and tenant isolation requirements. |
TagResources | TagResources | Adds labels to a Container Service for Kubernetes (ACK) cluster. You can use labels to classify and manage ACK clusters in order to meet monitoring, cost analysis, and tenant isolation requirements. |
UntagResources | UntagResources | Removes labels from a Container Service for Kubernetes (ACK) cluster. |
ModifyClusterTags | ModifyClusterTags | Modifies the labels of a Container Service for Kubernetes (ACK) cluster. You can use labels (key-value pairs) to classify and manage ACK clusters in order to meet monitoring, cost analysis, and tenant isolation requirements. |
Logs
API | Title | Description |
---|---|---|
UpdateControlPlaneLog | UpdateControlPlaneLog | You can call the UpdateControlPlaneLog operation to modify the log collection configurations for control plane components in a Container Service for Kubernetes (ACK) managed cluster. |
CheckControlPlaneLogEnable | CheckControlPlaneLogEnable | Queries the current log configuration of control plane components, including the log retention period and the log collection component. Container Service for Kubernetes (ACK) managed clusters can collect the logs of control plane components and deliver the logs to projects in Simple Log Service. These control plane components include Kube API Server, Kube Scheduler, Kube Controller Manager, and Cloud Controller Manager. |
Event
API | Title | Description |
---|---|---|
DescribeEvents | DescribeEvents | Queries detailed information about a type of events, including the severity level, status, and start time of each event. Events are generated when clusters are created, modified, and updated, node pools are created and scaled out, and components are installed. |
DescribeClusterEvents | DescribeClusterEvents | Queries events and event details in a Container Service for Kubernetes (ACK) cluster, including the severity level, status, and start time of each event. Events are generated when clusters created, modified, and updated, node pools are created and scaled out, and components are installed. |
Task
API | Title | Description |
---|---|---|
DescribeTaskInfo | DescribeTaskInfo | Queries detailed information about a task, such as the task type, status, and progress. |
PauseTask | PauseTask | Pauses an on-going task. |
ResumeTask | ResumeTask | Resumes a task. |
CancelTask | CancelTask | You can call the CancelTask operation to cancel a task. |
DescribeClusterTasks | DescribeClusterTasks | Queries tasks in a Container Service for Kubernetes (ACK) cluster. |
Policies
API | Title | Description |
---|---|---|
DeletePolicyInstance | DeletePolicyInstance | Deletes policy instances in a Container Service for Kubernetes (ACK) cluster. |
ModifyPolicyInstance | ModifyPolicyInstance | You can call the ModifyPolicyInstance operation to update policy instances in a Container Service for Kubernetes (ACK) cluster. |
DescribePolicies | DescribePolicies | You can call the DescribePolicies operation to query a list of policies. |
DescribePolicyDetails | DescribePolicyDetails | You can call the DescribePolicyDetails operation to query information about a policy. |
DescribePolicyGovernanceInCluster | DescribePolicyGovernanceInCluster | You can call the DescribePolicyGovernanceInCluster operation to query information about policies in a Container Service for Kubernetes (ACK) cluster. |
DescribePolicyInstances | DescribePolicyInstances | Queries the detailed information about policy instances of the specified type in a Container Service for Kubernetes (ACK) cluster, such as the policy description and severity level. You can choose a type of security policy for an ACK cluster, specify the action and applicable scope of the policy, and then create and deploy a policy instance. |
DescribePolicyInstancesStatus | DescribePolicyInstancesStatus | Queries the deployment of policy instances in the current Container Service for Kubernetes (ACK) cluster, including the number of policy instances of each type and the number of policy types of each severity level. |
DeployPolicyInstance | DeployPolicyInstance | You can call the DeployPolicyInstance operation to deploy a policy instance in a cluster. |
Others
API | Title | Description |
---|---|---|
DescribeUserQuota | DescribeUserQuota | Queries quotas related to Container Service for Kubernetes (ACK) clusters, node pools, and nodes. To increase a quota, submit an application in the Quota Center console. |