查询公共配置项列表
最近更新时间: 2026-09-17 00:04:02
1. 接口描述
接口请求域名: tsf.api3.fincloud.tencent.cn。
查询公共配置项列表
默认接口请求频率限制:20次/秒。
接口更新时间:2024-09-14 11:55:39。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数,本接口取值:DescribePublicConfigs |
| Version | 是 | 否 | String | 公共参数,本接口取值:2018-03-26 |
| Region | 是 | 否 | String | 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| ConfigId | 否 | 否 | String | 配置项ID,不传入时查询全量,高优先级 示例值: |
| Offset | 否 | 否 | Int64 | 偏移量,默认为0 示例值: |
| Limit | 否 | 否 | Int64 | 每页条数,默认为20 示例值: |
| ConfigIdList | 否 | 否 | Array of String | 配置项ID列表,不传入时查询全量,低优先级 示例值: |
| ConfigName | 否 | 否 | String | 配置项名称,精确查询,不传入时查询全量 示例值: |
| ConfigVersion | 否 | 否 | String | 配置项版本,精确查询,不传入时查询全量 示例值: |
| OrderBy | 否 | 否 | String | 按时间排序:creation_time;按版本号排序:config_version 示例值: |
| OrderType | 否 | 否 | String | 升序传 0,降序传 1 示例值: |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | TsfPageConfig | 分页后的全局配置项列表 示例值:查看 |
| RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter.ParamError | 参数错误。 |
| UnauthorizedOperation.NoPrivilege | 用户无权限访问该接口。。 |
5. 示例
示例1 查询公共配置项列表
输入示例
https://tsf.api3.<no value>/?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": "\u589e\u52a0\u9ed8\u8ba4hystrix\u8d85\u65f6\u8bbe\u7f6e",
"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": "\u8c03\u6574ribbon\u91cd\u8bd5",
"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": "\u8c03\u6574ribbon\u8d85\u65f6\u8bbe\u7f6e",
"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": "\u8c03\u6574\u9ed8\u8ba4hystrix\u7ebf\u7a0b\u6c60\u8bbe\u7f6e",
"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": "\u8c03\u6574\u9ed8\u8ba4hystrix\u7ebf\u7a0b\u6c60\u8bbe\u7f6e",
"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
}
]
}
}
}