文档

API概览

更新时间:
本产品(分布式云容器平台/2022-01-01)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(11370001915),在专家指导下进行签名对接。
在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

集群

API标题API概述
CreateHubCluster创建ACK One主控实例创建一个ACK One主控实例。
DescribeHubClusters查询已创建的主控实例列表获取用户ACK One主控实例列表 。
DescribeHubClusterDetails获取主控集群详情获取ACKOne主控集群的详细信息 。
DeleteHubCluster删除主控集群删除ACK One的主控集群 。
AttachClusterToHub添加子集群到主控集群添加ACK集群到ACKOne主控集群。
DescribeManagedClusters查询已添加的子集群列表获取ACK One主控集群下的子集群列表。
DetachClusterFromHub从主控集群中移除子集群从ACK One主控集群中移除ACK子集群。
UpdateHubClusterFeature更新集群特性更新集群特性。

授权

API标题API概述
DescribeUserPermissions查询RAM用户主控实例授权信息查看子账号授权内容。
GrantUserPermissions全量更新RAM用户主控实例授权信息为子账号授权。
DescribeHubClusterKubeconfig获取集群的KubeConfig获取ACK One集群的KubeConfig。除了通过容器服务控制台来管理集群之外,您还可以通过Kubernetes命令行工具kubectl来管理集群以及应用。使用kubectl工具管理集群时,您需要先获取集群的KubeConfig信息并通过kubectl工具连接集群。
GrantUserPermission授予RAM用户RBAC权限为RAM用户或RAM角色授予RBAC权限。RAM系统策略仅控制ACK One集群资源的操作权限(例如创建实例、查看实例列表等),若RAM用户或RAM角色需要操作指定集群内的K8s资源,例如,创建GitOps Application和Argo Workflow等,还需要获取指定ACK One集群及其命名空间的操作权限即RBAC权限。本文为您介绍如何为RAM用户或RAM角色授予RBAC权限。
UpdateUserPermission更新RAM用户RBAC授权更新RAM用户RBAC授权。
DeleteUserPermission删除RAM用户RBAC授权删除RAM用户RBAC授权。

安全策略

API标题API概述
DescribePolicies列举策略治理规则库列表列举策略治理规则库列表。
DescribePolicyDetails获取策略治理规则模板详情获取策略治理规则模板详情。
DeployPolicyInstance在主控实例关联集群中部署策略规则实例在主控实例关联集群中部署策略规则实例。
DescribePolicyInstances查询主控实例关联集群的策略实例查询主控实例关联集群的策略实例。
DescribePolicyInstancesStatus获取主控实例关联集群指定策略规则实例详情获取主控实例关联集群指定策略规则实例详情。
DescribePolicyGovernanceInCluster获取主控实例下关联集群策略治理详情获取主控实例下关联集群策略治理详情。
DeletePolicyInstance删除关联集群中的策略规则实例删除关联集群中的策略规则实例。

日志

API标题API概述
DescribeHubClusterLogs查询集群日志获取ACK One多集群舰队主控集群的日志。

其他

API标题API概述
DescribeRegions查看可选的地域查看可选的地域。