查询公共配置项列表

最近更新时间:2024-03-12 01:59:52

我的收藏

1. 接口描述

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

查询公共配置项列表

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribePublicConfigs。
Version String 公共参数,本接口取值:2018-03-26。
Region String 公共参数,详见产品支持的 地域列表
ConfigId String 配置项ID,不传入时查询全量,高优先级
示例值:dcfg-p-xxx
Offset Integer 偏移量,默认为0
示例值:0
Limit Integer 每页条数,默认为20
示例值:50
ConfigIdList.N Array of String 配置项ID列表,不传入时查询全量,低优先级
示例值:null
ConfigName String 配置项名称,精确查询,不传入时查询全量
示例值:global
ConfigVersion String 配置项版本,精确查询,不传入时查询全量
示例值:v1

3. 输出参数

参数名称 类型 描述
Result TsfPageConfig 分页后的全局配置项列表
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询公共配置项列表

输入示例

https://tsf.tencentcloudapi.com/?Action=DescribePublicConfigs
&ConfigName=global
&Offset=0
&Limit=50
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "79839cba-fda2-4e2c-9dfa-88f8492db608",
        "Result": {
            "TotalCount": 6,
            "Content": [
                {
                    "ConfigId": "dcfg-p-byx6nkyl",
                    "ConfigName": "global",
                    "ConfigVersion": "1.1",
                    "ConfigVersionDesc": "增加默认hystrix超时设置",
                    "ConfigValue": "management:\r\n  health:\r\n    consul:\r\n      enabled: false\r\n  endpoint:\r\n    health:\r\n      show-details: always\r\n\r\nhystrix:\r\n  command:\r\n    default:\r\n      execution:\r\n        timeout:\r\n          enabled: true\r\n        isolation:\r\n          thread:\r\n            timeoutInMilliseconds: 30000\r\n\r\nribbon:\r\n  ReadTimeout: 30000\r\n  ConnectTimeout: 30000        ",
                    "CreationTime": "2019-05-13 10:01:14",
                    "LastUpdateTime": null,
                    "ConfigVersionCount": null,
                    "ApplicationId": null,
                    "ApplicationName": null,
                    "DeleteFlag": true,
                    "ConfigType": null
                },
                {
                    "ConfigId": "dcfg-p-nygnkbv2",
                    "ConfigName": "global",
                    "ConfigVersion": "1.5",
                    "ConfigVersionDesc": "调整ribbon重试",
                    "ConfigValue": "management:\r\n  health:\r\n    consul:\r\n      enabled: false\r\n  endpoint:\r\n    health:\r\n      show-details: always\r\n\r\nhystrix:\r\n  command:\r\n    default:\r\n      execution:\r\n        timeout:\r\n          enabled: true\r\n        isolation:\r\n          thread:\r\n            timeoutInMilliseconds: 30000\r\n\r\nribbon:\r\n  MaxAutoRetries: 0\r\n  MaxAutoRetriesNextServer: 1\r\n  ReadTimeout: 15000\r\n  ConnectTimeout: 3000        \r\n\r\nfeign:\r\n  hystrix:\r\n    enabled: true\r\n  client:\r\n    config:\r\n      default:\r\n        c",
                    "CreationTime": "2019-05-22 10:48:05",
                    "LastUpdateTime": null,
                    "ConfigVersionCount": null,
                    "ApplicationId": null,
                    "ApplicationName": null,
                    "DeleteFlag": true,
                    "ConfigType": null
                },
                {
                    "ConfigId": "dcfg-p-py53d6v4",
                    "ConfigName": "global",
                    "ConfigVersion": "1.9",
                    "ConfigVersionDesc": "调整ribbon超时设置",
                    "ConfigValue": "management:\r\n  health:\r\n    consul:\r\n      enabled: false\r\n  endpoint:\r\n    health:\r\n      show-details: always\r\n\r\nhystrix:\r\n  command:\r\n    default:\r\n      execution:\r\n        timeout:\r\n          enabled: true\r\n        isolation:\r\n          thread:\r\n            timeoutInMilliseconds: 3000\r\n\r\nribbon:\r\n  MaxAutoRetries: 0\r\n  MaxAutoRetriesNextServer: 1\r\n  ReadTimeout: 8000\r\n  ConnectTimeout: 3000        \r\n\r\nfeign:\r\n  hystrix:\r\n    enabled: true\r\n  client:\r\n    config:\r\n      default:\r\n        con",
                    "CreationTime": "2019-05-23 23:04:54",
                    "LastUpdateTime": null,
                    "ConfigVersionCount": null,
                    "ApplicationId": null,
                    "ApplicationName": null,
                    "DeleteFlag": true,
                    "ConfigType": null
                },
                {
                    "ConfigId": "dcfg-p-dap7g3ao",
                    "ConfigName": "global",
                    "ConfigVersion": "2.3",
                    "ConfigVersionDesc": "调整默认hystrix线程池设置",
                    "ConfigValue": "management:\r\n  health:\r\n    consul:\r\n      enabled: false\r\n  endpoint:\r\n    health:\r\n      show-details: always\r\n\r\nhystrix:\r\n  threadpool:\r\n    default:\r\n      coreSize: 400\r\n      maximumSize: 400\r\n  command:\r\n    default:\r\n      execution:\r\n        timeout:\r\n          enabled: true\r\n        isolation:\r\n          thread:\r\n            timeoutInMilliseconds: 3000\r\n\r\nribbon:\r\n  MaxAutoRetries: 0\r\n  MaxAutoRetriesNextServer: 1\r\n  ReadTimeout: 8000\r\n  ConnectTimeout: 3000        \r\n\r\nfeign:\r\n  hystri",
                    "CreationTime": "2019-05-24 16:39:59",
                    "LastUpdateTime": null,
                    "ConfigVersionCount": null,
                    "ApplicationId": null,
                    "ApplicationName": null,
                    "DeleteFlag": false,
                    "ConfigType": null
                },
                {
                    "ConfigId": "dcfg-p-zvwgl6y8",
                    "ConfigName": "global",
                    "ConfigVersion": "2.4",
                    "ConfigVersionDesc": "调整默认hystrix线程池设置",
                    "ConfigValue": "management:\r\n  health:\r\n    consul:\r\n      enabled: false\r\n  endpoint:\r\n    health:\r\n      show-details: always\r\n\r\nhystrix:\r\n  threadpool:\r\n    default:\r\n      coreSize: 30\r\n      maximumSize: 30\r\n  command:\r\n    default:\r\n      execution:\r\n        timeout:\r\n          enabled: true\r\n        isolation:\r\n          thread:\r\n            timeoutInMilliseconds: 3000\r\n\r\nribbon:\r\n  MaxAutoRetries: 0\r\n  MaxAutoRetriesNextServer: 1\r\n  ReadTimeout: 8000\r\n  ConnectTimeout: 3000        \r\n\r\nfeign:\r\n  hystrix:",
                    "CreationTime": "2019-05-24 18:30:35",
                    "LastUpdateTime": null,
                    "ConfigVersionCount": null,
                    "ApplicationId": null,
                    "ApplicationName": null,
                    "DeleteFlag": true,
                    "ConfigType": null
                },
                {
                    "ConfigId": "dcfg-p-nalgo4yq",
                    "ConfigName": "global",
                    "ConfigVersion": "no.hystrix.test",
                    "ConfigVersionDesc": "no-hystrix-test",
                    "ConfigValue": "management:\r\n  health:\r\n    consul:\r\n      enabled: false\r\n  endpoint:\r\n    health:\r\n      show-details: always\r\n\r\nribbon:\r\n  MaxAutoRetries: 0\r\n  MaxAutoRetriesNextServer: 1\r\n  ReadTimeout: 8000\r\n  ConnectTimeout: 3000        ",
                    "CreationTime": "2019-05-24 20:39:12",
                    "LastUpdateTime": null,
                    "ConfigVersionCount": null,
                    "ApplicationId": null,
                    "ApplicationName": null,
                    "DeleteFlag": true,
                    "ConfigType": null
                }
            ]
        }
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

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

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