创建DLC投递任务

最近更新时间:2025-11-25 01:26:59

我的收藏

1. 接口描述

接口请求域名: cls.tencentcloudapi.com 。

创建DLC投递任务

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateDlcDeliver。
Version String 公共参数,本接口取值:2020-10-16。
Region String 公共参数,详见产品支持的 地域列表
TopicId String 日志主题id。
- 通过获取日志主题列表获取日志主题Id。
示例值:715094e3-01b0-4aeb-91f5-ee9f46a4a13c
Name String 名称:长度不超过64字符,以字母开头,接受0-9,a-z,A-Z, _,-,中文字符。
示例值:template_1
DeliverType Integer 投递类型。0:批投递,1:实时投递
示例值:1
StartTime Integer 投递时间范围的开始时间
示例值:1741005340
DlcInfo DlcInfo dlc配置信息
MaxSize Integer 投递文件大小,单位MB。 DeliverType=0时必填,范围 5<= MaxSize <= 256。
示例值:5
Interval Integer 投递间隔,单位秒。 DeliverType=0时必填,范围 300<= Interval <=900。
示例值:300
EndTime Integer 投递时间范围的结束时间。 如果为空,则表示不限时。EndTime不为空时,需要大于StartTime。
示例值:1741006340
HasServicesLog Integer 是否开启投递服务日志。1关闭,2开启。默认开启
示例值:2

3. 输出参数

参数名称 类型 描述
TaskId String 配置id
示例值:988259ca-598f-428c-8475-cf438d05468c
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建dlc投递任务

输入示例

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

{
    "TopicId": "03334fb8-4d74-4dde-ada6-da4c0d0b2ff8",
    "Name": "add_dlc_deliver_test1",
    "DeliverType": 0,
    "StartTime": 1741005340,
    "DlcInfo": {
        "TableInfo": {
            "DataDirectory": "test_table",
            "DatabaseName": "test_schema",
            "TableName": "test_db"
        },
        "FieldInfos": [
            {
                "ClsField": "cls_test_field1",
                "DlcField": "dlc_test_field1",
                "DlcFieldType": "string",
                "Disable": true
            }
        ],
        "PartitionInfos": [
            {
                "ClsField": "cls_test_field2",
                "DlcField": "dlc_test_field2",
                "DlcFieldType": "int"
            }
        ],
        "PartitionExtra": {
            "TimeFormat": "/%Y/%m/%d/%H",
            "TimeZone": "UTC+08:00"
        }
    },
    "MaxSize": 5,
    "Interval": 300,
    "EndTime": 1741006340,
    "HasServicesLog": 2
}

输出示例

{
    "Response": {
        "TaskId": "ba05f9aa-432f-4ccc-9120-b60d1f3a0c20",
        "RequestId": "d2ceec4a-1f59-4508-ae4c-e256c30dea1f"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
AuthFailure CAM签名/鉴权错误。
AuthFailure.UnauthorizedOperation 请求未授权。
FailedOperation 操作失败。
FailedOperation.Timeout 操作超时
InternalError 内部错误。
InternalError.DbError DB错误。
InternalError.IllegalRole 角色非法。
InvalidParameter 参数错误。
InvalidParameter.DbDuplication 数据库唯一键冲突。
InvalidParameter.ParamError 参数错误。
InvalidParameterValue 参数取值错误。
LimitExceeded.RecordOutOfLimit 记录超过限制
MissingParameter 缺少参数错误。
UnauthorizedOperation 未授权操作。
UnknownParameter 未知参数错误。
UnsupportedOperation 操作不支持。