API 中心
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > API 中心 > 边缘安全加速平台 EO > 日志服务相关接口 > 修改实时日志投递任务

修改实时日志投递任务

最近更新时间：2024-04-26 01:25:24

我的收藏

1. 接口描述

接口请求域名： teo.tencentcloudapi.com 。

通过本接口修改实时日志投递任务配置。本接口有如下限制：

  • 不支持修改实时日志投递任务目的地类型（TaskType）；
  • 不支持修改数据投递类型（LogType）
  • 不支持修改数据投递区域（Area）
  • 当原实时日志投递任务的目的地为腾讯云 CLS 时，不支持修改目的地详细配置，如日志集、日志主题。

    • 默认接口请求频率限制：20次/秒。

    推荐使用 API Explorer
    点击调试
    API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

    2. 输入参数

    以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。

    参数名称 必选 类型 描述
    Action 是 String 公共参数，本接口取值：ModifyRealtimeLogDeliveryTask。
    Version 是 String 公共参数，本接口取值：2022-09-01。
    Region 否 String 公共参数，此参数为可选参数。
    ZoneId 是 String 站点 ID。
    TaskId 是 String 实时日志投递任务 ID。
    TaskName 否 String 实时日志投递任务的名称，格式为数字、英文、-和_组合，最多 200 个字符。不填保持原有配置。
    DeliveryStatus 否 String 实时日志投递任务的状态，取值有：
  • enabled: 启用；
  • disabled: 停用。
    • 不填保持原有配置。
    EntityList.N 否 Array of String 实时日志投递任务对应的实体（七层域名或者四层代理实例）列表。取值示例如下：
  • 七层域名：domain.example.com；
  • 四层代理实例：sid-2s69eb5wcms7。
    • 不填保持原有配置。
    取值可参考：
    查询应用代理列表（旧）
    查询加速域名列表
    Fields.N 否 Array of String 投递的预设字段列表。不填保持原有配置。
    CustomFields.N 否 Array of CustomField 投递的自定义字段列表，支持在 HTTP 请求头、响应头、Cookie 中提取指定字段值。自定义字段名称不能重复，且最多不能超过 200 个字段。不填保持原有配置。
    DeliveryConditions.N 否 Array of DeliveryCondition 日志投递的过滤条件。不填表示投递全量日志。
    Sample 否 Integer 采样比例，采用千分制，取值范围为1-1000，例如：填写 605 表示采样比例为 60.5%。不填保持原有配置。
    LogFormat 否 LogFormat 日志投递的输出格式。不填保持原有配置。
    CustomEndpoint 否 CustomEndpoint 自定义 HTTP 服务的配置信息，不填保持原有配置。
    S3 否 S3 AWS S3 兼容存储桶的配置信息，不填保持原有配置。

    3. 输出参数

    参数名称 类型 描述
    RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 关闭日志采样功能

    修改某个已经创建成功的实时日志投递任务配置，关闭其日志采样功能。修改前，日志采样比例为 60.5%；修改后，不再进行日志采样，将投递 100% 数量的日志至目的地。

    输入示例

    POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyRealtimeLogDeliveryTask
<公共请求参数>

{
    "ZoneId": "zone-2ju9lrnpayol",
    "TaskId": "17819248-77b0-4e1a-a979-d84b5a9b300p",
    "Sample": 1000
}

    输出示例

    {
    "Response": {
        "RequestId": "5e0a2b4e-df6d-4d2a-ac39-1706cbf8a703"
    }
}

    示例2 追加需要投递日志的加速域名

    修改某个已经创建成功的实时日志投递任务配置，为其追加需要投递日志的加速域名。修改前，仅投递 domain1.example.com 的站点加速日志；修改后，将投递 domain1.example.com、domain2.example.com、domain3.example.com 的站点加速日志。

    输入示例

    POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyRealtimeLogDeliveryTask
<公共请求参数>

{
    "ZoneId": "zone-2ju9lrnpayol",
    "TaskId": "17819248-77b0-4e1a-a979-d84b5a9b300p",
    "EntityList": [
        "domain1.example.com",
        "domain2.example.com",
        "domain3.example.com"
    ]
}

    输出示例

    {
    "Response": {
        "RequestId": "5e0a2b4e-df6d-4d2a-ac39-1706cbf8a703"
    }
}

    5. 开发者资源

    腾讯云 API 平台

    腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

    API Inspector

    用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

    SDK

    云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

    命令行工具

    6. 错误码

    以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。

    错误码 描述
    FailedOperation 操作失败。
    FailedOperation.CreateLogTopicTaskAuthFailure 创建自定义推送任务认证失败, 请检查推送地址是否正确。
    InvalidParameter.InvalidLogFormatFieldDelimiter 日志输出格式的字段分隔符不正确
    InvalidParameter.InvalidLogFormatFormatType 日志输出格式类型不正确
    InvalidParameter.InvalidLogFormatRecordDelimiter 日志输出格式的日志记录分隔符不正确
    中国站