tencent cloud

masukan

DescribeEdgeClusterUpgradeInfo

Terakhir diperbarui:2024-11-14 14:51:52

    1. API Description

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

    This API is used to query the upgrade information of an edge cluster, including the upgradeable components, the current upgrade status, and errors occur during the upgrade.

    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: DescribeEdgeClusterUpgradeInfo.
    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. This API only supports: ap-beijing, ap-guangzhou, ap-nanjing, ap-shanghai, ap-singapore.
    ClusterId Yes String Cluster ID
    EdgeVersion Yes String Target TKEEdge version

    3. Output Parameters

    Parameter Name Type Description
    ComponentVersion String Upgradable cluster components and their versions
    Note: This field may return "null", indicating that no valid value can be obtained.
    EdgeVersionCurrent String Current version of the edge cluster
    Note: This field may return null, indicating that no valid value can be obtained.
    RegistryPrefix String Prefix of the image registry of an edge component (including domain name and namespace)
    Note: This field may return null, indicating that no valid value can be obtained.
    ClusterUpgradeStatus String Cluster upgrade status. Valid values: Running, Updating, Failed
    Note: This field may return null, indicating that no valid value can be obtained.
    ClusterUpgradeStatusReason String Reason for Updating or Failed
    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 Querying upgrade information of an edge cluster

    Input Example

    POST / HTTP/1.1
    Host: tke.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeEdgeClusterUpgradeInfo
    <Common request parameters>
    
    {
        "EdgeVersion": "1.0.2",
        "ClusterId": "cls-xxxxxx"
    }
    

    Output Example

    {
        "Response": {
            "RequestId": "67a0dd10-ef28-49a1-8834-7a5fa7a9bac0",
            "EdgeVersionCurrent": "1.1.0",
            "ComponentVersion": "{\"hyperkube\":{},\"kube-proxy\":{},\"coredns\":{\"InitImageName\":\"\",\"InitImageVersion\":\"\",\"ImageName\":\"\",\"ImageVersion\":\"1.6.7\"},\"flannel\":{\"InitImageName\":\"\",\"InitImageVersion\":\"\",\"ImageName\":\"\",\"ImageVersion\":\"v0.12.0-edge-2.0\"},\"gpu-plugin\":{\"ImageName\":\"\",\"ImageVersion\":\"v0.9.0\"},\"site-manager\":{\"ImageName\":\"\",\"ImageVersion\":\"v0.6.0\"},\"application-grid-controller\":{\"ImageName\":\"\",\"ImageVersion\":\"1.21.1\"},\"application-grid-wrapper\":{\"ImageName\":\"\",\"ImageVersion\":\"1.20.3\"},\"tunnel\":{\"ImageName\":\"\",\"ImageVersion\":\"v0.8.0\"},\"edge-health\":{\"ImageName\":\"\",\"ImageVersion\":\"\"},\"edge-health-admission\":{\"ImageName\":\"\",\"ImageVersion\":\"\"},\"event\":{\"ImageName\":\"\",\"ImageVersion\":\"\"},\"griddaemon\":{\"ImageName\":\"\",\"ImageVersion\":\"\"},\"metric-server\":{\"ImageName\":\"\",\"ImageVersion\":\"\"},\"standalone-metrics\":{\"ImageName\":\"\",\"ImageVersion\":\"\"},\"hpa-metrics-server\":{\"ImageName\":\"\",\"ImageVersion\":\"\"},\"tke-monitor-agent\":{\"ImageName\":\"\",\"ImageVersion\":\"20220714-3b31e8d2\"}}",
            "RegistryPrefix": "",
            "ClusterUpgradeStatus": "updating",
            "ClusterUpgradeStatusReason": "component application-grid-controller:Back-off pulling image \"ccr.ccs.tencentyun.com/tkeedge/application-grid-controller:1.21.1-x\""
        }
    }
    

    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.
    MissingParameter Missing parameter.
    UnknownParameter Unknown parameter.
    Hubungi Kami

    Hubungi tim penjualan atau penasihat bisnis kami untuk membantu bisnis Anda.

    Dukungan Teknis

    Buka tiket jika Anda mencari bantuan lebih lanjut. Tiket kami tersedia 7x24.

    Dukungan Telepon 7x24