tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateClusterEndpoint

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

    1. API Description

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

    This API is used to create a cluster access endpoint.

    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: CreateClusterEndpoint.
    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
    SubnetId No String The ID of the subnet where the cluster's port is located (only needs to be entered when the non-public network access is enabled, and must be within the subnet of the cluster's VPC).
    IsExtranet No Boolean Whether public network access is enabled or not (True = public network access, FALSE = private network access, with the default value as FALSE).
    Domain No String The domain name
    SecurityGroup No String The security group in use, which must be passed in when public access is enabled.
    ExtensiveParameters No String LB parameters in a JSON string. It is only required for public network access: {"InternetAccessible":{"InternetChargeType":"TRAFFIC_POSTPAID_BY_HOUR","InternetMaxBandwidthOut":200},"VipIsp":"","BandwidthPackageId":""}.
    Description of parameters:
    InternetAccessible.InternetChargeType: TRAFFIC_POSTPAID_BY_HOUR (Pay-as-you-go by traffic on an hourly basis); BANDWIDTH_POSTPAID_BY_HOUR (Pay-as-you-go by bandwidth on an hourly basis); InternetAccessible.BANDWIDTH_PACKAGE (Bill-by-bandwidth package).
    InternetMaxBandwidthOut: Outbound bandwidth cap in Mbps. Value range: 0 - 2048. Default value: 10.
    VipIsp: CMCC (China Mobile), CTCC·(China Telecom) and CUCC (China Unicom). If it is not specified, BGP line is used by default. To query ISPs available in a region, call DescribeSingleIsp. If this parameter is specified, the network billing mode must be BANDWIDTH_PACKAGE.
    BandwidthPackageId: Bandwidth package ID. If this parameter is specified, only BANDWIDTH_PACKAGE is supported for InternetAccessible.InternetChargeType.

    3. Output Parameters

    Parameter Name Type Description
    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 Creating a cluster access endpoint

    This example shows you how to create a cluster access endpoint.

    Input Example

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

{
    "SubnetId": "subnet-xxxxxx",
    "ClusterId": "cls-xxxxxxxx",
    "IsExtranet": true,
    "SecurityGroup": "sg-xxxxx",
    "ExtensiveParameters": "{\"InternetAccessible\":{\"InternetChargeType\":\"TRAFFIC_POSTPAID_BY_HOUR\",\"InternetMaxBandwidthOut\":200}}"
}

    Output Example

    {
    "Response": {
        "RequestId": "eac6b301-a322-493a-8e36-83b295459397"
    }
}

    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
    FailedOperation Operation failed.
    FailedOperation.KubeClientConnection Failed to connect to the customer Kubernetes cluster.
    InternalError Internal error.
    InternalError.CamNoAuth You do not have permissions.
    InternalError.ClusterState Cluster status error.
    InternalError.Db DB error.
    InternalError.EmptyClusterNotSupport Empty clusters are not supported.
    InternalError.Param Parameter error.
    InternalError.UnexpectedInternal Unknown internal error.
    InvalidParameter Parameter error.
    InvalidParameter.Param Invalid parameter.
    LimitExceeded Quota limit is exceeded.
    MissingParameter Missing parameter.
    OperationDenied Operation denied.
    ResourceInUse The resource is occupied.
    ResourceNotFound The resource does not exist.
    ResourceUnavailable Resource is unavailable
    ResourceUnavailable.ClusterState The cluster’s status does support this operation.
    UnauthorizedOperation Unauthorized operation.
    UnknownParameter Unknown parameter.
    UnsupportedOperation Unsupported operation.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy