1. 接口描述
接口请求域名: dlc.tencentcloudapi.com 。
通过 ClusterType 区分两种导入模式:TKE(直接导入裸 TKE 集群,ClusterId 为 TKE 集群 ID)或 EMR(通过 EMR 集群导入,ClusterId 为 EMR 集群 ID,底层会关联查询对应的 TKE 集群 ID 一并落库)。两种模式均将 TKE 集群 ID 存入 tke_cluster 表。接口是异步的,返回的 WorkflowId 可用于轮询注册进度;ResourcePoolId / ResourcePoolCode 为资源池的唯一标识。
默认接口请求频率限制:20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:ImportExternalCluster。 |
| Version | 是 | String | 公共参数,本接口取值:2021-01-25。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-chongqing, ap-guangzhou, ap-shanghai, ap-singapore 。 |
| PartitionName | 是 | String | 资源池对应的分区名称。 示例值:PartitionTest |
| ClusterType | 是 | String | 集群类型。TKE:直接导入裸 TKE 集群,ClusterId 填 TKE 集群 ID(如 cls-xxxxxxxx);EMR:通过 EMR 集群导入,ClusterId 填 EMR 集群 ID(如 emr-xxxxxxxx)。 示例值:TKE |
| ClusterId | 是 | String | 集群 ID。ClusterType=TKE 时填 TKE 集群 ID(如 cls-xxxxxxxx);ClusterType=EMR 时填 EMR 集群 ID(如 emr-xxxxxxxx)。 示例值:cls-m6fgdp2o |
| CosBucketId | 否 | String | COS Bucket 名称(含 AppId 后缀),例如 my-bucket-1250000000。 示例值:aidanyxu-260209337 |
| PrometheusInstanceId | 否 | String | Prometheus 托管实例 ID,例如 prom-xxxxxxxx。 示例值:prom-8r1jdbdk |
| LoadBalancerId | 否 | String | 负载均衡实例 ID,例如 lb-xxxxxxxx。 示例值:lb-1vuex1zi |
| NodeLabels.N | 否 | Array of KVPair | 节点标签键值对(Key-Value 列表),用于将资源池调度限定到具备对应标签的节点。 |
| PartitionDescription | 否 | String | 资源池对应的默认分区描述,透传给下游 ResourceManager 用于分区创建。 示例值:PartitionDescriptionTest |
| TargetAppId | 否 | Integer | 目标账号 AppId(跨账号导入时填写,不填则使用当前账号)。TargetAppId 和 TargetUin 必须同时填写或同时不填。 示例值:120779018 |
| TargetUin | 否 | String | 目标账号 UIN(跨账号导入时填写,不填则使用当前账号)。TargetAppId 和 TargetUin 必须同时填写或同时不填。 示例值:1808365191 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ResourcePoolId | Integer | 已落库的 resource_pool 主行 ID。 示例值:48 |
| ResourcePoolCode | String | 资源池唯一编码。 示例值:dlc-3dc08527 |
| WorkflowId | Integer | 注册工作流 ID,可用于查询进度。 示例值:1558 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 ImportExternalCluster
输入示例
POST / HTTP/1.1
Host: dlc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ImportExternalCluster
<公共请求参数>
{
"PartitionName": "PartitionTest",
"ClusterType": "TKE",
"ClusterId": "cls-m6fgdp2o",
"CosBucketId": "aidanyxu-260209337",
"PrometheusInstanceId": "prom-8r1jdbdk",
"LoadBalancerId": "lb-1vuex1zi",
"NodeLabels": [
{
"Key": "testK",
"Value": "testV"
}
],
"PartitionDescription": "PartitionDescriptionTest",
"TargetAppId": 120779018,
"TargetUin": "1808365191"
}
输出示例
{
"Response": {
"ResourcePoolCode": "dlc-3dc08527",
"ResourcePoolId": 48,
"WorkflowId": 1558,
"RequestId": "89736fa1-7b00-43b3-8b72-f5b4def4d861"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.ExternalService | 外部服务异常 |
| InvalidParameter | 参数错误。 |