tencent cloud

文档反馈

DescribeClusterEndpointStatus

最后更新时间:2023-09-18 16:00:28

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 No String Common Params. This parameter is not required for this API.
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, which is returned for each request. 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.
联系我们

联系我们,为您的业务提供专属服务。

技术支持

如果你想寻求进一步的帮助,通过工单与我们进行联络。我们提供7x24的工单服务。

7x24 电话支持