调用DescribeExternalAgent获取注册集群的代理配置。您可以将该配置部署到自己的集群用于访问API Server。

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

调试

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

请求语法

GET /k8s/ClusterId/external/agent/deployment?PrivateIpAddress=String HTTP/1.1 
Content-Type:application/json

请求参数

表 1. 请求Path参数
参数名称 类型 是否必选 示例 说明
ClusterId String 是 c106f377e16f34eb1808d6b9362c9****

集群ID。
表 2. 请求Query参数
参数名称 类型 是否必选 示例 说明
PrivateIpAddress String 否 true

是否获取内网访问凭据。

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

默认值：false。

响应体语法

HTTP/1.1 200
Content-Type:application/json
{
  "config" : "String"
}

响应参数

表 3. 响应Body参数
参数名称 类型 示例 说明
config String apiVersion: v1****

YAML格式的代理配置。

查询集群代理示例

请求示例

GET /k8s/c106f377e16f34eb1808d6b9362c9****/external/agent/deployment?PrivateIpAddress=true HTTP/1.1 
Content-Type:application/json

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<config>apiVersion: v1****</config>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

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