tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateClusterEndpointVip

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

    1. API Description

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

    This API is used to create a public network access port for a managed cluster. Note: This API will be disused soon. Please call CreateClusterEndpoint instead.

    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: CreateClusterEndpointVip.
    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
    SecurityPolicies.N No Array of String Security policy opens single IP or CIDR to the Internet (for example: '192.168.1.0/24', with 'reject all' as the default).

    3. Output Parameters

    Parameter Name Type Description
    RequestFlowId Integer Request job's FlowId
    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 Setting up public network access for a managed cluster

    This example shows you how to set up public network access for a managed cluster.

    Input Example

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

{
    "ClusterId": "cls-xxxxxxxx"
}

    Output Example

    {
    "Response": {
        "RequestFlowId": "100000",
        "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.
    InternalError.CamNoAuth You do not have permissions.
    InternalError.ClusterNotFound Cluster not found.
    InternalError.ClusterState Cluster status error.
    InternalError.CvmCommon Error in node creation.
    InternalError.CvmNotFound CVM does not exist.
    InternalError.UnexpectedInternal Unknown internal error.
    InvalidParameter Parameter error.
    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