容器服务查看开启第三方节点池配置信息-API 文档-文档中心-腾讯云

1. 接口描述

接口请求域名： tke.tencentcloudapi.com 。

查看开启第三方节点池配置信息

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeExternalNodeSupportConfig。
Version	是	String	公共参数，本接口取值：2018-05-25。
Region	是	String	公共参数，详见产品支持的地域列表。
ClusterId	是	String	集群Id 示例值：cls-abcd1234

3. 输出参数

参数名称	类型	描述
ClusterCIDR	String	用于分配集群容器和服务 IP 的 CIDR，不得与 VPC CIDR 冲突，也不得与同 VPC 内其他集群 CIDR 冲突。且网段范围必须在内网网段内，例如:10.1.0.0/14, 192.168.0.1/18,172.16.0.0/16。注意：此字段可能返回 null，表示取不到有效值。示例值：172.22.0.0/16
NetworkType	String	集群网络插件类型，支持：CiliumBGP、CiliumVXLan 注意：此字段可能返回 null，表示取不到有效值。示例值：Flannel
SubnetId	String	子网ID 注意：此字段可能返回 null，表示取不到有效值。示例值：subnet-drsvvxxx
Enabled	Boolean	是否开启第三方节点专线连接支持注意：此字段可能返回 null，表示取不到有效值。示例值：false
AS	String	节点所属交换机的BGP AS 号注意：此字段可能返回 null，表示取不到有效值。示例值：1001
SwitchIP	String	节点所属交换机的交换机 IP 注意：此字段可能返回 null，表示取不到有效值。示例值：1.1.1.1
Status	String	开启第三方节点池状态示例值：Initializing
FailedReason	String	如果开启失败原因注意：此字段可能返回 null，表示取不到有效值。示例值："Create Failed"
Master	String	内网访问地址注意：此字段可能返回 null，表示取不到有效值。示例值：1.1.1.1
Proxy	String	镜像仓库代理地址注意：此字段可能返回 null，表示取不到有效值。示例值：1.1.1.1
Progress	Array of Step	用于记录开启第三方节点的过程进行到哪一步了注意：此字段可能返回 null，表示取不到有效值。
EnabledPublicConnect	Boolean	是否开启第三方节点公网连接支持示例值：false
PublicConnectUrl	String	注册节点公网版公网连接地址示例值：23.142.142.24:9000
PublicCustomDomain	String	注册节点公网版自定义域名注意：此字段可能返回 null，表示取不到有效值。示例值：test.com
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查看开启第三方节点池配置信息

输入示例

POST / HTTP/1.1
Host: tke.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeExternalNodeSupportConfig
<公共请求参数>

{
    "ClusterId": "cls-lm91rql0"
}

输出示例

{
    "Response": {
        "RequestId": "4c6c63c7-b23e-4896-bf3b-6bc44dxxxxxx",
        "ClusterCIDR": "172.22.0.0/16",
        "NetworkType": "CiliumVXLan",
        "SubnetId": "subnet-drsvvxxx",
        "Enabled": true,
        "AS": "1001",
        "SwitchIP": "1.1.1.1",
        "Status": "Initializing",
        "Proxy": "1.1.1.1",
        "Master": "1.1.1.1",
        "Progress": [
            {
                "EndAt": "2021-11-05T12:40:51Z",
                "Message": "",
                "Name": "EnsureNodeMasterCommunicate",
                "StartAt": "2021-11-05T12:40:45Z",
                "Status": "success"
            },
            {
                "EndAt": "2021-11-05T12:40:52Z",
                "Message": "",
                "Name": "EnsureInClusterAccess",
                "StartAt": "2021-11-05T12:40:51Z",
                "Status": "success"
            },
            {
                "EndAt": "2021-11-05T12:40:57Z",
                "Message": "",
                "Name": "EnsureExternalNodeProxy",
                "StartAt": "2021-11-05T12:40:52Z",
                "Status": "success"
            },
            {
                "EndAt": "2021-11-05T12:40:57Z",
                "Message": "",
                "Name": "EnsureBootStrap",
                "StartAt": "2021-11-05T12:40:57Z",
                "Status": "success"
            },
            {
                "EndAt": "2021-11-05T12:40:57Z",
                "Message": "",
                "Name": "EnsureAdmissionController",
                "StartAt": "2021-11-05T12:40:57Z",
                "Status": "success"
            },
            {
                "EndAt": "2021-11-05T12:41:00Z",
                "Message": "",
                "Name": "InstallUnderlayCilium",
                "StartAt": "2021-11-05T12:40:57Z",
                "Status": "success"
            },
            {
                "EndAt": "2021-11-05T12:41:00Z",
                "Message": "",
                "Name": "CompleteEnable",
                "StartAt": "2021-11-05T12:41:00Z",
                "Status": "success"
            }
        ],
        "FailedReason": "fail"
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
InternalError.ClusterState	集群状态错误。
InternalError.Param	Param。
InternalError.UnexpectedInternal	未知的内部错误。
InvalidParameter.Param	参数错误。
ResourceNotFound	资源不存在。
ResourceUnavailable.ClusterState	集群状态不支持该操作。
UnsupportedOperation.NotInWhitelist	非白名单用户。