用户指南

最佳实践

API 文档

扩展集群节点

最近更新时间:2021-08-03 08:09:14

我的收藏

1. 接口描述

接口请求域名: tke.tencentcloudapi.com 。

扩展(新建)集群节点

默认接口请求频率限制:20次/秒。

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:tke.ap-shanghai-fsi.tencentcloudapi.com。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateClusterInstances。
Version String 公共参数,本接口取值:2018-05-25。
Region String 公共参数,详见产品支持的 地域列表
ClusterId String 集群 ID,请填写 查询集群列表 接口中返回的 clusterId 字段
RunInstancePara String CVM创建透传参数,json化字符串格式,如需要保证扩展集群节点请求幂等性需要在此参数添加ClientToken字段,详见CVM创建实例接口。
InstanceAdvancedSettings InstanceAdvancedSettings 实例额外需要设置参数信息
SkipValidateOptions.N Array of String 校验规则相关选项,可配置跳过某些校验规则。目前支持GlobalRouteCIDRCheck(跳过GlobalRouter的相关校验),VpcCniCIDRCheck(跳过VpcCni相关校验)

3. 输出参数

参数名称 类型 描述
InstanceIdSet Array of String 节点实例ID
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 扩展集群节点示例

输入示例

https://tke.tencentcloudapi.com/?Action=CreateClusterInstances
&ClusterId=cls-xxxxxxxx
&RunInstancePara={"Placement":{"Zone":"ap-guangzhou-4"},"InstanceType":"S3.SMALL1"}
&<公共请求参数>

输出示例

{
"Response": {
  "InstanceIdSet": [
    "ins-xxxxxxxx"
  ],
  "RequestId": "eac6b301-a322-493a-8e36-83b295459397"
}
}

示例2 添加集群节点(多块数据盘)

添加带有多个数据盘的节点到集群
注意1: InstanceAdvancedSettings设置DataDisks, 多盘数据盘挂载信息,后端会根据盘的类型、大小匹配数据盘ID,将对应的路径挂载
注意2: RunInstancePara设置DataDisks, 此参数透传给CVM,购买多块数据盘
注意3: InstanceAdvancedSettings的MountTarget早期是支持单盘的,多盘场景废弃,无需填写

输入示例

POST / HTTP/1.1
Host: tke.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateClusterInstances
<公共请求参数>
{
  "InstanceAdvancedSettings": {
      "DataDisks": [
          {
              "AutoFormatAndMount": true,
              "DiskSize": 50,
              "DiskType": "CLOUD_PREMIUM",
              "FileSystem": "ext4",
              "MountTarget": "/data2"
          },
          {
              "AutoFormatAndMount": true,
              "DiskSize": 120,
              "DiskType": "CLOUD_PREMIUM",
              "FileSystem": "ext4",
              "MountTarget": "/data4"
          },
          {
              "AutoFormatAndMount": true,
              "DiskSize": 100,
              "DiskType": "CLOUD_PREMIUM",
              "FileSystem": "ext4",
              "MountTarget": "/data3"
          },
          {
              "AutoFormatAndMount": true,
              "DiskSize": 50,
              "DiskType": "CLOUD_PREMIUM",
              "FileSystem": "ext4",
              "MountTarget": "/data5"
          }
      ],
      "DockerGraphPath": "/var/lib/docker",
      "MountTarget": "/var/lib/docker",
      "Unschedulable": 0,
      "UserScript": ""
  },
  "SkipValidateOptions": [
      "GlobalRouteCIDRCheck",
      "VpcCniCIDRCheck"
  ],
  "RunInstancePara": "xx",
  "ClusterId": "cls-xxxxx"
}

输出示例

{
"Response": {
  "InstanceIdSet": [
    "ins-xxxxxxxx"
  ],
  "RequestId": "eac6b301-a322-493a-8e36-83b295459397"
}
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation 操作失败。
InternalError 内部错误。
InternalError.AccountCommon 获取用户认证信息失败。
InternalError.AccountUserNotAuthenticated 账户未通过认证。
InternalError.ClusterNotFound 集群未找到。
InternalError.ClusterState 集群状态错误。
InternalError.ComponentClinetHttp 请求(http请求)其他云服务失败。
InternalError.CvmCommon cvm创建节点报错。
InternalError.CvmNotFound cvm不存在。
InternalError.Db db错误。
InternalError.DbAffectivedRows DB错误。
InternalError.DbRecordNotFound 记录未找到。
InternalError.ImageIdNotFound 镜像未找到。
InternalError.OsNotSupport 镜像OS不支持。
InternalError.Param Param。
InternalError.QuotaMaxClsLimit 超过配额限制。
InternalError.QuotaMaxNodLimit 超过配额限制。
InternalError.QuotaMaxRtLimit 超过配额限制。
InternalError.UnexceptedInternal 内部错误。
InternalError.UnexpectedInternal 未知的内部错误。
InternalError.VpcCommon VPC报错。
InternalError.VpcPeerNotFound 对等连接不存在。
InternalError.VpcRecodrNotFound 未发现vpc记录。
InvalidParameter 参数错误。
MissingParameter 缺少参数错误。
ResourceInUse 资源被占用。
ResourceNotFound 资源不存在。
ResourceUnavailable 资源不可用。
UnauthorizedOperation 未授权操作。
UnknownParameter 未知参数错误。
UnsupportedOperation 操作不支持。
目录