1. 接口描述
接口请求域名: cls.tencentcloudapi.com 。
获取Splunk投递任务列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeSplunkDelivers。 |
| Version | 是 | String | 公共参数,本接口取值:2020-10-16。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| TopicId | 是 | String | 日志主题Id - 通过获取日志主题列表获取日志主题Id。 示例值:06cc3d03-44a0-4d94-89c2-aeac27a1d9f1 |
| Filters.N | 否 | Array of Filter | - taskId 按照【任务id】进行过滤。 类型:String 必选:否 - name 按照【任务名称】进行过滤。 类型:String 必选:否 - statusFlag 按照【状态】进行过滤。 类型:String 必选:否 每次请求的Filters的上限为10,Filter.Values的上限为10。 |
| Offset | 否 | Integer | 分页的偏移量,默认值为0。 示例值:1 |
| Limit | 否 | Integer | 分页单页限制数目,默认值为20,最大值100。 示例值:20 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Infos | Array of SplunkDeliverInfo | Splunk投递任务信息列表 |
| Total | Integer | 符合条件的任务总数。 示例值:12 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询Splunk投递任务
输入示例
POST / HTTP/1.1
Host: cls.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSplunkDelivers
<公共请求参数>
{
"TopicId": "d1d7d473-827e-4dad-9a42-f0287ad43125",
"Filters": [
{
"Key": "taskId",
"Values": [
"46bb8292-1974-4663-8ce5-498256a42431"
]
}
]
}
输出示例
{
"Response": {
"Infos": [
{
"CreateTime": 1757657329,
"Enable": 1,
"HasServiceLog": 2,
"Index": "",
"IndexAck": 1,
"Metadata": {
"Format": "json"
},
"Name": "name-test14",
"NetInfo": {
"Host": "10.0.0.112",
"IsSSL": true,
"NetType": 1,
"Port": 8088,
"Token": "59f9b80c-ae2f-43c1-8c93-436094343125",
"VirtualGatewayType": 0,
"VpcId": "vpc-k1bdf0es"
},
"Source": "",
"SourceType": "",
"Status": 1,
"TaskId": "46bb8292-1974-4663-8ce5-498256a42431",
"TopicId": "d1d7d473-827e-4dad-9a42-f0287ad43125",
"Uin": 100001127589,
"UpdateTime": 1757657329
}
],
"RequestId": "964ff3ff-ec82-40d2-90ab-bb9b8bc43125",
"Total": 1
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| FailedOperation.TagQpsLimit | 请求标签服务限频。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| OperationDenied | 操作被拒绝。 |
| OperationDenied.ACLFailed | ACL校验失败。 |
| OperationDenied.AccountDestroy | 账户已销毁。 |
| OperationDenied.AccountIsolate | 账户欠费。 |
| OperationDenied.AccountNotExists | 账户不存在。 |
| ResourceNotFound.RecordNotExist | 记录不存在 |