1. 接口描述
接口请求域名: tke.tencentcloudapi.com 。
获取第三方节点添加脚本
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeExternalNodeScript。 |
| Version | 是 | String | 公共参数,本接口取值:2018-05-25。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| ClusterId | 是 | String | 集群ID 示例值:cls-abcd1234 |
| NodePoolId | 是 | String | 节点池ID 示例值:np-abcd1234 |
| Interface | 否 | String | 网卡名 示例值:eth0 |
| Name | 否 | String | 节点名称 示例值:node-1.1.1.1 |
| Internal | 否 | Boolean | 是否内网获取节点初始化脚本 示例值:false |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Link | String | 添加脚本cos下载链接 |
| Token | String | cos临时密钥 示例值:UAkOh6wCxzr8M8zf |
| Command | String | 添加脚本下载命令 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查看第三方节点列表
输入示例
POST / HTTP/1.1
Host: tke.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeExternalNodeScript
<公共请求参数>
{
"ClusterId": "cls-lm91rql0",
"NodePoolId": "np-0nwzqj10",
"Interface": "eth0",
"Name": "node1"
}
输出示例
{
"Response": {
"RequestId": "48849133-f394-4c4c-9891-f013e209c025",
"Link": "https://tke-edge-1253687700.cos.ap-guangzhou.myqcloud.com/user-pkgs%2Fcls-19zn81yu3321337994100018114712ap-guangzhou%2Fadd2tkectl?sign=q-sign-algorithm%3Dsha1%26q-ak%3DAKIDTeaJo55GyQgvzojguuSl24qNey3wa7NN%26q-sign-time%3D1618561008%3B1618564608%26q-key-time%3D1618561008%3B1618564608%26q-header-list%3Dx-cos-token%26q-url-param-list%3D%26q-signature%3D7994096869abf8492c0c6cbc68f93701bab7ac4f",
"Token": "UAkOh6wCxzr8M8zf",
"Command": "wget --header=\"x-cos-token:UAkOh6wCxzr8M8zf\" https://tke-edge-1253687700.cos.ap-guangzhou.myqcloud.com/user-pkgs%2Fcls-19zn81yu3321337994100018114712ap-guangzhou%2Fadd2tkectl?sign=q-sign-algorithm%3Dsha1%26q-ak%3DAKIDTeaJo55GyQgvzojguuSl24qNey3wa7NN%26q-sign-time%3D1618561008%3B1618564608%26q-key-time%3D1618561008%3B1618564608%26q-header-list%3Dx-cos-token%26q-url-param-list%3D%26q-signature%3D7994096869abf8492c0c6cbc68f93701bab7ac4f -O add2tkectl && chmod +x add2tkectl"
}
}
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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError.UnexpectedInternal | 未知的内部错误。 |
| InvalidParameter.Param | 参数错误。 |
| LimitExceeded.QuotaMaxNodLimit | 超过配额限制 |
| ResourceNotFound.ClusterNotFound | 集群不存在。 |
| ResourceUnavailable.ClusterState | 集群状态不支持该操作。 |