查询配置项列表

最近更新时间: 2026-09-17 00:04:02

1. 接口描述

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

查询配置项列表

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

接口更新时间：2024-09-14 11:55:39。

接口既验签名又鉴权。

2. 输入参数

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

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：DescribeConfigs
Version	是	否	String	公共参数，本接口取值：2018-03-26
Region	是	否	String	公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
ApplicationId	否	否	String	应用ID，不传入时查询全量示例值：
ConfigId	否	否	String	配置项ID，不传入时查询全量，高优先级示例值：
Offset	否	否	Int64	偏移量示例值：
Limit	否	否	Int64	每页条数示例值：
ConfigIdList	否	否	Array of String	配置项ID列表，不传入时查询全量，低优先级示例值：
ConfigName	否	否	String	配置项名称，精确查询，不传入时查询全量示例值：
ConfigVersion	否	否	String	配置项版本，精确查询，不传入时查询全量示例值：
OrderBy	否	否	String	按时间排序：creation_time；按版本号排序：config_version 示例值：
OrderType	否	否	Int64	升序传 0，降序传 1 示例值：

3. 输出参数

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

4. 错误码

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

错误码	描述
InvalidParameter.ParamError	参数错误。
UnauthorizedOperation.NoPrivilege	用户无权限访问该接口。。
FailedOperation.TsfPrivilegeError	TSF权限模块异常，请联系系统管理员。。
InternalError.UnhandledException	[%s]模块未处理异常。。
UnauthorizedOperation.NoLicense	缺少License。。
FailedOperation.ConfigApplicationQueryFailed	应用查询失败。
FailedOperation.ConfigQueryFailed	配置项查询失败。
FailedOperation.UnhandledException	模块未处理异常。

5. 示例

示例1 查询配置项列表

输入示例

https://tsf.api3.<no value>/?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.cloud.iov.driverapi: DEBUG\r\n    com.cloud.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.cloud.iov.driverapi: DEBUG\r\n    com.cloud.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
        }
      ]
    }
  }
}