tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeClusterEndpoints

Last updated: 2024-11-14 14:53:33

    1. API Description

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

    This API is used to query cluster access addresses, including private network address, public network address, public network domain name, and security policy for public network access.

    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: DescribeClusterEndpoints.
    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
    CertificationAuthority String CA certificate of cluster APIServer
    ClusterExternalEndpoint String Public network access address of cluster APIServer
    ClusterIntranetEndpoint String Private network access address of cluster APIServer
    ClusterDomain String Domain name of cluster APIServer
    Note: This field may return null, indicating that no valid values can be obtained.
    ClusterExternalACL Array of String Public network access ACL of cluster APIServer
    Note: This field may return null, indicating that no valid values can be obtained.
    ClusterExternalDomain String Public network domain name
    Note: This field may return null, indicating that no valid values can be obtained.
    ClusterIntranetDomain String Private network domain name
    Note: This field may return null, indicating that no valid values can be obtained.
    SecurityGroup String Public network security group
    Note: This field may return null, indicating that no valid values can be obtained.
    ClusterIntranetSubnetId String Subnet for Private Network Access
    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 Obtaining cluster access addresses

    This example shows you how to obtain cluster access addresses.

    Input Example

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

{
    "ClusterId": "cls-65r1c5nu"
}

    Output Example

    {
    "Response": {
        "CertificationAuthority": "",
        "ClusterIntranetDomain": "cls.domain",
        "ClusterExternalDomain": "cls.domain",
        "SecurityGroup": "sg-2quou3re",
        "ClusterExternalEndpoint": "12.34.56.78",
        "ClusterIntranetEndpoint": "10.0.0.1",
        "ClusterDomain": "cls-65r1c5nu.ccs.tencent-cloud.com",
        "ClusterExternalACL": [
            "10.0.0.0/24"
        ],
        "ClusterIntranetSubnetId": "subnet-xxxxx",
        "RequestId": "33483fde-efec-4d3c-8ff6-340d9dbc2d01"
    }
}

    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.ComponentClientHttp Internal HTTP client error.
    FailedOperation.KubeCommon Kubernetes API error.
    FailedOperation.KubernetesClientBuildError Failed to create the Kubernetes client.
    InternalError Internal error.
    InternalError.ComponentClientHttp Internal HTTP client error
    InternalError.KubeClientConnection Failed to connect to the user’s Kubernetes cluster.
    InternalError.UnexpectedInternal Unknown internal error.
    InvalidParameter Parameter error.
    InvalidParameter.Param Invalid parameter.
    ResourceNotFound.ClusterNotFound The cluster does not exist.
    ResourceNotFound.KubeResourceNotFound The specified resource is not found in the Kubernetes cluster.
    ResourceUnavailable.ClusterInAbnormalStat Abnormal cluster status.
    UnauthorizedOperation.CamNoAuth The API has no CAM permissions.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy