查询文件配置项列表

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

1. 接口描述

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

查询文件配置项列表

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

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

接口既验签名又鉴权。

2. 输入参数

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

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

3. 输出参数

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

4. 错误码

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

错误码	描述
FailedOperation.ConfigApplicationQueryFailed	应用查询失败。

5. 示例

示例1 查询文件配置项列表

输入示例

https://tsf.api3.<no value>/?Action=DescribeFileConfigs
&ConfigName=sadf
&ApplicationId=application-6ymrrbag
&Offset=0
&Limit=50
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "678168f0-96f6-4d78-838c-7bcd5a305e65",
    "Result": {
      "TotalCount": 1,
      "Content": [
        {
          "ConfigId": "dcfg-f-zvw5q89v",
          "ConfigName": "sadf",
          "ConfigVersion": "1.0",
          "ConfigVersionDesc": null,
          "ConfigFileName": "Dockerfile",
          "ConfigFileCode": "UTF-8",
          "ConfigFileValue": "FROM centos:7\r\n\r\nRUN echo \"ip_resolve=4\" >> /etc/yum.conf\r\nRUN yum update -y && yum install -y java-1.8.0-openjdk\r\n\r\nCOPY demo-calculate-1.10.0-RELEASE.jar /data/tsf/\r\nCOPY run.sh /data/tsf/\r\n\r\n# GMT+8 for CentOS\r\n# run.sh\r\nCMD [\"sh\", \"-c\", \"cd /data/tsf; sh run.sh demo-calculate-1.10.0-RELEASE.jar /data/tsf\"]\r\n",
          "ConfigFilePath": "/a/",
          "ConfigPostCmd": null,
          "CreationTime": "2019-03-28 18:16:40",
          "LastUpdateTime": null,
          "ConfigVersionCount": null,
          "ApplicationId": "application-6ymrrbag",
          "ApplicationName": "provider",
          "DeleteFlag": true,
          "ConfigFileValueLength": 419
        }
      ]
    }
  }
}