1. 接口描述
接口请求域名: tke.tencentcloudapi.com 。
创建集群访问端口
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateClusterEndpoint。 |
Version | 是 | String | 公共参数,本接口取值:2018-05-25。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
ClusterId | 是 | String | 集群ID 示例值:cls-xxxxxxxx |
SubnetId | 否 | String | 集群端口所在的子网ID (仅在开启非外网访问时需要填,必须为集群所在VPC内的子网) 示例值:subnet-xxxxxx |
IsExtranet | 否 | Boolean | 是否为外网访问(TRUE 外网访问 FALSE 内网访问,默认值: FALSE) 示例值:true |
Domain | 否 | String | 设置域名 示例值:cls.domain.com |
SecurityGroup | 否 | String | 使用的安全组,只有外网访问需要传递(开启外网访问时必传) 示例值:sg-xxx |
ExtensiveParameters | 否 | String | 创建lb参数,只有外网访问需要设置,是一个json格式化后的字符串:{"InternetAccessible":{"InternetChargeType":"TRAFFIC_POSTPAID_BY_HOUR","InternetMaxBandwidthOut":200},"VipIsp":"","BandwidthPackageId":""}。 各个参数意义: InternetAccessible.InternetChargeType含义:TRAFFIC_POSTPAID_BY_HOUR按流量按小时后计费;BANDWIDTH_POSTPAID_BY_HOUR 按带宽按小时后计费;InternetAccessible.BANDWIDTH_PACKAGE 按带宽包计费。 InternetMaxBandwidthOut含义:最大出带宽,单位Mbps,范围支持0到2048,默认值10。 VipIsp含义:CMCC | CTCC | CUCC,分别对应 移动 | 电信 | 联通,如果不指定本参数,则默认使用BGP。可通过 DescribeSingleIsp 接口查询一个地域所支持的Isp。如果指定运营商,则网络计费式只能使用按带宽包计费BANDWIDTH_PACKAGE。 BandwidthPackageId含义:带宽包ID,指定此参数时,网络计费方式InternetAccessible.InternetChargeType只支持按带宽包计费BANDWIDTH_PACKAGE。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建集群访问端口
创建集群访问端口
输入示例
POST / HTTP/1.1
Host: tke.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateClusterEndpoint
<公共请求参数>
{
"SubnetId": "subnet-xxxxxx",
"ClusterId": "cls-xxxxxxxx",
"IsExtranet": true,
"SecurityGroup": "sg-xxxxx",
"ExtensiveParameters": "{\"InternetAccessible\":{\"InternetChargeType\":\"TRAFFIC_POSTPAID_BY_HOUR\",\"InternetMaxBandwidthOut\":200}}"
}
输出示例
{
"Response": {
"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。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
FailedOperation.KubeClientConnection | 连接用户Kubernetes集群失败。 |
InternalError | 内部错误。 |
InternalError.CamNoAuth | 没有权限。 |
InternalError.ClusterState | 集群状态错误。 |
InternalError.Db | db错误。 |
InternalError.EmptyClusterNotSupport | 不支持空集群。 |
InternalError.Param | Param。 |
InternalError.UnexpectedInternal | 未知的内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameter.Param | 参数错误。 |
LimitExceeded | 超过配额限制。 |
MissingParameter | 缺少参数错误。 |
OperationDenied | 操作被拒绝。 |
ResourceInUse | 资源被占用。 |
ResourceNotFound | 资源不存在。 |
ResourceUnavailable | 资源不可用。 |
ResourceUnavailable.ClusterState | 集群状态不支持该操作。 |
UnauthorizedOperation | 未授权操作。 |
UnknownParameter | 未知参数错误。 |
UnsupportedOperation | 操作不支持。 |