tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeEdgeLogSwitches

Last updated: 2024-11-14 14:51:50

    1. API Description

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

    This API is used to query the status of event storage, cluster auditing and logging.

    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: DescribeEdgeLogSwitches.
    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.
    ClusterIds.N Yes Array of String List of cluster IDs

    3. Output Parameters

    Parameter Name Type Description
    SwitchSet Array of String Array of TKE Edge cluster log switches
    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 API examples of switch list

    This example shows you how to query the edge cluster log switch.

    Input Example

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

{
    "ClusterIds": [
        "cls-xxx1",
        "cls-xxx2"
    ]
}

    Output Example

    {
    "Response": {
        "SwitchSet": [
            "logsetid: 8hhy32hru27"
        ],
        "RequestId": "iu3u89fvfsyr37819hi9"
    }
}

    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.RBACForbidden The sub-account does not have the required RBAC permissions.
    InternalError Internal error.
    InternalError.KubernetesClientBuildError Failed to create the kubernetes client.
    InternalError.KubernetesGetOperationError Failed to obtain the kubernetes resources
    InternalError.Param Parameter error.
    UnsupportedOperation Unsupported operation.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy