文档首页/ 华为云UCS/ API参考/ API/ UCS集群/ 获取集群接入信息
更新时间:2025-08-21 GMT+08:00

获取集群接入信息

功能介绍

该API接口用于获取集群接入信息;传入的cluster ID必须符合k8s UUID的格式规则;同时需要用户有对应集群证书的获取权限,否则会鉴权失败;agent证书只可以下载一次。仅用于获取三方集群的集群接入信息,CCE集群不从该接口获取,如果传入CCE集群ID,返回码为400

URI

GET /v1/clusters/{clusterid}/accessinfo

表1 路径参数

参数

是否必选

参数类型

描述

clusterid

String

集群ID

表2 Query参数

参数

是否必选

参数类型

描述

vpcendpoint

String

VPC终端节点的IP地址。私网接入的集群必填,且必须是打通线下集群的VPC终端节点。

创建VPC终端节点及查询IP地址的方法请参见创建终端节点

region

String

接入region,私网接入的集群必填

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

身份认证信息

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

[数组元素]

Array of strings

  

状态码:400

表5 响应Body参数

参数

参数类型

描述

-

String

  

状态码:403

表6 响应Body参数

参数

参数类型

描述

-

String

  

状态码:500

表7 响应Body参数

参数

参数类型

描述

-

String

  

请求示例

响应示例

状态码:200

返回集群接入信息;如果已经调用过该接口则返回“已下载”

[ {
  "apiVersion" : "apps/v1",
  "kind" : "Deployment",
  "metadata" : {
    "labels" : {
      "app" : "proxy-agent"
    },
    "name" : "proxy-agent",
    "namespace" : "kube-system"
  },
  "spec" : {
    "replicas" : 2,
    "template" : {
      "metadata" : {
        "labels" : {
          "app" : "proxy-agent"
        }
      },
      "spec" : {
        "tolerations" : [ {
          "key" : "role",
          "operator" : "Equal",
          "value" : "manage"
        } ],
        "containers" : [ {
          "command" : [ "/proxy-agent" ],
          "args" : [ "--logtostderr=true", "--ca-cert=/var/certs/agent/ca.crt", "--agent-cert=/var/certs/agent/proxy-agent.crt", "--agent-key=/var/certs/agent/proxy-agent.key", "--proxy-server-host=proxyurl.ucs.myhuaweicloud.com", "--proxy-server-port=30123", "--agent-id={uuid}", "--agent-identifiers=host={ip_addr}" ],
          "image" : "{image_addr}",
          "imagePullPolicy" : "IfNotPresent",
          "name" : "proxy-agent"
        } ],
        "priorityClassName" : "system-cluster-critical",
        "hostAliases" : [ {
          "ip" : "{ip_addr}",
          "hostnames" : [ "proxyurl.ucs.myhuaweicloud.com" ]
        } ]
      }
    }
  }
}, {
  "apiVersion" : "v1",
  "kind" : "Secret",
  "metadata" : {
    "name" : "proxy-agent-cert",
    "namespace" : "kube-system"
  },
  "type" : "Opaque",
  "data" : {
    "ca.crt" : "{ca crt}",
    "proxy-agent.crt" : "{proxy-agent crt}",
    "proxy-agent.key" : "{proxy-agent key}",
    "common_shared.key" : "{common_shared key}",
    "root.key" : "{root key}"
  }
} ]

状态码

状态码

描述

200

返回集群接入信息;如果已经调用过该接口则返回“已下载”

400

客户端请求错误,服务器无法执行请求

403

服务器拒绝执行请求

500

服务器内部错误

错误码

请参见错误码