tencent cloud

文档反馈

DescribeEdgeLogSwitches

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

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.
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, which is returned for each request. RequestId is required for locating a problem.

4. Example

This example shows you how to query the status of log-related features.

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": [
            {
                "ClusterId": "cls-xxx2",
                "Audit": {
                    "Enable": true,
                    "TopicSet": "a0cd4067-c9a1-a895-907d-03b4025e4f2c",
                    "TopicId": "sadfssfasdf-c9a1-a895-907d-03b4025e4f2c"
                },
                "Event": {
                    "Enable": true,
                    "TopicSet": "sadfssfasdf-564f-a895-907d-03b4025e4f2c",
                    "TopicId": "sadfssfasdf-564f-a895-907d-5465tdtewrt"
                },
                "Log": {
                    "Enable": true,
                    "TopicSet": "3465345-564f-a895-907d-03b4025e4f2c",
                    "TopicId": "6750000-564f-a895-907d-03b4025e4f2c"
                }
            }
        ],
        "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.
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.
联系我们

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

技术支持

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

7x24 电话支持