微服务平台 TSF
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > 微服务平台 TSF > API 文档 > 配置管理相关接口 > 查询配置项列表

查询配置项列表

最近更新时间：2024-03-12 01:59:53

我的收藏

本页目录：

1. 接口描述

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

查询配置项列表

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeConfigs。
Version 是 String 公共参数，本接口取值：2018-03-26。
Region 是 String 公共参数，详见产品支持的 地域列表。
ApplicationId 否 String 应用ID，不传入时查询全量
示例值：application-jy9w6lka
ConfigId 否 String 配置项ID，不传入时查询全量，高优先级
示例值：dcfg-xxx
Offset 否 Integer 偏移量
示例值：0
Limit 否 Integer 每页条数
示例值：50
ConfigIdList.N 否 Array of String 配置项ID列表，不传入时查询全量，低优先级
示例值：null
ConfigName 否 String 配置项名称，精确查询，不传入时查询全量
示例值：test-driverapi-config
ConfigVersion 否 String 配置项版本，精确查询，不传入时查询全量
示例值：v1

3. 输出参数

参数名称 类型 描述
Result TsfPageConfig 分页后的配置项列表
注意：此字段可能返回 null，表示取不到有效值。
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询配置项列表

输入示例

https://tsf.tencentcloudapi.com/?Action=DescribeConfigs
&ConfigName=test-driverapi-config
&ApplicationId=application-jy9w6lka
&Offset=0
&Limit=50
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "09dd9751-6169-4db6-903c-283f89a250f2",
        "Result": {
            "TotalCount": 2,
            "Content": [
                {
                    "ConfigId": "dcfg-qab4rqwv",
                    "ConfigName": "test-driverapi-config",
                    "ConfigVersion": "v1.2.0",
                    "ConfigVersionDesc": "",
                    "ConfigValue": "logging:\r\n  config: classpath:logback-custom.xml\r\n  file: /data/logs/${spring.application.name}/root.log\r\n  level:\r\n    org.springframework.tsf: INFO\r\n    com.tencent.iov.driverapi: DEBUG\r\n    com.tencent.iov.parent: DEBUG\r\n\r\nspring:\r\n  kafka:\r\n    bootstrap-servers: 10.3.1.11:9092\r\n    producer:\r\n      retries: 0\r\n      batch-size: 16384\r\n      buffer-memory: 33554432\r\n      key-serializer: org.apache.kafka.common.serialization.StringSerializer\r\n      value-serializer: org.apache.kafka.common.s",
                    "CreationTime": "2019-04-23 11:16:26",
                    "LastUpdateTime": null,
                    "ConfigVersionCount": null,
                    "ApplicationId": "application-jy9w6lka",
                    "ApplicationName": "ruqitest_travel_driverapi",
                    "DeleteFlag": true,
                    "ConfigType": null
                },
                {
                    "ConfigId": "dcfg-6a79b39v",
                    "ConfigName": "test-driverapi-config",
                    "ConfigVersion": "v1.2.1",
                    "ConfigVersionDesc": null,
                    "ConfigValue": "logging:\r\n  config: classpath:logback-custom.xml\r\n  file: /data/logs/${spring.application.name}/root.log\r\n  level:\r\n    org.springframework.tsf: INFO\r\n    com.tencent.iov.driverapi: DEBUG\r\n    com.tencent.iov.parent: DEBUG\r\n\r\nspring:\r\n  kafka:\r\n    bootstrap-servers: 10.3.1.11:9092\r\n    producer:\r\n      retries: 0\r\n      batch-size: 16384\r\n      buffer-memory: 33554432\r\n      key-serializer: org.apache.kafka.common.serialization.StringSerializer\r\n      value-serializer: org.apache.kafka.common.s",
                    "CreationTime": "2019-04-23 09:53:53",
                    "LastUpdateTime": null,
                    "ConfigVersionCount": null,
                    "ApplicationId": "application-jy9w6lka",
                    "ApplicationName": "ruqitest_travel_driverapi",
                    "DeleteFlag": false,
                    "ConfigType": null
                }
            ]
        }
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.ConfigApplicationQueryFailed 应用查询失败。
FailedOperation.ConfigQueryFailed 配置项查询失败。
FailedOperation.DispatchCommonError TSF暂时不能响应请求。
FailedOperation.TsfPrivilegeError TSF权限模块异常，请联系系统管理员。。
FailedOperation.UnhandledException 模块未处理异常。
InternalError.UnhandledException [%s]模块未处理异常。。
InvalidParameter.ParamError 参数错误。
ResourceNotFound.MicroserviceOffline 目标微服务已离线[%s]。。
UnauthorizedOperation.NoLicense 缺少License。。
UnauthorizedOperation.NoPrivilege 用户无权限访问该接口。。
中国站