tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeExternalNodeSupportConfig

Last updated: 2024-11-14 14:51:38

1. API Description

Domain name for API request: tke.tencentcloudapi.com.

This API is used to view third-party node pool configuration information.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: DescribeExternalNodeSupportConfig.
Version Yes String Common Params. The value used for this API: 2018-05-25.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
ClusterId Yes String Cluster ID

3. Output Parameters

Parameter Name Type Description
ClusterCIDR String CIDR used to assign container and service IPs for the cluster. It cannot conflict with the VPC's CIDR or the CIDRs of other clusters in the same VPC. The network segment must be within the private network segment, for example, 10.1.0.0/14, 192.168.0.1/18,172.16.0.0/16.

Note: This field may return "null", indicating that no valid value can be obtained.
NetworkType String Cluster network plugin type, support: CiliumBGP, CiliumVXLan
Note: This field may return "null", indicating that no valid value can be obtained.
SubnetId String Subnet ID

Note: This field may return "null", indicating that no valid value can be obtained.
Enabled Boolean Whether to enable third-party node direct connect support
Note: This field may return "null", indicating that no valid value can be obtained.
AS String BGP AS number of the switch to which the node belongs
Note: This field may return "null", indicating that no valid value can be obtained.
SwitchIP String Switch IP of the switch to which the node belongs
Note: This field may return "null", indicating that no valid value can be obtained.
Status String Enabling third-party node pool status
FailedReason String Reason if enabling failed
Note: This field may return "null", indicating that no valid value can be obtained.
Master String Private Network Access Address
Note: This field may return "null", indicating that no valid value can be obtained.
Proxy String Image Repository Proxy Address
Note: This field may return "null", indicating that no valid value can be obtained.
Progress Array of Step Used to record which step the enabling of external nodes process is at
Note: This field may return "null", indicating that no valid value can be obtained.
EnabledPublicConnect Boolean Whether to enable third-party node public network connection support
PublicConnectUrl String Public Network Connection Address of the registered node public network version
PublicCustomDomain String Custom Domain Name of the registered node public network version
Note: This field may return "null", indicating that no valid value can be obtained.
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Viewing the third-party node pool configuration information

Input Example

POST / HTTP/1.1
Host: tke.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeExternalNodeSupportConfig
<Common request parameters>

{
    "ClusterId": "cls-lm91rql0"
}

Output Example

{
    "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. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
InternalError.ClusterState Cluster status error.
InternalError.Param Parameter error.
InternalError.UnexpectedInternal Unknown internal error.
InvalidParameter.Param Invalid parameter.
ResourceNotFound The resource does not exist.
ResourceUnavailable.ClusterState The cluster’s status does support this operation.
UnsupportedOperation.NotInWhitelist The user is not in the allowlist.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy