Tencent Kubernetes Engine API Documentation
Total Page:16
File Type:pdf, Size:1020Kb
Tencent Kubernetes Engine Tencent Kubernetes Engine API Documentation Product Documentation ©2013-2019 Tencent Cloud. All rights reserved. Page 1 of 350 Tencent Kubernetes Engine Copyright Notice ©2013-2019 Tencent Cloud. All rights reserved. Copyright in this document is exclusively owned by Tencent Cloud. You must not reproduce, modify, copy or distribute in any way, in whole or in part, the contents of this document without Tencent Cloud's the prior written consent. Trademark Notice All trademarks associated with Tencent Cloud and its services are owned by Tencent Cloud Computing (Beijing) Company Limited and its affiliated companies. Trademarks of third parties referred to in this document are owned by their respective proprietors. Service Statement This document is intended to provide users with general information about Tencent Cloud's products and services only and does not form part of Tencent Cloud's terms and conditions. Tencent Cloud's products or services are subject to change. Specific products and services and the standards applicable to them are exclusively provided for in Tencent Cloud's applicable terms and conditions. ©2013-2019 Tencent Cloud. All rights reserved. Page 2 of 350 Tencent Kubernetes Engine Contents API Documentation History Introduction API Category Making API Requests Request Structure Common Params Signature v3 Signature Responses Cluster APIs DescribeClusterKubeconfig DescribeClusters CreateCluster DescribeClusterSecurity DeleteCluster ModifyClusterEndpointSP DescribeClusterEndpointVipStatus DescribeClusterEndpointStatus DeleteClusterEndpointVip DeleteClusterEndpoint CreateClusterEndpointVip CreateClusterEndpoint ModifyClusterAttribute AcquireClusterAdminRole UpgradeClusterInstances UpdateClusterVersion GetUpgradeInstanceProgress DescribeAvailableClusterVersion DescribeClusterCommonNames Node APIs DescribeClusterInstances DeleteClusterInstances AddExistedInstances DescribeExistedInstances ©2013-2019 Tencent Cloud. All rights reserved. Page 3 of 350 Tencent Kubernetes Engine CreateClusterInstances CheckInstancesUpgradeAble Network APIs DescribeRouteTableConflicts DescribeClusterRoutes DescribeClusterRouteTables DeleteClusterRouteTable DeleteClusterRoute CreateClusterRouteTable EnableVpcCniNetworkType DescribeEnableVpcCniProgress AddVpcCniSubnets DescribeVpcCniPodLimits Scaling group APIs CreateClusterAsGroup DeleteClusterAsGroups ModifyClusterAsGroupAttribute DescribeClusterAsGroups Cloud Native Monitoring APIs ModifyPrometheusAlertRule DescribePrometheusInstance DeletePrometheusAlertRule CreatePrometheusAlertRule Node Pool APIs DescribeClusterAsGroupOption RemoveNodeFromNodePool ModifyClusterNodePool DescribeClusterNodePools DescribeClusterNodePoolDetail DeleteClusterNodePool CreateClusterNodePoolFromExistingAsg CreateClusterNodePool AddNodeToNodePool ModifyClusterAsGroupOptionAttribute SetNodePoolNodeProtection ModifyNodePoolInstanceTypes Other APIs DescribeRegions ©2013-2019 Tencent Cloud. All rights reserved. Page 4 of 350 Tencent Kubernetes Engine DescribeImages DescribeVersions Data Types Error Codes API Mapping Guide ©2013-2019 Tencent Cloud. All rights reserved. Page 5 of 350 Tencent Kubernetes Engine API Documentation History Last updated:2021-09-13 16:06:12 Release 19 Release time: 2021-09-13 16:05:17 Release updates: Improvement to existing documentation. New APIs: ModifyNodePoolInstanceTypes New data structures: RunAutomationServiceEnabled Modified data structures: EnhancedService New members:AutomationService InstanceAdvancedSettings New members:PreStartUserScript Release 18 Release time: 2021-08-30 15:27:48 Release updates: Improvement to existing documentation. New APIs: CreatePrometheusAlertRule DeletePrometheusAlertRule DescribePrometheusInstance DescribeVersions ©2013-2019 Tencent Cloud. All rights reserved. Page 6 of 350 Tencent Kubernetes Engine DescribeVpcCniPodLimits ModifyPrometheusAlertRule Modified APIs: DescribeClusterInstances New input parameters:Filters New data structures: PodLimitsByType PodLimitsInstance PrometheusAlertRule PrometheusAlertRuleDetail PrometheusGrafanaInfo PrometheusNotification VersionInstance Release 17 Release time: 2021-08-03 10:18:24 Release updates: Improvement to existing documentation. New APIs: DescribeClusterCommonNames DescribeEnableVpcCniProgress EnableVpcCniNetworkType Modified APIs: AddExistedInstances New input parameters:InstanceAdvancedSettingsOverrides SetNodePoolNodeProtection New input parameters:ClusterId, NodePoolId, InstanceIds, ProtectedFromScaleIn New output parameters:SucceedInstanceIds, FailedInstanceIds New data structures: ©2013-2019 Tencent Cloud. All rights reserved. Page 7 of 350 Tencent Kubernetes Engine CommonName Modified data structures: ExistedInstancesForNode New members:DesiredPodNumbers Release 16 Release time: 2021-07-08 16:46:38 Release updates: Improvement to existing documentation. Modified data structures: DataDisk New members:DiskPartition InstanceAdvancedSettings New members:DesiredPodNumber Release 15 Release time: 2021-07-06 16:27:35 Release updates: Improvement to existing documentation. Modified data structures: Cluster New members:EnableExternalNode ClusterAdvancedSettings New members:CiliumMode Release 14 Release time: 2021-06-10 17:39:22 Release updates: ©2013-2019 Tencent Cloud. All rights reserved. Page 8 of 350 Tencent Kubernetes Engine Improvement to existing documentation. New APIs: AddVpcCniSubnets Modified data structures: ClusterNetworkSettings New members:KubeProxyMode, ServiceCIDR, Subnets Release 13 Release time: 2021-05-12 10:26:27 Release updates: Improvement to existing documentation. New APIs: SetNodePoolNodeProtection Modified APIs: DescribeExistedInstances New input parameters:IpAddresses Release 12 Release time: 2021-05-10 15:28:24 Release updates: Improvement to existing documentation. Modified APIs: DescribeClusterEndpointStatus New output parameters:ErrorMsg Release 11 ©2013-2019 Tencent Cloud. All rights reserved. Page 9 of 350 Tencent Kubernetes Engine Release time: 2021-04-22 14:43:53 Release updates: Improvement to existing documentation. Modified APIs: UpdateClusterVersion New input parameters:ExtraArgs Modified data structures: NodePool New members:DesiredPodNum, UserScript Release 10 Release time: 2021-03-19 16:37:37 Release updates: Improvement to existing documentation. Modified data structures: ClusterAdvancedSettings New members:EnableCustomizedPodCIDR, BasePodNumber ClusterExtraArgs New members:Etcd Release 9 Release time: 2021-02-04 18:41:18 Release updates: Improvement to existing documentation. New APIs: DescribeAvailableClusterVersion GetUpgradeInstanceProgress UpdateClusterVersion ©2013-2019 Tencent Cloud. All rights reserved. Page 10 of 350 Tencent Kubernetes Engine Modified APIs: AddExistedInstances New input parameters:SkipValidateOptions CreateClusterInstances New input parameters:SkipValidateOptions CreateClusterNodePool New input parameters:NodePoolOs, OsCustomizeType New data structures: ClusterVersion InstanceUpgradeClusterStatus InstanceUpgradePreCheckResult InstanceUpgradePreCheckResultItem InstanceUpgradeProgressItem TaskStepInfo Release 8 Release time: 2021-01-07 19:54:27 Release updates: Improvement to existing documentation. Modified data structures: NodePool New members:NodePoolOs, OsCustomizeType, ImageId Release 7 Release time: 2021-01-05 19:20:59 Release updates: Improvement to existing documentation. New APIs: ModifyClusterAsGroupOptionAttribute ©2013-2019 Tencent Cloud. All rights reserved. Page 11 of 350 Tencent Kubernetes Engine Modified APIs: AddExistedInstances New input parameters:NodePool ModifyClusterNodePool New input parameters:OsName, OsCustomizeType New data structures: NodePoolOption Release 6 Release time: 2020-12-07 19:15:00 Release updates: Improvement to existing documentation. New APIs: CheckInstancesUpgradeAble UpgradeClusterInstances New data structures: UpgradeAbleInstancesItem UpgradeNodeResetParam Release 5 Release time: 2020-12-02 10:34:57 Release updates: Improvement to existing documentation. Modified data structures: ClusterAdvancedSettings New members:RuntimeVersion ©2013-2019 Tencent Cloud. All rights reserved. Page 12 of 350 Tencent Kubernetes Engine Release 4 Release time: 2020-11-13 19:22:37 Release updates: Improvement to existing documentation. New APIs: AddNodeToNodePool CreateClusterNodePool CreateClusterNodePoolFromExistingAsg DeleteClusterNodePool DescribeClusterNodePoolDetail DescribeClusterNodePools ModifyClusterNodePool RemoveNodeFromNodePool Modified APIs: AddExistedInstances New output parameters:FailedReasons New data structures: AutoscalingAdded ManuallyAdded NodeCountSummary NodePool Taint Modified data structures: ClusterAdvancedSettings New members:VpcCniType Release 3 Release time: 2020-10-22 16:03:43 Release updates: ©2013-2019 Tencent Cloud. All rights reserved. Page 13 of 350 Tencent Kubernetes Engine Improvement to existing documentation. New APIs: AcquireClusterAdminRole Release 2 Release time: 2020-10-16 18:16:19 Release updates: Improvement to existing documentation. New APIs: DescribeClusterKubeconfig Modified APIs: CreateCluster New input parameters:ExtensionAddons New data structures: ExtensionAddon Existing Release Release time: 2020-07-30 20:32:39 Existing APIs/data structures are as follows: Improvement to existing documentation. Existing APIs: AddExistedInstances CreateCluster CreateClusterAsGroup CreateClusterEndpoint CreateClusterEndpointVip CreateClusterInstances CreateClusterRouteTable ©2013-2019 Tencent Cloud. All rights reserved. Page 14 of 350 Tencent Kubernetes Engine DeleteCluster DeleteClusterAsGroups