1. 接口描述
接口请求域名： cls.tencentcloudapi.com 。
修改splunk投递任务相关信息
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：ModifySplunkDeliver。 |
| Version | 是 | String | 公共参数，本接口取值：2020-10-16。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| TaskId | 是 | String | 任务id 示例值：111024e3-01b0-4aeb-91f5-ee |
| TopicId | 是 | String | 日志主题id - 通过获取日志主题列表获取日志主题Id。 示例值：06cc3d03-44a0-4d94-89c2-aeac27a1d9f1 |
| Name | 否 | String | 投递任务名称 name有以下限制： - 不能为空 - 长度不大于64 - 只能包含aA-zZ、下划线、-、0-9 示例值：template-1 |
| Enable | 否 | Integer | 投递任务启用状态；0:禁用；1:启用 示例值：1 |
| NetInfo | 否 | NetInfo | splunk投递任务-目标配置 |
| MetadataInfo | 否 | MetadataInfo | splunk投递任务元信息 |
| HasServiceLog | 否 | Integer | 是否启用服务日志；1:关闭；2:开启 示例值：1 |
| IndexAck | 否 | Integer | 高级配置-是否启用索引器; 1-不开启；2-开启；默认为：1 示例值：1 |
| Source | 否 | String | 高级配置-数据来源；不超过64个字符 示例值：client-1 |
| SourceType | 否 | String | 高级配置-数据来源类型；不超过64个字符 示例值：json |
| Index | 否 | String | 高级配置-Splunk写入的索引；不超过64个字符 示例值：main |
| Channel | 否 | String | 高级配置-通道。 需满足限制：如果启用索引器，该值不能为空 示例值：template-1 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 修改Splun投递任务
输入示例
POST / HTTP/1.1
Host: cls.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifySplunkDeliver
<公共请求参数>
{
"TaskId": "65a07eec-96ee-458d-850b-53dfe9b43125",
"TopicId": "d1d7d473-827e-4dad-9a42-f0287ad43125",
"MetadataInfo": {
"Format": "json",
"MetaFields": [
"__SOURCE__"
]
}
}输出示例
{
"Response": {
"RequestId": "89b26245-ec3e-4b00-829a-bcc835d43125"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| AuthFailure.UnauthorizedOperation | 请求未授权。 |
| FailedOperation | 操作失败。 |
| FailedOperation.Timeout | 操作超时 |
| InternalError | 内部错误。 |
| InternalError.DbError | DB错误。 |
| InternalError.IllegalRole | 角色非法。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.ParamError | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| LimitExceeded.RecordOutOfLimit | 记录超过限制 |
| MissingParameter | 缺少参数错误。 |
| UnauthorizedOperation | 未授权操作。 |
| UnknownParameter | 未知参数错误。 |
| UnsupportedOperation | 操作不支持。 |
