tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateTKEEdgeCluster

Last updated: 2024-11-14 14:49:29

    1. API Description

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

    This API is used to create a TKE Edge cluster.

    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: CreateTKEEdgeCluster.
    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. This API only supports: ap-beijing, ap-guangzhou, ap-nanjing, ap-shanghai, ap-singapore.
    K8SVersion Yes String
    VpcId Yes String VPC ID
    ClusterName Yes String Cluster name
    PodCIDR Yes String Cluster Pod CIDR block
    ServiceCIDR Yes String Cluster service CIDR block
    ClusterDesc No String Cluster description
    ClusterAdvancedSettings No EdgeClusterAdvancedSettings Cluster advanced settings
    MaxNodePodNum No Integer Maximum number of Pods on the node
    PublicLB No EdgeClusterPublicLB Public LB of the TKE Edge cluster
    ClusterLevel No String Cluster specification level
    AutoUpgradeClusterLevel No Boolean Whether auto upgrade is supported
    ChargeType No String Cluster billing mode
    EdgeVersion No String Edge cluster version. It is the set of versions of all cluster components.
    RegistryPrefix No String Prefix of the image registry of an edge component
    TagSpecification No TagSpecification Tags bound with the cluster

    3. Output Parameters

    Parameter Name Type Description
    ClusterId String TKE Edge cluster ID
    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 an edge compute cluster

    This example shows you how to create an edge compute cluster.

    Input Example

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

{
    "ClusterName": "for_test",
    "PodCIDR": "172.16.0.0/20",
    "VpcId": "vpc-xxx",
    "ServiceCIDR": "192.168.0.0/18",
    "K8SVersion": "1.12.4"
}

    Output Example

    {
    "Response": {
        "ClusterId": "cls-xxx",
        "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.
    InternalError Internal error.
    InvalidParameter Parameter error.
    LimitExceeded Quota limit is exceeded.
    MissingParameter Missing parameter.
    ResourceInUse The resource is occupied.
    ResourceNotFound The resource does not exist.
    ResourceUnavailable Resource is unavailable
    UnauthorizedOperation Unauthorized operation.
    UnknownParameter Unknown parameter.
    UnsupportedOperation Unsupported operation.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy