文档首页/ 云日志服务 LTS/ API参考/ API说明/ 日志接入/ 删除日志接入

更新时间：2024-12-20 GMT+08:00

在线调试

CLI示例

查看PDF

删除日志接入

功能介绍

删除日志接入

调用方法

请参见如何调用API。

URI

DELETE /v3/{project_id}/lts/access-config

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID，获取方式请参见：获取账号租户ID、项目资源集ID、日志组ID、日志流ID。最小长度：32 最大长度：32

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	从IAM服务获取的用户Token，获取方式请参见：获取用户Token 最小长度：1000 最大长度：2000
Content-Type	是	String	该字段填为：application/json;charset=UTF-8。最小长度：30 最大长度：30

表3 请求Body参数
参数	是否必选	参数类型	描述
access_config_id_list	是	Array of strings	日志接入ID列表最小长度：36 最大长度：36

响应参数

状态码： 200

表4 响应Body参数
参数	参数类型	描述
result	Array of AccessConfigInfo objects	日志接入列表
total	Long	日志接入总数最小值：0 最大值：1000

表5 AccessConfigInfo
参数	参数类型	描述
access_config_id	String	日志接入ID 最小长度：36 最大长度：36
access_config_name	String	日志接入名称最小长度：1 最大长度：64
access_config_type	String	日志接入类型。AGENT：主机接入
create_time	Long	创建时间最小值：1 最大值：9999999999999
access_config_detail	AccessConfigDeatilCreate object	日志接入详细信息
log_info	AccessConfigQueryLogInfo object	日志接入日志详情
host_group_info	AccessConfigHostGroupIdList object	日志接入主机组ID列表
access_config_tag	Array of accessConfigTag objects	标签信息。KEY不能重复,最多20个标签
log_split	Boolean	日志拆分
binary_collect	Boolean	二进制收集
cluster_id	String	CCE集群ID
encoding_format	String	编码格式，默认UTF-8
incremental_collect	Boolean	采集策略：增量/全量
processor_type	String	IC结构化解析类型
demo_log	String	示例日志
demo_fields	Array of DemoFieldAccess objects	示例日志解析字段
processors	Array of Processor objects	IC结构化解析器
application_id	String	ServiceStage应用ID
environment_id	String	ServiceStage环境ID
component_id	Array of strings	ServiceStage组件ID

表6 AccessConfigDeatilCreate
参数	参数类型	描述
paths	Array of strings	采集路径。路径必须以/或者字母:\开头不能包含特殊字符<> ' \| " 且不能只输入/ 第一级目录不支持通配符：不能以/* /开头 4.只能出现一次`` CCE类型中容器路径和主机路径必填，标准输出不用最小长度：1 最大长度：128* 数组长度：1 - 9
black_paths	Array of strings	采集路径黑名单。路径必须以/或者字母:\开头不能包含特殊字符<> ' \| " 且不能只输入/ 第一级目录不支持通配符：不能以/* /开头 4.只能出现一次最小长度：1 最大长度：128* 数组长度：0 - 9
format	AccessConfigFormatCreate object	日志格式。single与multi必须选择一种。
windows_log_info	AccessConfigWindowsLogInfoCreate object	日志接入采集Windows事件日志
stdout	Boolean	标准输出开关，仅CCE接入类型时使用
stderr	Boolean	标准输出开关标准错误开关，仅CCE接入类型时使用
pathType	String	CCE接入类型，仅CCE接入类型时使用
namespaceRegex	String	K8s Namespace正则匹配，仅CCE接入类型时使用
podNameRegex	String	K8s Pod正则匹配，仅CCE接入类型时使用
containerNameRegex	String	K8s 容器名称正则匹配，仅CCE接入类型时使用
includeLabels	Map<String,String>	容器 Label白名单，最多支持创建30个，keyname不支持重名，仅CCE接入类型时使用
excludeLabels	Map<String,String>	容器 Label黑名单，最多支持创建30个，keyname不支持重名，仅CCE接入类型时使用
includeEnvs	Map<String,String>	环境变量白名单，最多支持创建30个，keyname不支持重名，仅CCE接入类型时使用
excludeEnvs	Map<String,String>	环境变量黑名单，最多支持创建30个，keyname不支持重名，仅CCE接入类型时使用
logLabels	Map<String,String>	容器 Label日志标签，最多支持创建30个，keyname不支持重名，仅CCE接入类型时使用
logEnvs	Map<String,String>	环境变量日志标签，最多支持创建30个，keyname不支持重名，仅CCE接入类型时使用
includeK8sLabels	Map<String,String>	K8s Label白名单，最多支持创建30个，keyname不支持重名，仅CCE接入类型时使用
excludeK8sLabels	Map<String,String>	K8s Label黑名单，最多支持创建30个，keyname不支持重名，仅CCE接入类型时使用
logK8s	Map<String,String>	K8s Label日志标签，最多支持创建30个，keyname不支持重名，仅CCE接入类型时使用
repeat_collect	Boolean	强制重复采集
system_fields	Array of strings	系统内置字段：配置日志接入规则时，可以配置系统内置字段，上报日志后，每条日志数据的标签数据中将会有系统字段采集场景为主机文件的内置字段为：hostName、hostId、hostIP、pathFile、hostIPv6、category、collectTime、__host_group__ 采集场景为K8S集群容器文件的内置字段为：hostName、hostId、hostIP、pathFile、hostIPv6、clusterId、podName、appName、containerName、nameSpace、category、collectTime、__host_group__、serviceID、podIp、clusterName、workloadType、__image_name__ 若修改时传入此字段，将覆盖原有配置首次配置元数据时，此字段必填，值为["pathFile"] (其中pathFile为默认的必传字段，其余字段可选)
custom_key_value	Map<String,String>	自定义键值对：配置日志接入规则时，可以配置自定义键值对规则，上报日志后，每条日志数据的标签数据中将会有用户自定义的键值对字段，键值对数量不超过20 键的长度限制为128，允许的字符有a-zA-Z0-9_- 值的长度限制为1024 若修改时传入此字段，将覆盖原有配置
includeLabelsLogical	String	容器 Label白名单生效逻辑，可选为AND，OR，不配置时默认为OR；当存在多个容器 Label白名单时的处理逻辑，AND表示同时满足才会生效，OR表示有一项满足就会生效
excludeLabelsLogical	String	容器 Label黑名单生效逻辑，可选为AND，OR，不配置时默认为OR；当存在多个容器 Label黑名单时的处理逻辑，AND表示同时满足才会生效，OR表示有一项满足就会生效
includeK8sLabelsLogical	String	K8S Label白名单生效逻辑，可选为AND，OR，不配置时默认为OR；当存在多个K8S Label白名单时的处理逻辑，AND表示同时满足才会生效，OR表示有一项满足就会生效
excludeK8sLabelsLogical	String	K8S Label黑名单生效逻辑，可选为AND，OR，不配置时默认为OR；当存在多个K8S Label黑名单时的处理逻辑，AND表示同时满足才会生效，OR表示有一项满足就会生效
includeEnvsLogical	String	环境变量白名单生效逻辑，可选为AND，OR，不配置时默认为OR；当存在多个环境变量白名单时的处理逻辑，AND表示同时满足才会生效，OR表示有一项满足就会生效
excludeEnvsLogical	String	环境变量黑名单生效逻辑，可选为AND，OR，不配置时默认为OR；当存在多个环境变量黑名单时的处理逻辑，AND表示同时满足才会生效，OR表示有一项满足就会生效

表7 AccessConfigFormatCreate
参数	参数类型	描述
single	AccessConfigFormatSingleCreate object	日志接入格式单行日志
multi	AccessConfigFormatMutilCreate object	日志接入格式多行日志

表8 AccessConfigFormatSingleCreate
参数	参数类型	描述
mode	String	单行日志。system：系统时间，wildcard：时间通配符。
value	String	日志时间。当mode为”system”，则填入当前时间戳。当mode为"wildcard"，则时间通配符：用日志打印时间来标识一条日志数据，通过时间通配符来匹配日志，每条日志的行首显示日志的打印时间；如果日志中的时间格式为：2019-01-01 23:59:59，时间通配符应该填写为：YYYY-MM-DD hh:mm:ss；如果日志中的时间格式为：19-1-1 23:59:59，时间通配符应该填写为：YY-M-D hh:mm:ss 最小长度：1 最大长度：64

表9 AccessConfigFormatMutilCreate
参数	参数类型	描述
mode	String	单行日志。time：日志时间，regular：正则模式。
value	String	日志时间。当mode为"regular"，则输入正则表达式当mode为"time"，则时间通配符：用日志打印时间来标识一条日志数据，通过时间通配符来匹配日志，每条日志的行首显示日志的打印时间；如果日志中的时间格式为：2019-01-01 23:59:59，时间通配符应该填写为：YYYY-MM-DD hh:mm:ss；如果日志中的时间格式为：19-1-1 23:59:59，时间通配符应该填写为：YY-M-D hh:mm:ss 最小长度：1 最大长度：64

**表10** AccessConfigWindowsLogInfoCreate
参数	参数类型	描述
categorys	Array of strings	采集Windows事件日志类型。Application：应用系统，System：系统，Security：安全，Setup：启动
time_offset	AccessConfigTimeOffset object	日志接入偏移时间
event_level	Array of strings	事件等级。information：info，warning：告警，error：错误，critical：关键，verbose：冗长数组长度：1 - 5

**表11** AccessConfigTimeOffset
参数	参数类型	描述
offset	Long	偏移时间。当"unit"选择"day"时，范围为1~7天。当"unit"选择"hour"时，范围为1~168小时。当"unit"选择"sec"时，范围为1~604800秒。最小值：1 最大值：604800
unit	String	偏移时间单位。day ：天，hour：小时，sec：秒

**表12** AccessConfigQueryLogInfo
参数	参数类型	描述
log_group_id	String	日志组ID 最小长度：36 最大长度：36
log_stream_id	String	日志流ID 最小长度：36 最大长度：36
log_group_name	String	日志组名称最小长度：1 最大长度：128
log_stream_name	String	日志流名称最小长度：1 最大长度：128

**表13** AccessConfigHostGroupIdList
参数	参数类型	描述
host_group_id_list	Array of strings	主机组ID列表最小长度：36 最大长度：36

**表14** accessConfigTag
参数	参数类型	描述
key	String	标签Key 最小长度：1 最大长度：128
value	String	标签Value 最小长度：0 最大长度：255

**表15** DemoFieldAccess
参数	参数类型	描述
field_name	String	字段名称需和keys中字段保持一致
field_value	String	字段值

**表16** Processor
参数	参数类型	描述
type	String	解析器类型 processor_regex 正则解析 processor_split_string 分词符 processor_json json解析器类型 processor_gotime自定义时间类型 processor_filter_regex日志过滤 processor_drop删除字段类型 processor_rename修改字段类型
detail	Detail object	解析器配置

**表17** Detail
参数	参数类型	描述
source_key	String	自定义时间key字段名称
regex	String	正则解析正则表达式单行完全正则，多行完全正则需填此字段
keys	Array of strings	字段名称列表与field_name字段保持一致
multi_line_regex	String	首行正则表达式
keep_source	Boolean	是否上传原始日志
keep_source_if_parse_error	Boolean	是否上传解析失败日志
split_sep	String	分隔符自定义字符最大长度10，自定义字符串最大长度30
split_type	String	分隔符类型：char-自定义字符；special_char-不可见字符；string-自定义字符串
fields	Map<String,String>	添加的字段列表：<字段名称 : 字段内容>
drop_keys	Array of strings	删除的字段列表
source_keys	Array of strings	字段重命名源字段名称列表
dest_keys	Array of strings	字段重命名替换的字段名称列表
expand_depth	Integer	json解析深度，默认为1层最大4层
expand_connector	String	json解析字段名称连接符
source_format	String	自定义时间时间格式
source_value	String	自定义时间字段value
set_time	Boolean	是否开启自定义时间的开关
include	Map<String,String>	日志过滤白名单规则 key长度最大为256，value最大长度为128，key不可以重复
exclude	Map<String,String>	日志过滤白名单规则 key长度最大为256，value最大长度为128，key不可以重复

状态码： 400

**表18** 响应Body参数
参数	参数类型	描述
error_code	String	错误码最小长度：8 最大长度：8
error_msg	String	错误描述最小长度：1 最大长度：1000

状态码： 500

**表19** 响应Body参数
参数	参数类型	描述
error_code	String	错误码最小长度：8 最大长度：8
error_msg	String	错误描述最小长度：1 最大长度：1000

请求示例

删除日志接入

DELETE https://{endpoint}/v3/{project_id}/lts/access-config

/v3/{project_id}/lts/access-config  
{"access_config_id_list":["xxxx","xxxx"]}

响应示例

状态码： 200

删除日志接入请求响应成功

{
  "result" : [ {
    "access_config_detail" : {
      "black_paths" : [ "/wjy/hei/tesxxx", "/wjy/hei/tesxxx" ],
      "format" : {
        "single" : {
          "mode" : "wildcard",
          "value" : "1111"
        }
      },
      "paths" : [ "/wjy/tesxxx", "/wjy/texxx", "/wjyxxxxx" ],
      "windows_log_info" : {
        "categorys" : [ "System", "Application", "Security", "Setup" ],
        "event_level" : [ "information", "warning", "error", "critical", "verbose" ],
        "time_offset" : {
          "offset" : 168,
          "unit" : "hour"
        }
      }
    },
    "access_config_id" : "aa58d29e-21a9-4761-ba16-8xxxxx",
    "access_config_name" : "采集Wjyxxxxxt2",
    "access_config_tag" : [ {
      "key" : "xxx",
      "value" : "xxx"
    }, {
      "key" : "xxx1",
      "value" : "xxx1"
    } ],
    "access_config_type" : "AGENT",
    "create_time" : 1635043645628,
    "host_group_info" : {
      "host_group_id_list" : [ "de4dbed4-a3bc-4877-a7ee-0xxxxxx6" ]
    },
    "log_info" : {
      "log_group_id" : "9a7e2183-2d6d-4732-9a9b-e89xxxxx0",
      "log_group_name" : "lts-groupxxxxxka",
      "log_stream_id" : "c4de0538-53e6-41fd-b951-a8xxxxx58d7",
      "log_stream_name" : "lts-topic-txxxxx"
    }
  } ],
  "total" : 1
}

状态码： 400

非法请求建议根据error_msg直接修改该请求。

{
  "error_code" : "LTS.1807",
  "error_msg" : "Invalid access config id"
}

状态码： 500

表明服务端能被请求访问到，但是服务内部出错。

{
  "error_code" : "LTS.0010",
  "error_msg" : "The system encountered an internal error"
}

SDK代码示例

SDK代码示例如下。

删除日志接入

      
       
         
         
           package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.lts.v2.region.LtsRegion;
import com.huaweicloud.sdk.lts.v2.*;
import com.huaweicloud.sdk.lts.v2.model.*;


public class DeleteAccessConfigSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        LtsClient client = LtsClient.newBuilder()
                .withCredential(auth)
                .withRegion(LtsRegion.valueOf("<YOUR REGION>"))
                .build();
        DeleteAccessConfigRequest request = new DeleteAccessConfigRequest();
        try {
            DeleteAccessConfigResponse response = client.deleteAccessConfig(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

          

        

      
     

删除日志接入

      
       
         
         
           # coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdklts.v2.region.lts_region import LtsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdklts.v2 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = LtsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(LtsRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = DeleteAccessConfigRequest()
        response = client.delete_access_config(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

          

        

      
     

删除日志接入

      
       
         
         
           package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    lts "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/lts/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/lts/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/lts/v2/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := lts.NewLtsClient(
        lts.LtsClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.DeleteAccessConfigRequest{}
	response, err := client.DeleteAccessConfig(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

          

        

      
     

更多编程语言的SDK代码示例，请参见API Explorer的代码示例页签，可生成自动对应的SDK代码示例。

状态码

状态码	描述
200	删除日志接入请求响应成功
400	非法请求建议根据error_msg直接修改该请求。
500	表明服务端能被请求访问到，但是服务内部出错。

错误码

请参见错误码。

父主题：日志接入

上一篇：创建日志接入

下一篇：修改日志接入

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问

删除日志接入

功能介绍

调用方法

URI

请求参数

响应参数

请求示例

响应示例

SDK代码示例

状态码

错误码

相关文档

意见反馈

文档内容是否对您有帮助？

7*24

备案

专业服务

退订

建议反馈

售前咨询热线