查询公共配置汇总列表

最近更新时间: 2026-10-11 00:12:05

1. 接口描述

接口请求域名： tsf.api3.fincloud.tencent.com。

查询公共配置汇总列表

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

接口更新时间：2025-08-06 23:23:55。

接口只验签名不鉴权。

2. 输入参数

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

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：DescribePublicConfigSummary
Version	是	否	String	公共参数，本接口取值：2018-03-26
Region	是	否	String	公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
Limit	否	否	Int64	每页条数，默认为20 示例值：
OrderBy	否	否	String	按时间排序：creation_time；按名称排序：config_name 示例值：
OrderType	否	否	Int64	升序传 0，降序传 1 示例值：
ConfigTagList	否	否	Array of String	无示例值：
DisableProgramAuthCheck	否	否	Bool	无示例值：
ConfigIdList	否	否	Array of String	无示例值：
SearchWord	否	否	String	查询关键字，模糊查询：配置项名称，不传入时查询全量示例值：
Offset	否	否	Int64	偏移量，默认为0 示例值：

3. 输出参数

参数名称	类型	描述
Result	TsfPageConfig	分页的全局配置统计信息列表示例值：查看
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

错误码	描述
InvalidParameter.ParamError	参数错误。
UnauthorizedOperation.NoPrivilege	用户无权限访问该接口。。

5. 示例

示例1 查询公共配置汇总列表

输入示例

POST / HTTP/1.1
Host: tsf.api3.fincloud.tencent.com
Content-Type: application/json
X-TC-Action: DescribePublicConfigSummary
<Common Parameters>

{
  "SearchWord": "app",
  "Offset": 0,
  "Limit": 10,
  "OrderBy": "creation_time",
  "OrderType": 1,
  "ConfigTagList": [
    "app-config"
  ],
  "DisableProgramAuthCheck": true,
  "ConfigIdList": [
    "dcfg-p-vkj5dnky"
  ]
}

输出示例

{
  "Response": {
    "RequestId": "d6da2add-172a-4a4d-8f30-8abca66e314f",
    "Result": {
      "Content": [
        {
          "ApplicationId": null,
          "ApplicationName": null,
          "ConfigId": "dcfg-p-vkj5dnky",
          "ConfigName": "app-config",
          "ConfigType": null,
          "ConfigValue": null,
          "ConfigVersion": null,
          "ConfigVersionCount": 1,
          "ConfigVersionDesc": null,
          "CreationTime": null,
          "DeleteFlag": null,
          "LastUpdateTime": "2024-12-20 19:16:10"
        }
      ],
      "TotalCount": 1
    }
  }
}