微服务平台 TSF 查询配置汇总列表-配置管理相关接口-API 中心-腾讯云

1. 接口描述

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

查询配置汇总列表

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeConfigSummary。
Version	是	String	公共参数，本接口取值：2018-03-26。
Region	是	String	公共参数，详见产品支持的地域列表。
ApplicationId	否	String	应用ID，不传入时查询全量示例值：application-5yr26r9a
SearchWord	否	String	查询关键字，模糊查询：应用名称，配置项名称，不传入时查询全量示例值：config_app
Offset	否	Integer	偏移量，默认为0 示例值：0
Limit	否	Integer	每页条数，默认为20 示例值：10
OrderBy	否	String	按时间排序：creation_time；按名称排序：config_name 示例值：creation_time
OrderType	否	Integer	升序传 0，降序传 1 示例值：1
ConfigTagList.N	否	Array of String	无示例值：["config_app-application-5yr26r9a"]
DisableProgramAuthCheck	否	Boolean	无示例值：true
ConfigIdList.N	否	Array of String	无示例值：["dcfg-vzk36owv"]

3. 输出参数

参数名称	类型	描述
Result	TsfPageConfig	配置项分页对象示例值：{"Content":[{"ApplicationId":"application-5yr26r9a","ApplicationName":"amp-consumer","ConfigId":"dcfg-vzk36owv","ConfigName":"config_app","ConfigType":null,"ConfigValue":null,"ConfigVersion":null,"ConfigVersionCount":1,"ConfigVersionDesc":null,"CreationTime":null,"DeleteFlag":null,"LastUpdateTime":"2024-12-24 18:04:02"}],"TotalCount":1}
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询配置汇总列表

输入示例

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

{
    "ApplicationId": "application-5yr26r9a",
    "SearchWord": "config_app",
    "Offset": 0,
    "Limit": 10,
    "OrderBy": "creation_time",
    "OrderType": 1,
    "ConfigTagList": [
        "config_app-application-5yr26r9a"
    ],
    "DisableProgramAuthCheck": true,
    "ConfigIdList": [
        "dcfg-vzk36owv"
    ]
}

输出示例

{
    "Response": {
        "RequestId": "0e8d31d3-e16a-4070-9248-cce94db7fae5",
        "Result": {
            "Content": [
                {
                    "ApplicationId": "application-5yr26r9a",
                    "ApplicationName": "amp-consumer",
                    "ConfigId": "dcfg-vzk36owv",
                    "ConfigName": "config_app",
                    "ConfigType": null,
                    "ConfigValue": null,
                    "ConfigVersion": null,
                    "ConfigVersionCount": 1,
                    "ConfigVersionDesc": null,
                    "CreationTime": null,
                    "DeleteFlag": null,
                    "LastUpdateTime": "2024-12-24 18:04:02"
                }
            ],
            "TotalCount": 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: 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.ConfigApplicationQueryFailed	应用查询失败。
FailedOperation.TsfPrivilegeError	TSF权限模块异常，请联系系统管理员。。
InvalidParameter.ParamError	参数错误。
ResourceNotFound.MicroserviceOffline	目标微服务已离线[%s]。。
UnauthorizedOperation.NoPrivilege	用户无权限访问该接口。。