1. 接口描述
接口请求域名: tke.tencentcloudapi.com 。
获取边缘脚本链接,此接口用于添加第三方节点,通过下载脚本从而将节点添加到边缘集群。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeTKEEdgeScript。 |
Version | 是 | String | 公共参数,本接口取值:2018-05-25。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-guangzhou, ap-nanjing, ap-shanghai, ap-singapore 。 |
ClusterId | 是 | String | 集群id 示例值:cls-e55paxnt |
Interface | 是 | String | 网卡名,指定边缘节点上kubelet向apiserver注册使用的网卡 示例值:eth0 |
NodeName | 否 | String | 节点名字 示例值:node |
Config | 否 | String | json格式的节点配置 |
ScriptVersion | 否 | String | 可以下载某个历史版本的edgectl脚本,默认下载最新版本,edgectl版本信息可以在脚本里查看 示例值:v_20220725193138 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Link | String | 下载链接 示例值:www.tencent.com |
Token | String | 下载需要的token 示例值:eyJhbGciOiJIUzI1NiIsInR5cCI6I |
Command | String | 下载命令 示例值:wget www.tencent.com |
ScriptVersion | String | edgectl脚本版本,默认拉取最新版本 注意:此字段可能返回 null,表示取不到有效值。 示例值:v_20220725193138 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取边缘脚本链接
获取边缘集群添加节点的脚本链接
输入示例
POST / HTTP/1.1
Host: tke.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTKEEdgeScript
<公共请求参数>
{
"Interface": "eth0",
"Config": "{\"Interface\":\"\",\"RuntimePath\":\"/var/lib/docker\",\"EdgeClusterVersion\":\"2.2\",\"TTL\":\"24h\", \"SkipInstallRuntime\":true}",
"ClusterId": "cls-qbc3zefo",
"NodeName": "node"
}
输出示例
{
"Response": {
"Link": "www.tencent.com",
"Token": "eyJhbGciOiJIUzI1NiIsInR5cCI6I",
"Command": "wget www.tencent.com",
"RequestId": "eac6b301-a322-493a-8e36-83b295459397",
"ScriptVersion": "2022112323123"
}
}
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 | 操作失败。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
LimitExceeded | 超过配额限制。 |
MissingParameter | 缺少参数错误。 |
ResourceInUse | 资源被占用。 |
ResourceNotFound | 资源不存在。 |
ResourceUnavailable | 资源不可用。 |
UnauthorizedOperation | 未授权操作。 |
UnknownParameter | 未知参数错误。 |
UnsupportedOperation | 操作不支持。 |