微服务平台 TSF 查询文件配置项发布信息-API 文档-文档中心-腾讯云

1. 接口描述

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

查询文件配置项发布信息

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeFileConfigReleases。
Version	是	String	公共参数，本接口取值：2018-03-26。
Region	是	String	公共参数，详见产品支持的地域列表。
ConfigId	否	String	配置项ID 示例值：dcfg-f-v3qqrkdy
ConfigName	否	String	配置项名称示例值：conf_app
GroupId	否	String	部署组ID 示例值：group-vj3n6lzy
NamespaceId	否	String	命名空间ID 示例值：namespace-ygo3djma
ClusterId	否	String	集群ID 示例值：cls-f6bk82xc
ApplicationId	否	String	应用ID 示例值：application-vw8ljmwv
Offset	否	Integer	偏移量示例值：0
Limit	否	Integer	每页条数示例值：10

3. 输出参数

参数名称	类型	描述
Result	TsfPageFileConfigRelease	配置项发布信息列表注意：此字段可能返回 null，表示取不到有效值。示例值：{"Content":[{"ApplicationId":"application-vw8ljmwv","ClusterId":"cls-f6bk82xc","ClusterName":"cluster-container-jolyonzheng","ConfigId":"dcfg-f-v3qqrkdy","ConfigName":"conf_app","ConfigReleaseId":"dcfgr-f-vkjjw7ny","ConfigVersion":"2","GroupId":"group-vj3n6lzy","GroupName":"group-provider","NamespaceId":"namespace-ygo3djma","NamespaceName":"cluster-container-jolyonzheng_default","ReleaseDesc":"This is desc","ReleaseTime":"2024-11-28 20:49:57"}],"TotalCount":1}
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询文件配置项发布信息

输入示例

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

{
    "ConfigId": "dcfg-f-v3qqrkdy",
    "ConfigName": "conf_app",
    "GroupId": "group-vj3n6lzy",
    "NamespaceId": "namespace-ygo3djma",
    "ClusterId": "cls-f6bk82xc",
    "ApplicationId": "application-vw8ljmwv",
    "Offset": 0,
    "Limit": 10
}

输出示例

{
    "Response": {
        "RequestId": "5620eba9-1673-4b3c-b375-591910b0fbc0",
        "Result": {
            "Content": [
                {
                    "ClusterId": "cls-f6bk82xc",
                    "ClusterName": "cluster-container-jolyonzheng",
                    "ConfigId": "dcfg-f-v3qqrkdy",
                    "ConfigName": "conf_app",
                    "ConfigReleaseId": "dcfgr-f-vkjjw7ny",
                    "ConfigVersion": "2",
                    "GroupId": "group-vj3n6lzy",
                    "GroupName": "group-provider",
                    "NamespaceId": "namespace-ygo3djma",
                    "NamespaceName": "cluster-container-jolyonzheng_default",
                    "ReleaseDesc": "This is desc",
                    "ReleaseTime": "2024-11-28 20:49:57"
                }
            ],
            "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.DispatchCommonError	TSF暂时不能响应请求。
FailedOperation.TsfPrivilegeError	TSF权限模块异常，请联系系统管理员。。
ResourceNotFound.MicroserviceOffline	目标微服务已离线[%s]。。