PrevNext
search by keyword

Recent Pages

Documentation
Tencent Kubernetes Engine
    Documentation
    Download PDF

    DescribeClusterEndpointVipStatus

    Last updated: 2021-02-04 18:42:34
    Download PDF

    1. API Description

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

    Query cluster open port process status (only supports external ports of the managed cluster)

    A maximum of 20 requests can be initiated per second for this API.

    Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: tke.ap-shanghai-fsi.tencentcloudapi.com

    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 parameter. The value used for this API: DescribeClusterEndpointVipStatus.
    Version Yes String Common parameter. The value used for this API: 2018-05-25.
    Region Yes String Common parameter. 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
    Status String Port operation status (Creating = in the process of creation; CreateFailed = creation has failed; Created = creation completed; Deleting = in the process of deletion; DeletedFailed = deletion has failed; Deleted = deletion completed; NotFound = operation not found)
    ErrorMsg String Reason for operation failure
    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 port enabling process

    Input Example

    https://tke.tencentcloudapi.com/?Action=DescribeClusterEndpointVipStatus
&ClusterId=cls-xxxxxxxx,
&<Common request parameters>

    Output Example

    {
  "Response": {
    "Status": "Creating",
    "ErrorMsg": "",
    "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.AccountUserNotAuthenticated Account not verified.
    InternalError.AsCommon Error creating scaling group resource.
    InternalError.CamNoAuth You do not have permissions.
    InternalError.Db DB error.
    InternalError.DbAffectivedRows Database error.
    InternalError.DbRecordNotFound Record not found.
    InternalError.DfwGetUSGCount Failed to obtain total number of current security groups.
    InternalError.DfwGetUSGQuota Failed to obtain security group quota.
    InternalError.ImageIdNotFound Image not found.
    InternalError.Param Parameter error.
    InternalError.UnexceptedInternal Internal error.
    InternalError.UnexpectedInternal Unknown internal error.
    InvalidParameter Parameter error.
    InvalidParameter.AsCommonError Auto scaling group creation parameter error.
    InvalidParameter.Param Invalid parameter.
    OperationDenied Operation denied.
    ResourceInUse The resource is occupied.
    ResourceNotFound The resource does not exist.
    ResourceUnavailable Resource is unavailable
    UnsupportedOperation Unsupported operation.
    tencent
    Copyright © 2013-2021 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy