1. 接口描述
此接口处于预下线状态 。
预计下线时间:2024-09-12 10:54:37
接口请求域名: tke.tencentcloudapi.com 。
tdcc接口已迁移至tdcc产品下,tke下的接口下线
获取导入第三方集群YAML定义
默认接口请求频率限制:20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeExternalClusterSpec。 |
Version | 是 | String | 公共参数,本接口取值:2018-05-25。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
ClusterId | 是 | String | 注册集群ID 示例值:cls-65r1c5nu |
IsExtranet | 否 | Boolean | 默认false 获取内网,是否获取外网版注册命令 示例值:false |
IsRefreshExpirationTime | 否 | Boolean | 默认false 不刷新有效时间 ,true刷新有效时间 示例值:false |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Spec | String | 导入第三方集群YAML定义 示例值:xxx |
Expiration | String | agent.yaml文件过期时间字符串,时区UTC 示例值:2021-09-08T07:04:51Z |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取导入第三方集群YAML定义
输入示例
POST / HTTP/1.1
Host: tke.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeExternalClusterSpec
<公共请求参数>
{
"ClusterId": "cls-xxx",
"IsExtranet": false,
"IsRefreshExpirationTime": false
}
输出示例
{
"Response": {
"RequestId": "eac6b301-a322-493a-8e36-83b295459397",
"Spec": "xxxx",
"Expiration": "2021-09-08T07:04:51Z"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError | 内部错误。 |
InternalError.CamNoAuth | 没有权限。 |
InternalError.Db | db错误。 |
InternalError.KubernetesClientBuildError | kubernetes client建立失败。 |
InternalError.KubernetesCreateOperationError | 创建Kubernetes资源失败。 |
InternalError.KubernetesDeleteOperationError | 删除Kubernetes资源失败。 |
InternalError.UnexpectedInternal | 未知的内部错误。 |
InternalError.WhitelistUnexpectedError | 白名单未知错误。 |
InvalidParameter | 参数错误。 |
InvalidParameter.ClusterNotFound | 集群ID不存在。 |
InvalidParameter.Param | 参数错误。 |
ResourceNotFound.ClusterNotFound | 集群不存在。 |
ResourceNotFound.KubernetesResourceNotFound | 未找到该kubernetes资源。 |
ResourceUnavailable.ClusterState | 集群状态不支持该操作。 |
UnauthorizedOperation.CamNoAuth | 无该接口CAM权限。 |