1. 接口描述
接口请求域名: tsf.tencentcloudapi.com 。
获取单个投递项配置信息
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeDeliveryConfig。 |
Version | 是 | String | 公共参数,本接口取值:2018-03-26。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
ConfigId | 是 | String | 投递配置id 示例值:config-2k8sh4s |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Result | KafkaDeliveryConfig | 投递kafka配置 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取单个投递项配置
输入示例
https://tsf.tencentcloudapi.com/?Action=DescribeDeliveryConfig
&ConfigId=config-kl29sh7n
&<公共请求参数>
输出示例
{
"Response": {
"RequestId": "00b0009f-80ad-41fd-8bb8-f430d12f3911",
"Result": {
"CollectPath": [
""
],
"ConfigId": "send-data-to-kafka-nalj8bgy",
"ConfigName": "rtest222",
"CustomRule": null,
"EnableAuth": false,
"EnableGlobalLineRule": false,
"KafkaAddress": null,
"KafkaInfos": [
{
"CustomRule": "",
"LineRule": "",
"Path": [
"/test/1.log"
],
"Topic": "send_kafka_topic"
}
],
"KafkaVIp": "127.0.1:9200",
"KafkaVPort": null,
"LineRule": "default",
"Password": null,
"Topic": "",
"Username": null
}
}
}
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: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InvalidParameter.TsfApmBusiLogCfgCloudParamError | TSF应用性能管理业务日志配置云账户参数错误。 |
InvalidParameter.TsfApmBusiLogCfgIdParamError | TSF应用性能管理业务日志配置标识参数错误。 |