tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeTKEEdgeScript

Last updated: 2024-11-14 14:49:14

    1. API Description

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

    This API is used to query the URL of TKE edge script. You can add external nodes to a TKE Edge cluster by downloading the URL.

    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: DescribeTKEEdgeScript.
    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
    Interface Yes String Network Card Name, specifies the network card used by the kubelet on edge nodes to register with the apiserver.
    NodeName No String Name of the name
    Config No String Node configuration in JSON format
    ScriptVersion No String A legacy version of edgectl script can be downloaded. The latest version is downloaded by default. The version information can be checked in the script.

    3. Output Parameters

    Parameter Name Type Description
    Link String Whether to download the link
    Token String Whether to download the desired token
    Command String Whether to download the command
    ScriptVersion String Version of edgectl script. The latest version is obtained by default.
    Note: This field may return null, indicating that no valid values 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 the URL of TKE Edge script

    This example shows you how to obtain the URL to download scripts used to add nodes to an edge cluster.

    Input Example

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

{
    "Interface": "eth0",
    "Config": "{\"Interface\":\"\",\"RuntimePath\":\"/var/lib/docker\",\"EdgeClusterVersion\":\"2.2\",\"TTL\":\"24h\", \"SkipInstallRuntime\":true}",
    "ClusterId": "cls123",
    "NodeName": "node"
}

    Output Example

    {
    "Response": {
        "Link": "www.tencent.com",
        "Token": "123456",
        "Command": "wget www.tencent.com",
        "RequestId": "eac6b301-a322-493a-8e36-83b295459397",
        "ScriptVersion": "2022112323123"
    }
}

    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.
    InvalidParameter Parameter error.
    LimitExceeded Quota limit is exceeded.
    MissingParameter Missing parameter.
    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