文档

DescribeExternalAgent - 查询集群代理

更新时间:

根据集群ID查询集群中部署注册集群的代理配置。

接口说明

关于集群接入的更多信息,请参见注册外部 Kubernetes 集群

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
cs:DescribeExternalAgentRead
  • Cluster
    acs:cs:{#regionId}:{#accountId}:cluster/{#ClusterId}

请求语法

GET /k8s/{ClusterId}/external/agent/deployment

请求参数

名称类型必填描述示例值
ClusterIdstring

集群 ID。

c106f377e16f34eb1808d6b9362c9****
PrivateIpAddressstring

是否获取内网访问凭据。

  • true:仅获取内网连接凭据。
  • false:仅获取公网连接凭据。

默认值:false

true
AgentModestring

Agent 权限模式。

admin:管理员模式,拥有所有权限。 restricted:受限模式,仅拥有部分权限。 默认值:admin。

admin

返回参数

名称类型描述示例值
object

返回数据体。

configstring

YAML 格式的代理配置。

apiVersion: v1****

示例

正常返回示例

JSON格式

{
  "config": "apiVersion: v1****"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-08-14OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:AgentMode
  • 本页导读 (1)