API概览

更新时间:
复制 MD 格式

API标准及多语言预置SDK

本产品(adcp/2022-01-01)的OpenAPI采用RPC签名风格。我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(147535001692),在专家指导下进行签名对接。

在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

自定义签名场景

若您的业务场景有特殊需求,需通过自签名方式对接 API,建议优先咨询我们的技术支持团队(服务钉钉群:147535001692),获取专业指导以确保高效接入。

账号与安全准备

阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露,所有相关资源都将面临未经授权访问的风险。为确保安全,建议创建一个仅具备 API 访问权限的RAM用户并配置其 AccessKey,同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下,才使用阿里云账号。

集群

API

标题

API概述

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

授权

API

标题

API概述

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

日志

API

标题

API概述

DescribeHubClusterLogs 查询集群日志 获取ACK One多集群舰队主控集群的日志。

其他

API

标题

API概述

ChangeResourceGroup 资源组转组 更新资源组
DeletePolicyInstance 删除关联集群中的策略规则实例 删除关联集群中的策略规则实例。
DeployPolicyInstance 在主控实例关联集群中部署策略规则实例 在主控实例关联集群中部署策略规则实例。
DescribePolicies 列举策略治理规则库列表 列举策略治理规则库列表。
DescribePolicyDetails 获取策略治理规则模板详情 获取策略治理规则模板详情。
DescribePolicyGovernanceInCluster 获取主控实例下关联集群策略治理详情 获取主控实例下关联集群策略治理详情。
DescribePolicyInstances 查询主控实例关联集群的策略实例 查询主控实例关联集群的策略实例。
DescribePolicyInstancesStatus 获取主控实例关联集群指定策略规则实例详情 获取主控实例关联集群指定策略规则实例详情。
DescribeRegions 查看可选的地域 查看可选的地域。