创建Splunk投递任务

最近更新时间:2025-12-23 01:29:01

我的收藏

1. 接口描述

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

创建Splunk投递任务

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateSplunkDeliver。
Version String 公共参数,本接口取值:2020-10-16。
Region String 公共参数,详见产品支持的 地域列表
TopicId String 日志主题id
- 通过获取日志主题列表获取日志主题Id。
示例值:06cc3d03-44a0-4d94-89c2-aeac27a1d9f1
Name String splunk投递任务名称;
name有如下限制:
- 不能为空
- 长度不大于64
- 只能包含aA-zZ、下划线、-、0-9
示例值:template-1
NetInfo NetInfo Splunk投递任务-目标配置-网络信息
MetadataInfo MetadataInfo Splunk投递任务元信息
HasServiceLog Integer 是否开启服务日志 1:关闭;2:开启 ;默认开启
示例值:2
IndexAck Integer 高级配置-是否启用索引器;1-不启用;2-启用;
默认:1
示例值:1
Source String 高级配置-数据来源;不超过64个字符
示例值:client-01
SourceType String 高级配置-数据来源类型;不超过64个字符
示例值:json
Index String 高级配置-Splunk写入的索引;不超过64个字符
示例值:main
Channel String 高级配置-通道
需满足限制:如果启用索引器,那么Channel必填
示例值:template-1

3. 输出参数

参数名称 类型 描述
TaskId String splunk投递任务id
示例值:111024e3-01b0-4aeb-91f5-ee
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建Splun投递任务

输入示例

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

{
    "TopicId": "d1d7d473-827e-4dad-9a42-f0287ad43125",
    "Name": "name-test15",
    "NetInfo": {
        "Host": "10.0.0.112",
        "Port": 8088,
        "Token": "59f9b80c-ae2f-43c1-8c93-436094343125",
        "NetType": 1,
        "VpcId": "vpc-k1bdf0ds",
        "VirtualGatewayType": 0,
        "IsSSL": true
    },
    "MetadataInfo": {
        "Format": "json"
    },
    "IndexAck": 1
}

输出示例

{
    "Response": {
        "RequestId": "7006acf0-0b04-442d-a09e-1d2925cac79a",
        "TaskId": "65a07eec-96ee-458d-850b-53dfe9b43125"
    }
}

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.ParamError 参数错误。
InvalidParameterValue 参数取值错误。
LimitExceeded.RecordOutOfLimit 记录超过限制
MissingParameter 缺少参数错误。
UnauthorizedOperation 未授权操作。
UnknownParameter 未知参数错误。