1. 接口描述
接口请求域名: tsf.tencentcloudapi.com 。
查询公共配置(单条)
默认接口请求频率限制:20次/秒。
                推荐使用 API Explorer
            
            点击调试
        
                API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
            
        2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 | 
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribePublicConfig。 | 
| Version | 是 | String | 公共参数,本接口取值:2018-03-26。 | 
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 | 
| ConfigId | 是 | String | 需要查询的配置ID。该参数可以通过调用 DescribePublicConfigs 的返回值中的 ConfigId 字段来获取或通过登录控制台配置详情-配置版本页查看;也可以调用CreatePublicConfig创建新的配置。 示例值:dcfg-p-vkj5dnky | 
3. 输出参数
| 参数名称 | 类型 | 描述 | 
|---|---|---|
| Result | Config | 全局配置。 注意:此字段可能返回 null,表示取不到有效值。 | 
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 | 
4. 示例
示例1 查询公共配置(单条)
输入示例
POST / HTTP/1.1
Host: tsf.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribePublicConfig
<公共请求参数>
{
    "ConfigId": "dcfg-p-vkj5dnky"
}输出示例
{
    "Response": {
        "RequestId": "8a143a46-4f13-4c9e-b536-9225ab88a55e",
        "Result": {
            "ApplicationId": null,
            "ApplicationName": null,
            "ConfigId": "dcfg-p-vkj5dnky",
            "ConfigName": "app-config",
            "ConfigType": null,
            "ConfigValue": "config: enabled",
            "ConfigVersion": "v1",
            "ConfigVersionCount": null,
            "ConfigVersionDesc": "This is desc",
            "CreationTime": "2024-12-20 19:16:10",
            "DeleteFlag": true,
            "LastUpdateTime": null
        }
    }
}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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 | 
|---|---|
| FailedOperation.TsfPrivilegeError | TSF权限模块异常,请联系系统管理员。 | 
| ResourceNotFound.MicroserviceOffline | 目标微服务已离线。 | 
| UnauthorizedOperation.NoLicense | 缺少License,请参考购买指南购买TSF资源后重试。 |