文档中心

云容器引擎CKS API参考手册

最近更新时间：2023-04-16 17:00:00

1 集群管理

1.1 CreateCluster

调用 CreateCluster 接口创建一个 Kubernetes 集群。

1.1.1 使用说明

POST https://{Endpoint}/cks/v1.0/clusters

1.1.2 请求参数

表1-1 header 中请求参数

表1-2 body 中的请求参数

1.1.3 返回数据

1.1.4 错误码

1.1.5 示例

1. 请求示例
POST https://{Endpoint}/cks/v1.0/clusters
{
    "Addons": [
      {
          "AddonName": "flannel",
          "AddonType": "network"
      }
      ],
      "ClusterDomain": "cluster.local",
      "ClusterName": "ce********2121",
      "ClusterType": "ManagedKubernetes",
      "Description": "test",
      "Flavor": "string",
      "KubernetesVersion": "v1.18.18",
      "Nodes": [
          "ecs-********2ym5"
      ],
      "PodCidr": "10.0.0.0/*",
      "ProxyMode": "IPVS",
      "Runtime": {
          "Name": "docker",
          "Version": "1.0"
      },
      "ServiceCidr": "172.16.0.0/**",
      "SubnetId": "snet-******00wd",
      "VpcId": "vpc-******hqecf",
      "ZoneId": "zone-1"
}
2. 正常返回示例
HTTP/1.1 200 OK
Content-Type:application/json
{
      "RequestId": "71e69b56-32be-4412-ab45-49eded6a87be",
     "ClusterId":"cks-nmg******vd3i1sj"
}

1.2 GetClusters

查询在 CKS 中创建的集群信息。

1.2.1 使用说明

GET https://{Endpoint}/cks/v1.0/clusters

1.2.2 请求参数

说明：经过网关调用接口时不需要传入表 1-4 参数。
表1-3 url 中的请求参数

表1-4 header 中请求参数

1.2.3 返回数据

表1-5 Clusters 字段详情信息

1.2.4 错误码

1.2.5 示例

1. 请求示例
GET https://{Endpoint}/cks/v1.0/clusters
2. 正常返回示例
HTTP/1.1 200 OK
Content-Type:application/json
{
     "RequestId": "71e69b56-32be-4412-ab45-49eded6a87be",
     "TotalCount": 1,
     "PageSize": 10,
      "PageNum": 1,
      "Clusters": [
      {
          "ClusterId": "cks-nmg******vd3i1sj",
          "Status": "4",
          "ClusterName": "ceclou*******69",
          "ClusterType": "ManagedKubernetes",
          "KubernetesVersion": null,
          "RunTime": {
              "Name": "docker",
              "Version": "1.0"
          },
          "Addons": [
          {
              "AddonType": "network",
              "AddonName": "cks_vpc"
          }
        ],
          "ZoneId": "可用区 01",
          "ClusterDomain": "cluster.local",
          "ProxyMode": "IPVS",
        "ServiceCidr": "192.168.6.0/**",
        "VpcId": "vpc-m14fmhqecf",
        "SubnetId": "snet-8*******0wd",
          "PodCidr": "192.168.5.0/**",
          "Nodes": [],
          "CreateTime": "2020-12-27T10:37:41+08:00",
          "UpdateTime": null,
          "ClusterSize": 0,
          "Description": null,
          "ApiServerAddr": ""
      },
      {
          "ClusterId": "cks-ogl4*****hc9dj9t6",
          "Status": "2",
          "ClusterName": "cecloud-cks-******-1",
          "ClusterType": null,
          "KubernetesVersion": null,
          "RunTime": {
              "Name": "docker",
              "Version": "1.0"
          },
          "Addons": [
          {
              "AddonType": "network",
              "AddonName": "flannel"
          }
          ],
          "ZoneId": "可用区 01",
          "ClusterDomain": "cluster.local",
          "ProxyMode": "IPVS",
          "ServiceCidr": "172.16.0.0/**",
          "VpcId": "vpc-m14fmhqecf",
          "SubnetId": "snet-878****0wd",
          "PodCidr": "10.0.0.0/8",
          "Nodes": [
              "vk-cks-og*******9dj9t6"
          ],
          "CreateTime": "2021-12-27T10:37:41+08:00",
          "UpdateTime": null,
          "ClusterSize": 1,
          "Description": "测试修改描述",
          "ApiServerAddr": ""
      } ]
}

1.3 UpdateCluster

修改集群的名字、描述信息。

1.3.1 使用说明

PUT https://{Endpoint}/cks/v1.0/clusters/{ClusterId}

1.3.2 请求参数

表1-6 url 中的请求参数

表1-7 header 中请求参数

表1-8 body 中参数

1.3.3 返回数据

1.3.4 错误码

1.3.5 示例

1. 请求示例
PUT https://{Endpoint}/cks/v1.0/clusters/cks-*******9dj9t6
{
      "ClusterName": "cecloud-cks-******-1",
      "Description": "测试修改描述"
}
2. 正常返回示例
HTTP/1.1 200 OK
Content-Type:application/json
{
      "RequestId": "71e69b56-32be-4412-ab45-49eded6a87be",
      "ClusterId": "cks-******c9dj9t6"
}

1.4 DeleteCluster

调用 DeleteCluster 接口删除指定的集群。

1.4.1 使用说明

DELETE https://{Endpoint}/cks/v1.0/clusters/{ClusterId}

1.4.2 请求参数

表1-9 url 中的请求参数

表1-10 header 中请求参数

1.4.3 返回数据

1.4.4 错误码

1.4.5 示例

1. 请求示例
DELETE https://{Endpoint}/cks/v1.0/clusters/cks-********ctg8zq9ib
2. 正常返回示例
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId": "71e69b56-32be-4412-ab45-49eded6a87be",
}

1.5 GetCluster

调用 GetCluster 接口查询集群详细信息。

1.5.1 使用说明

GET https://{Endpoint}/cks/v1.0/clusters/{ClusterId}

1.5.2 请求参数

说明：经过网关调用接口时不需要传入表 1-12 参数。
表1-11 url 中的请求参数

表1-12 header 中请求参数

1.5.3 返回数据

1.5.4 错误码

1.5.5 示例

1. 请求示例
GET https://{Endpoint}/cks/v1.0/clusters/cks-*******q9ib
2. 正常返回示例
HTTP/1.1 200 OK
Content-Type:application/json
{
      "RequestId": "71e69b56-32be-4412-ab45-49eded6a87be",
      "ClusterId": "cks-d1eh******zq9ib",
      "Status": "running",
      "ClusterName": "cecloud-cks-******",
      "ClusterType": null,
      "KubernetesVersion": null,
      "RunTime": {
          "Name": "docker",
          "Version": "1.0"
      },
      "Addons": [
      {
          "AddonType": "network",
          "AddonName": "flannel"
      }
      ],
      "ZoneId": "可用区 01",
      "ClusterDomain": "cluster.local",
      "ProxyMode": "IPVS",
      "ServiceCidr": "172.16.0.0/16",
      "VpcId": "vpc-nm73dswd7d",
      "SubnetId": "snet-14yxg8imx7",
      "PodCidr": "10.0.0.0/8",
      "Nodes": [
          "vk-cks-d1ehlm******9ib"
      ],
    "CreateTime": "2021-12-27T10:37:41+08:00",
      "UpdateTime": null,
      "ClusterSize": 1,
      "ApiServerAddr": "",
      "Description": null
}

1.6 GetKubeConfig

调用 GetKubeConfig 接口获取集群的 kubeconfig 文件。

1.6.1 使用说明

GET https://{Endpoint}/cks/v1.0/clusters/{ClusterId}/kubeconfig

1.6.2 请求参数

表1-13 url 中的请求参数

表1-14 header 中请求参数

1.6.3 返回数据

1.6.4 错误码

1.6.5 示例

1. 请求示例
GET https://{Endpoint}/cks/v1.0/clusters/cks-o2******nqxk5jh/kubeconfig
2. 正常返回示例
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId": "71e69b56-32be-4412-ab45-49eded6a87be",
"KubeConfig": "apiVersion: v1......"
}

意见反馈

文档内容是否对您有帮助？

如您有其他疑问，您也可以通过在线客服来与我们联系探讨在线客服