tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateEksLogConfig

Last updated: 2024-11-14 14:53:01

1. API Description

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

This API is used to create Log Collection Configuration for Elastic Cluster.

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: CreateEksLogConfig.
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.
ClusterId Yes String Cluster ID
LogConfig Yes String Log collection configuration in json form
LogsetId No String Logset ID

3. Output Parameters

Parameter Name Type Description
TopicId String Log collection topicid
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 Creating a log collection rule for an Elastic Cluster

This example shows you how to create a log collection rule for an Elastic Cluster.

Input Example

https://tke.tencentcloudapi.com/?Action=CreateEksLogConfig
&LogConfig={\"apiVersion\":\"cls.cloud.tencent.com/v1\",\"kind\":\"LogConfig\",\"metadata\":{\"name\":\"stdout\"},\"spec\":{\"clsDetail\":{\"logType\":\"minimalist_log\",\"logFormat\":\"default\",\"topicId\":null,\"userDefineRule\":null,\"extractRule\":{\"timeKey\":null,\"timeFormat\":null,\"delimiter\":null,\"logRegex\":null,\"beginningRegex\":null,\"keys\":[],\"filterKeys\":[],\"filterRegex\":[],\"unMatchUpload\":\"false\",\"unMatchedKey\":null,\"backtracking\":\"0\"},\"topicName\":null,\"indexs\":[],\"region\":null},\"inputDetail\":{\"type\":\"container_stdout\",\"containerStdout\":{\"allContainers\":false,\"namespace\":null,\"workloads\":[{\"namespace\":\"default\",\"kind\":\"deployment\",\"name\":\"stdout\",\"container\":\"\"}],\"includeLabels\":null,\"container\":null,\"metadataLabels\":[]},\"containerFile\":null,\"hostFile\":null},\"kafkaDetail\":null}}
&ClusterId=cls-kaftesta
&LogsetId=tas89a94-d952-410a-a393-9224de64test
&<Common request parameters>

Output Example

{
    "Response": {
        "TopicId": "b54181b9-422e-4a6b-8ce1-30d64ddcb02b",
        "RequestId": "f12a6e20-f950-4af9-8f8b-b6329a4961c2"
    }
}

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
AuthFailure CAM signature/authentication error.
FailedOperation.ComponentClientCommon Internal client error.
FailedOperation.ComponentClientUnpack Internal HTTP decapsulation failed.
FailedOperation.CreateClsTopic Failed to create CLS topic.
FailedOperation.GetClsTopic Failed to obtain CLS log topic.
FailedOperation.KubernetesClientBuildError Failed to create the Kubernetes client.
FailedOperation.KubernetesCreateOperationError An error occurs while creating the cluster client.
FailedOperation.KubernetesGetOperationError
InternalError Internal error.
InternalError.UnexceptedInternal Internal error.
InvalidParameter Parameter error.
InvalidParameter.Param Invalid parameter.
ResourceNotFound The resource does not exist.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy