用户指南

最佳实践

API 文档

参与文档共建赢好礼> HOT

API 概览

最近更新时间:2022-07-29 10:58:22

我的收藏

云原生监控相关接口

接口名称 接口功能
CreatePrometheusAlertPolicy 创建告警策略
CreatePrometheusAlertRule 创建告警规则
CreatePrometheusClusterAgent 2.0实例关联集群
CreatePrometheusDashboard 创建grafana监控面板
CreatePrometheusGlobalNotification 创建全局告警通知渠道
CreatePrometheusTemp 新建模板
CreatePrometheusTemplate 创建模板
DeletePrometheusAlertPolicy 删除2.0实例告警策略
DeletePrometheusAlertRule 删除告警规则
DeletePrometheusClusterAgent 解除2.0实例的集群关联
DeletePrometheusTemp 删除模板实例
DeletePrometheusTempSync 解除模板同步
DeletePrometheusTemplate 删除模板
DeletePrometheusTemplateSync 取消模板同步
DescribePrometheusAgentInstances 获取关联目标集群的实例列表
DescribePrometheusAgents 获取被关联集群列表
DescribePrometheusAlertHistory 获取告警历史
DescribePrometheusAlertPolicy 获取2.0实例告警策略列表
DescribePrometheusAlertRule 获取告警规则列表
DescribePrometheusClusterAgents 获取2.0实例关联集群列表
DescribePrometheusGlobalConfig 获得实例级别抓取配置
DescribePrometheusGlobalNotification 查询全局告警通知渠道
DescribePrometheusInstance 获取实例详细信息
DescribePrometheusInstanceInitStatus 获取2.0实例初始化任务状态
DescribePrometheusInstancesOverview 获取2.0实例列表
DescribePrometheusOverviews 获取实例列表
DescribePrometheusRecordRules 获取聚合规则列表,包含关联集群内的资源
DescribePrometheusTargets 获取targets信息
DescribePrometheusTemp 拉取模板列表
DescribePrometheusTempSync 获取模板关联实例信息
DescribePrometheusTemplateSync 获取模板同步信息
DescribePrometheusTemplates 模板列表
ModifyPrometheusAgentExternalLabels 修改被关联集群的external labels
ModifyPrometheusAlertPolicy 修改2.0实例告警策略
ModifyPrometheusAlertRule 修改告警规则
ModifyPrometheusGlobalNotification 修改全局告警通知渠道
ModifyPrometheusTemp 修改模板实例
ModifyPrometheusTemplate 修改模板
RunPrometheusInstance 初始化2.0实例
SyncPrometheusTemp 同步模板
SyncPrometheusTemplate 同步模板到实例或者集群

网络相关接口

接口名称 接口功能
AddClusterCIDR 给集群增加ClusterCIDR
AddVpcCniSubnets 增加集群子网
CreateClusterRoute 创建集群路由
CreateClusterRouteTable 创建集群路由表
DeleteClusterRoute 删除集群路由
DeleteClusterRouteTable 删除集群路由表
DescribeClusterRouteTables 查询集群路由表
DescribeClusterRoutes 查询集群路由
DescribeEnableVpcCniProgress 查询开启vpc-cni异步任务的进度
DescribeRouteTableConflicts 查询路由表冲突列表
DescribeVpcCniPodLimits 查询机型可支持的最大VPC-CNI模式Pod数量
DisableVpcCniNetworkType 关闭附加的VPC-CNI网络能力
EnableVpcCniNetworkType 开启vpc-cni容器网络能力

弹性容器实例相关接口

接口名称 接口功能
DescribeEKSContainerInstanceRegions 查询容器实例支持的地域
CreateEKSContainerInstances 创建容器实例
DescribeEKSContainerInstances 查询容器实例
DeleteEKSContainerInstances 删除容器实例
DescribeEksContainerInstanceLog 查询容器实例日志
CreateImageCache 创建镜像缓存
DeleteImageCaches 删除镜像缓存
DescribeEKSContainerInstanceEvent 查询容器实例的事件
DescribeImageCaches 查询镜像缓存信息
GetMostSuitableImageCache 查询匹配的镜像缓存
RestartEKSContainerInstances 重启容器实例
UpdateEKSContainerInstance 更新容器实例
UpdateImageCache 更新镜像缓存

其他接口

接口名称 接口功能
DescribeImages 获取镜像信息
DescribeRegions 查询地域列表
DescribeVersions 集群版本信息
DisableEventPersistence 关闭事件持久化功能
EnableEventPersistence 开启事件持久化功能
ForwardApplicationRequestV3 操作TKE集群的addon
GetTkeAppChartList 获取TKE支持的App列表
InstallLogAgent 安装日志采集组件
UninstallLogAgent 卸载日志采集组件

边缘计算集群相关接口

接口名称 接口功能
CheckEdgeClusterCIDR 检查边缘计算集群的CIDR是否冲突
CreateECMInstances 创建边缘计算ECM机器
CreateEdgeLogConfig 创建边缘集群日志采集配置
CreateTKEEdgeCluster 创建边缘计算集群
DeleteECMInstances 删除ECM实例
DeleteEdgeCVMInstances 删除边缘容器CVM实例
DeleteEdgeClusterInstances 删除边缘计算实例
DeleteTKEEdgeCluster 删除边缘计算集群
DescribeAvailableTKEEdgeVersion 边缘计算支持的k8s版本
DescribeECMInstances 获取ECM实例相关信息
DescribeEdgeCVMInstances 获取边缘容器CVM实例相关信息
DescribeEdgeClusterInstances 查询边缘计算集群的节点信息
DescribeEdgeLogSwitches 查询边缘集群日志开关列表
DescribeTKEEdgeClusterCredential 获取边缘计算集群的认证信息
DescribeTKEEdgeClusterStatus 查询边缘计算集群状态
DescribeTKEEdgeClusters 查询边缘集群列表
DescribeTKEEdgeExternalKubeconfig 获取边缘计算外部访问的kubeconfig
DescribeTKEEdgeScript 获取边缘脚本链接
ForwardTKEEdgeApplicationRequestV3 操作TKEEdge集群的addon
InstallEdgeLogAgent 安装边缘日志采集组件
UninstallEdgeLogAgent 卸载边缘日志采集组件
UpdateTKEEdgeCluster 修改边缘计算的集群

监控相关接口

接口名称 接口功能
CreatePrometheusConfig 创建prometheus配置
CreatePrometheusRecordRuleYaml 以Yaml的方式创建聚合规则
DeletePrometheusConfig 删除Prometheus配置
DeletePrometheusRecordRuleYaml 删除聚合实例
DescribePrometheusConfig 拉取Prometheus配置
ModifyPrometheusConfig 修改prometheus配置
ModifyPrometheusRecordRuleYaml 通过yaml的方式修改Prometheus聚合实例

伸缩组相关接口

接口名称 接口功能
DeleteClusterAsGroups 删除集群伸缩组
DescribeClusterAsGroups 集群关联的伸缩组列表
ModifyClusterAsGroupAttribute 修改集群伸缩组属性

弹性集群相关接口

接口名称 接口功能
CreateEKSCluster 创建弹性集群
DeleteEKSCluster 删除弹性集群
DescribeEKSClusterCredential 获取弹性容器集群的认证信息
DescribeEKSClusters 查询弹性集群列表
UpdateEKSCluster 修改弹性集群EKS

集群相关接口

接口名称 接口功能
DescribeClusterKubeconfig 获取集群kubeconfig文件
DescribeExternalClusterSpec 获取导入第三方集群YAML定义
DescribeClusterEndpoints 获取集群访问地址
AcquireClusterAdminRole 获取集群RBAC管理员角色
CreateCluster 创建集群
CreateClusterEndpoint 创建集群访问端口
CreateClusterEndpointVip 创建托管集群外网访问端口
DeleteCluster 删除集群
DeleteClusterEndpoint 删除集群访问端口
DeleteClusterEndpointVip 删除托管集群外网访问端口
DescribeAvailableClusterVersion 获取集群可以升级的所有版本
DescribeClusterAuthenticationOptions 查看集群认证配置
DescribeClusterCommonNames 获取集群子账户CommonName映射关系
DescribeClusterControllers 查询Kubernetes控制器状态
DescribeClusterEndpointStatus 查询集群访问端口状态
DescribeClusterEndpointVipStatus 查询托管集群开启外网端口流程状态
DescribeClusterLevelAttribute 获取集群规模
DescribeClusterLevelChangeRecords 查询集群变配记录
DescribeClusterSecurity 集群的密钥信息
DescribeClusterStatus 查看集群状态列表
DescribeClusters 查询集群列表
DescribeEdgeAvailableExtraArgs 查询边缘容器集群可用的自定义参数
DescribeEdgeClusterExtraArgs 查询边缘集群自定义参数
DescribeResourceUsage 获取集群资源使用量
DisableClusterAudit 关闭集群审计
DisableClusterDeletionProtection 关闭集群删除保护
EnableClusterAudit 开启集群审计
EnableClusterDeletionProtection 启用集群删除保护
GetClusterLevelPrice 获取集群规模价格
GetUpgradeInstanceProgress 获得节点升级当前的进度
ModifyClusterAttribute 修改集群属性
ModifyClusterAuthenticationOptions 修改集群认证配置
ModifyClusterEndpointSP 修改托管集群外网端口的安全策略
ScaleInClusterMaster 缩容独立集群master节点
ScaleOutClusterMaster 扩容独立集群master节点
UpdateClusterVersion 升级集群
UpgradeClusterInstances 集群节点升级

节点相关接口

接口名称 接口功能
AddExistedInstances 添加已经存在的实例到集群
CheckInstancesUpgradeAble 节点是否可升级
CreateClusterInstances 扩展集群节点
DeleteClusterInstances 删除集群中的节点
DescribeClusterInstances 查询集群节点信息
DescribeExistedInstances 查询已经存在的节点

节点池相关接口

接口名称 接口功能
AddNodeToNodePool 将集群内节点移入节点池
CreateClusterNodePool 创建节点池
CreateClusterNodePoolFromExistingAsg 从伸缩组创建节点池
DeleteClusterNodePool 删除节点池
DescribeClusterAsGroupOption 集群弹性伸缩配置
DescribeClusterNodePoolDetail 查询节点池详情
DescribeClusterNodePools 查询节点池列表
ModifyClusterAsGroupOptionAttribute 修改集群弹性伸缩属性
ModifyClusterNodePool 编辑节点池
ModifyNodePoolDesiredCapacityAboutAsg 修改节点池关联伸缩组的期望实例数
ModifyNodePoolInstanceTypes 修改节点池的机型配置
RemoveNodeFromNodePool 移出节点池节点
SetNodePoolNodeProtection 节点池节点设置移出保护
目录