- Release Notes and Announcements
- Beginner’s Guide
- Product Introduction
- Purchase Guide
- Quick Start
- User Guide
- High-risk Operations of Container Service
- Deploying Containerized Applications in the Cloud
- Kubernetes API Operation Guide
- Open Source Components
- Cluster Management
- Cluster Overview
- Cluster Hosting Modes Introduction
- Cluster Lifecycle
- TKE-Optimized Series Images
- Creating a Cluster
- Deleting a Cluster
- Cluster Scaling
- Changing the Cluster Operating System
- Connecting to a Cluster
- Upgrading a Cluster
- Enabling IPVS for a Cluster
- Enabling GPU Scheduling for a Cluster
- Custom Kubernetes Component Launch Parameters
- Node Management
- Node Pool Management
- Kubernetes Object Management
- Overview
- Namespace
- Workload
- Deployment Management
- StatefulSet Management
- DaemonSet Management
- Job Management
- CronJob Management
- Setting the Resource Limit of Workload
- Setting the Scheduling Rule for a Workload
- Setting the Health Check for a Workload
- Setting the Run Command and Parameter for a Workload
- Using a Container Image in a TCR Enterprise Instance to Create a Workload
- Auto Scaling
- Configuration
- Supernode management
- GPU Share
- Service Management
- Distributed Cloud
- Ingress Management
- Storage Management
- Add-On Management
- Helm Application
- Network Management
- Container Network Overview
- GlobalRouter Mode
- VPC-CNI Mode
- VPC-CNI Mode
- Multiple Pods with Shared ENI Mode
- Pods with Exclusive ENI Mode
- Static IP Address Mode Instructions
- Non-static IP Address Mode Instructions
- Interconnection Between VPC-CNI and Other Cloud Resources/IDC Resources
- Security Group of VPC-CNI Mode
- Instructions on Binding an EIP to a Pod
- VPC-CNI Component
- Limits on the Number of Pods in VPC-CNI Mode
- Application Market
- OPS Center
- Cloud Native Monitoring
- Remote Terminals
- Elastic Cluster Guide
- Container Instance Guide
- Edge Cluster Guide
- TMP
- Best Practices
- Cluster
- Cluster Migration
- EKS Cluster
- Security
- Service Deployment
- Hybrid Cloud
- Network
- Using Network Policy for Network Access Control
- Deploying NGINX Ingress on TKE
- Using NodeLocal DNS Cache in a TKE Cluster
- Nginx Ingress High-Concurrency Practices
- Nginx Ingress Best Practices
- Limiting the bandwidth on pods in TKE
- Directly connecting TKE to the CLB of pods based on the ENI
- Use CLB-Pod Direct Connection on TKE
- Obtaining the Real Client Source IP in TKE
- Implementing Custom Domain Name Resolution in TKE
- Using Traefik Ingress in TKE
- Release
- Logs
- Monitoring
- OPS
- Removing and Re-adding Nodes from and to Cluster
- Using Ansible to Batch Operate TKE Nodes
- Using Cluster Audit for Troubleshooting
- Renewing a TKE Ingress Certificate
- Using cert-manager to Issue Free Certificates
- Using cert-manager to Issue Free Certificate for DNSPod Domain Name
- Using the TKE NPDPlus Plug-In to Enhance the Self-Healing Capability of Nodes
- Using kubecm to Manage Multiple Clusters kubeconfig
- Using Audit and Event Services for Troubleshooting in TKE
- Customizing RBAC Authorization in TKE
- DevOps
- Auto Scaling
- Cluster Auto Scaling Practices
- Using tke-autoscaling-placeholder to Implement Auto Scaling in Seconds
- Installing metrics-server on TKE
- Using Custom Metrics for Auto Scaling in TKE
- Utilizing HPA to Auto Scale Businesses on TKE
- Using VPA to Realize Pod Scaling up and Scaling down in TKE
- Adjusting HPA Scaling Sensitivity Based on Different Business Scenarios
- Storage
- Containerization
- Cost Management
- Permission Management
- Overview
- Description of Role Permissions Related to Service Authorization
- TKE Image Registry Resource-level Permission Settings
- Controlling TKE cluster-level permissions
- TKE Kubernetes Object-level Permission Control
- Fault Handling
- API Documentation
- History
- Introduction
- API Category
- Making API Requests
- Cluster APIs
- DescribeClusterKubeconfig
- DescribeClusters
- CreateCluster
- DescribeClusterSecurity
- DeleteCluster
- ModifyClusterEndpointSP
- DescribeClusterEndpointVipStatus
- DescribeClusterEndpointStatus
- DeleteClusterEndpointVip
- DeleteClusterEndpoint
- CreateClusterEndpointVip
- CreateClusterEndpoint
- ModifyClusterAttribute
- AcquireClusterAdminRole
- UpgradeClusterInstances
- UpdateClusterVersion
- GetUpgradeInstanceProgress
- DescribeAvailableClusterVersion
- DescribeClusterCommonNames
- ModifyClusterAuthenticationOptions
- DescribeClusterAuthenticationOptions
- EnableClusterDeletionProtection
- DisableClusterDeletionProtection
- DescribeClusterStatus
- GetClusterLevelPrice
- DescribeResourceUsage
- DescribeClusterLevelChangeRecords
- DescribeClusterLevelAttribute
- Node APIs
- Network APIs
- Scaling group APIs
- Cloud Native Monitoring APIs
- Node Pool APIs
- DescribeClusterAsGroupOption
- RemoveNodeFromNodePool
- ModifyClusterNodePool
- DescribeClusterNodePools
- DescribeClusterNodePoolDetail
- DeleteClusterNodePool
- CreateClusterNodePoolFromExistingAsg
- CreateClusterNodePool
- AddNodeToNodePool
- ModifyClusterAsGroupOptionAttribute
- SetNodePoolNodeProtection
- ModifyNodePoolInstanceTypes
- Edge Compute Cluster APIs
- Other APIs
- Data Types
- Error Codes
- API Mapping Guide
- FAQs
- Service Agreement
- Contact Us
- Glossary
- User Guide(Old)
- Release Notes and Announcements
- Beginner’s Guide
- Product Introduction
- Purchase Guide
- Quick Start
- User Guide
- High-risk Operations of Container Service
- Deploying Containerized Applications in the Cloud
- Kubernetes API Operation Guide
- Open Source Components
- Cluster Management
- Cluster Overview
- Cluster Hosting Modes Introduction
- Cluster Lifecycle
- TKE-Optimized Series Images
- Creating a Cluster
- Deleting a Cluster
- Cluster Scaling
- Changing the Cluster Operating System
- Connecting to a Cluster
- Upgrading a Cluster
- Enabling IPVS for a Cluster
- Enabling GPU Scheduling for a Cluster
- Custom Kubernetes Component Launch Parameters
- Node Management
- Node Pool Management
- Kubernetes Object Management
- Overview
- Namespace
- Workload
- Deployment Management
- StatefulSet Management
- DaemonSet Management
- Job Management
- CronJob Management
- Setting the Resource Limit of Workload
- Setting the Scheduling Rule for a Workload
- Setting the Health Check for a Workload
- Setting the Run Command and Parameter for a Workload
- Using a Container Image in a TCR Enterprise Instance to Create a Workload
- Auto Scaling
- Configuration
- Supernode management
- GPU Share
- Service Management
- Distributed Cloud
- Ingress Management
- Storage Management
- Add-On Management
- Helm Application
- Network Management
- Container Network Overview
- GlobalRouter Mode
- VPC-CNI Mode
- VPC-CNI Mode
- Multiple Pods with Shared ENI Mode
- Pods with Exclusive ENI Mode
- Static IP Address Mode Instructions
- Non-static IP Address Mode Instructions
- Interconnection Between VPC-CNI and Other Cloud Resources/IDC Resources
- Security Group of VPC-CNI Mode
- Instructions on Binding an EIP to a Pod
- VPC-CNI Component
- Limits on the Number of Pods in VPC-CNI Mode
- Application Market
- OPS Center
- Cloud Native Monitoring
- Remote Terminals
- Elastic Cluster Guide
- Container Instance Guide
- Edge Cluster Guide
- TMP
- Best Practices
- Cluster
- Cluster Migration
- EKS Cluster
- Security
- Service Deployment
- Hybrid Cloud
- Network
- Using Network Policy for Network Access Control
- Deploying NGINX Ingress on TKE
- Using NodeLocal DNS Cache in a TKE Cluster
- Nginx Ingress High-Concurrency Practices
- Nginx Ingress Best Practices
- Limiting the bandwidth on pods in TKE
- Directly connecting TKE to the CLB of pods based on the ENI
- Use CLB-Pod Direct Connection on TKE
- Obtaining the Real Client Source IP in TKE
- Implementing Custom Domain Name Resolution in TKE
- Using Traefik Ingress in TKE
- Release
- Logs
- Monitoring
- OPS
- Removing and Re-adding Nodes from and to Cluster
- Using Ansible to Batch Operate TKE Nodes
- Using Cluster Audit for Troubleshooting
- Renewing a TKE Ingress Certificate
- Using cert-manager to Issue Free Certificates
- Using cert-manager to Issue Free Certificate for DNSPod Domain Name
- Using the TKE NPDPlus Plug-In to Enhance the Self-Healing Capability of Nodes
- Using kubecm to Manage Multiple Clusters kubeconfig
- Using Audit and Event Services for Troubleshooting in TKE
- Customizing RBAC Authorization in TKE
- DevOps
- Auto Scaling
- Cluster Auto Scaling Practices
- Using tke-autoscaling-placeholder to Implement Auto Scaling in Seconds
- Installing metrics-server on TKE
- Using Custom Metrics for Auto Scaling in TKE
- Utilizing HPA to Auto Scale Businesses on TKE
- Using VPA to Realize Pod Scaling up and Scaling down in TKE
- Adjusting HPA Scaling Sensitivity Based on Different Business Scenarios
- Storage
- Containerization
- Cost Management
- Permission Management
- Overview
- Description of Role Permissions Related to Service Authorization
- TKE Image Registry Resource-level Permission Settings
- Controlling TKE cluster-level permissions
- TKE Kubernetes Object-level Permission Control
- Fault Handling
- API Documentation
- History
- Introduction
- API Category
- Making API Requests
- Cluster APIs
- DescribeClusterKubeconfig
- DescribeClusters
- CreateCluster
- DescribeClusterSecurity
- DeleteCluster
- ModifyClusterEndpointSP
- DescribeClusterEndpointVipStatus
- DescribeClusterEndpointStatus
- DeleteClusterEndpointVip
- DeleteClusterEndpoint
- CreateClusterEndpointVip
- CreateClusterEndpoint
- ModifyClusterAttribute
- AcquireClusterAdminRole
- UpgradeClusterInstances
- UpdateClusterVersion
- GetUpgradeInstanceProgress
- DescribeAvailableClusterVersion
- DescribeClusterCommonNames
- ModifyClusterAuthenticationOptions
- DescribeClusterAuthenticationOptions
- EnableClusterDeletionProtection
- DisableClusterDeletionProtection
- DescribeClusterStatus
- GetClusterLevelPrice
- DescribeResourceUsage
- DescribeClusterLevelChangeRecords
- DescribeClusterLevelAttribute
- Node APIs
- Network APIs
- Scaling group APIs
- Cloud Native Monitoring APIs
- Node Pool APIs
- DescribeClusterAsGroupOption
- RemoveNodeFromNodePool
- ModifyClusterNodePool
- DescribeClusterNodePools
- DescribeClusterNodePoolDetail
- DeleteClusterNodePool
- CreateClusterNodePoolFromExistingAsg
- CreateClusterNodePool
- AddNodeToNodePool
- ModifyClusterAsGroupOptionAttribute
- SetNodePoolNodeProtection
- ModifyNodePoolInstanceTypes
- Edge Compute Cluster APIs
- Other APIs
- Data Types
- Error Codes
- API Mapping Guide
- FAQs
- Service Agreement
- Contact Us
- Glossary
- User Guide(Old)
Edge Compute Cluster APIs
| API Name | Feature |
|---|---|
| DescribeTKEEdgeScript | Queries the URL of TKE edge script. |
Other APIs
| API Name | Feature |
|---|---|
| DescribeImages | Gets image information |
| DescribeRegions | Queries the list of regions |
| DescribeVersions | Cluster version information |
Cloud Native Monitoring APIs
| API Name | Feature |
|---|---|
| CreatePrometheusAlertRule | Creates an alarm rule |
| DeletePrometheusAlertRule | Deletes an alarm rule |
| DescribePrometheusInstance | Obtains the instance details |
| ModifyPrometheusAlertRule | Modifies an alarm rule |
Node APIs
| API Name | Feature |
|---|---|
| AddExistedInstances | Adds one or more existing instances to a cluster. |
| CheckInstancesUpgradeAble | Checks whether the nodes can be upgraded |
| CreateClusterInstances | Creates one or more cluster nodes. |
| DeleteClusterInstances | Deletes one or more nodes from a cluster. |
| DescribeClusterInstances | Queries the information of one or more nodes in a cluster. |
| DescribeExistedInstances | Queries one or more existing nodes. |
Network APIs
| API Name | Feature |
|---|---|
| AddVpcCniSubnets | Adds the cluster subnets |
| CreateClusterRouteTable | Creates a cluster route table. |
| DeleteClusterRoute | Deletes a cluster route. |
| DeleteClusterRouteTable | Deletes a cluster route table. |
| DescribeClusterRouteTables | Queries one or more cluster route tables. |
| DescribeClusterRoutes | Queries cluster routes. |
| DescribeEnableVpcCniProgress | Queries the async task progress of enabling VPC-CNI mode |
| DescribeRouteTableConflicts | Queries the list of route table conflicts. |
| DescribeVpcCniPodLimits | Queries the maximum number of Pods in the VPC-CNI mode supported by the model |
| EnableVpcCniNetworkType | Enables the VPC-CNI network mode |
Node Pool APIs
| API Name | Feature |
|---|---|
| AddNodeToNodePool | Moves nodes in a cluster to a node pool |
| CreateClusterNodePool | Creates a node pool |
| CreateClusterNodePoolFromExistingAsg | Upgrades a scaling group to a node pool |
| DeleteClusterNodePool | Deletes a node pool |
| DescribeClusterAsGroupOption | Cluster auto scaling configuration |
| DescribeClusterNodePoolDetail | Queries detailed information of a node pool |
| DescribeClusterNodePools | Queries the node pool list. |
| ModifyClusterAsGroupOptionAttribute | Modifies cluster auto scaling attributes |
| ModifyClusterNodePool | Edits a node pool |
| ModifyNodePoolInstanceTypes | Modify the model of instances in a node pool |
| RemoveNodeFromNodePool | Removes a node from a node pool but retains it in the cluster. |
| SetNodePoolNodeProtection | Enabling removal protection for the nodes in a node pool |
Cluster APIs
| API Name | Feature |
|---|---|
| DescribeClusterKubeconfig | Obtains the cluster kubeconfig file |
| AcquireClusterAdminRole | Acquiring the RBAC Admin role of a cluster |
| CreateCluster | Creates a cluster |
| CreateClusterEndpoint | Create a cluster access port |
| CreateClusterEndpointVip | Create an external network access port for the managed cluster |
| DeleteCluster | Deletes a cluster |
| DeleteClusterEndpoint | Delete cluster access port |
| DeleteClusterEndpointVip | Delete the external network access port of the managed cluster |
| DescribeAvailableClusterVersion | Obtains all versions that the cluster can upgrade to |
| DescribeClusterAuthenticationOptions | Queries cluster authentication configuration |
| DescribeClusterCommonNames | Obtains the CommomName for the sub-account to access the cluster |
| DescribeClusterEndpointStatus | Query cluster access port status |
| DescribeClusterEndpointVipStatus | Query the progress of enabling the public network port for a managed cluster |
| DescribeClusterLevelAttribute | Obtains the cluster model |
| DescribeClusterLevelChangeRecords | Queries the cluster model adjustment history |
| DescribeClusterSecurity | Queries the key information of a cluster. |
| DescribeClusterStatus | Queries the information of clusters under the current account |
| DescribeClusters | Queries clusters list. |
| DescribeResourceUsage | Queries the cluster resource usage |
| DisableClusterDeletionProtection | Disables cluster deletion protection |
| EnableClusterDeletionProtection | Enables cluster deletion protection |
| GetClusterLevelPrice | Obtaining the price of specified cluster model |
| GetUpgradeInstanceProgress | Obtains the current progress of the node upgrade |
| ModifyClusterAttribute | Modifies cluster attributes |
| ModifyClusterAuthenticationOptions | Modifies cluster authentication configuration |
| ModifyClusterEndpointSP | Modify the security policy of the external network port of the managed cluster |
| UpdateClusterVersion | Upgrades cluster |
| UpgradeClusterInstances | Upgrades cluster nodes |
Scaling group APIs
| API Name | Feature |
|---|---|
| DeleteClusterAsGroups | Delete a cluster scaling group |
| DescribeClusterAsGroups | Cluster-associated scaling group list |
| ModifyClusterAsGroupAttribute | Modify cluster scaling group attributes |
Yes
No
Was this page helpful?