微服务平台 TSF 获取多个投递项配置-API 文档-文档中心-腾讯云

1. 接口描述

接口请求域名： tsf.tencentcloudapi.com 。

获取多个投递项配置

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeDeliveryConfigs。
Version	是	String	公共参数，本接口取值：2018-03-26。
Region	是	String	公共参数，详见产品支持的地域列表。
SearchWord	否	String	关键字示例值：mock-name
Offset	否	Integer	偏移示例值：0
Limit	否	Integer	搜索条数示例值：50
ProgramIdList.N	否	Array of String	数据集idList 示例值：["program-6a79x94v"]
ConfigIdList.N	否	Array of String	ConfigIdList 示例值：["config-6a79x94v"]

3. 输出参数

参数名称	类型	描述
Result	DeliveryConfigBindGroups	投递项关联部署组信息
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取多个投递项配置

输入示例

https://tsf.tencentcloudapi.com/?Action=DescribeDeliveryConfigs
&<公共请求参数>

输出示例

{
    "Response": {
        "Result": {
            "TotalCount": 0,
            "Content": [
                {
                    "ConfigId": "apm-busi-log-cfg-6a79x94v",
                    "ConfigName": "toKafkaCfg",
                    "CollectPath": [
                        "/var/log"
                    ],
                    "Groups": [
                        {
                            "GroupId": "group-6a79x94v",
                            "GroupName": "java-demo",
                            "ClusterId": "cls-6a79x94v",
                            "ClusterName": "k8s-cls",
                            "ClusterType": "C",
                            "NamespaceName": "default",
                            "AssociateTime": "2022-12-23 10:23:12"
                        }
                    ],
                    "CreateTime": "2022-12-22 10:12:32",
                    "KafkaVIp": "10.23.0.4",
                    "KafkaAddress": "kafka.tencent.com",
                    "KafkaVPort": "30111",
                    "Topic": "TO_KAFKA_TOPIC",
                    "LineRule": ".*",
                    "CustomRule": ".*",
                    "EnableGlobalLineRule": true,
                    "EnableAuth": true,
                    "Username": "root",
                    "Password": "passxxxxxxxxx",
                    "KafkaInfos": [
                        {
                            "Topic": "TO_KAFKA_TOPIC",
                            "Path": [
                                "/var/log"
                            ],
                            "LineRule": ".*",
                            "CustomRule": "null"
                        }
                    ]
                }
            ]
        },
        "RequestId": "f1183607-d21b-dde1-d99c-94643d32c62e"
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
FailedOperation.TsfApmBusiLogCfgSchemaQueryError	TSF应用性能管理业务日志配置解析规则查询失败。
InvalidParameter.ParamError	参数错误。
ResourceNotFound.MicroserviceOffline	目标微服务已离线[%s]。。
UnauthorizedOperation.NoPrivilege	用户无权限访问该接口。。