tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeClusterEndpointStatus

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

    1. API Description

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

    Query cluster access port status (intranet / extranet access is enabled for independent clusters, and intranet access is supported for managed clusters)

    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: DescribeClusterEndpointStatus.
    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
    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).

    3. Output Parameters

    Parameter Name Type Description
    Status String The status of cluster access port. It can be Created (enabled); Creating (enabling) and NotFound (not enabled)
    Note: this field may return null, indicating that no valid value is obtained.
    ErrorMsg String Details of the error occurred while opening the access port
    Note: this field may return null, indicating that no valid value is 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 Querying the status of the cluster access port

    This example shows you how to query the status of the cluster access port.

    Input Example

    https://tke.tencentcloudapi.com/?Action=DescribeClusterEndpointStatus
&ClusterId=cls-7ph3twqe
&<Common request parameters>

    Output Example

    {
    "Response": {
        "RequestId": "eac6b301-a322-493a-8e36-83b295459397",
        "Status": "Created",
        "ErrorMsg": "error"
    }
}

    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.
    FailedOperation.KubernetesInternal Unknown Kubernetes error.
    InternalError Internal error.
    InternalError.CamNoAuth You do not have permissions.
    InternalError.ClusterNotFound Cluster not found.
    InternalError.ClusterState Cluster status error.
    InternalError.KubeClientConnection Failed to connect to the user’s Kubernetes cluster.
    InternalError.KubeCommon Kubernetes API error.
    InternalError.KubernetesInternal Unknown Kubernetes error
    InternalError.Param Parameter error.
    InternalError.UnexpectedInternal Unknown internal error.
    InternalError.VpcCommon VPC 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
    UnauthorizedOperation Unauthorized operation.
    UnknownParameter Unknown parameter.
    UnsupportedOperation Unsupported operation.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy