1. 接口描述
接口请求域名： tsf.tencentcloudapi.com 。
查询配置发布信息
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeConfigReleases。 |
| Version | 是 | String | 公共参数，本接口取值：2018-03-26。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| ConfigName | 否 | String | 配置项名称，不传入时查询全量 示例值：configName |
| GroupId | 否 | String | 部署组ID，不传入时查询全量 示例值：group-aln2284v |
| NamespaceId | 否 | String | 命名空间ID，不传入时查询全量 示例值：namespace-vw8oox6v |
| ClusterId | 否 | String | 集群ID，不传入时查询全量 示例值：cluster-yne99jdy |
| Limit | 否 | Integer | 每页条数 示例值：10 |
| Offset | 否 | Integer | 偏移量 示例值：0 |
| ConfigId | 否 | String | 配置ID，不传入时查询全量 示例值：dcfg-yo82mmra |
| ApplicationId | 否 | String | 应用ID，不传入时查询全量 示例值：application-a7rwwz4v |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | TsfPageConfigRelease | 分页的配置发布信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：{"Content":[{"ApplicationId":"application-a7rwwz4v","ClusterId":"cluster-yne99jdy","ClusterName":"cluster-jolyonzheng","ConfigCenters":[{"ConfigCenterInstanceId":null,"ConfigCenterInstanceName":null,"ConfigType":"SHARE","CurrentVersion":null,"RegionId":null,"TargetVersion":null}],"ConfigId":"dcfg-yo82mmra","ConfigName":"jolyonzheng-config","ConfigReleaseId":"dcfgr-yxd366ov","ConfigVersion":"v3","DualStatus":"DUAL_STATUS_WRITE_REGISTRATION_OFF","GroupId":"group-aln2284v","GroupName":"group-provider-1","NamespaceId":"namespace-vw8oox6v","NamespaceName":"cluster-jolyonzheng_default","ReleaseDesc":"This is desc","ReleaseTime":"2024-12-24 15:57:15"}],"TotalCount":1} |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询配置发布信息
输入示例
POST / HTTP/1.1
Host: tsf.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeConfigReleases
<公共请求参数>
{
"ConfigName": "app-config",
"GroupId": "group-aln2284v",
"NamespaceId": "namespace-vw8oox6v",
"ClusterId": "cluster-yne99jdy",
"Limit": 10,
"Offset": 0,
"ConfigId": "dcfg-yo82mmra",
"ApplicationId": "application-a7rwwz4v"
}输出示例
{
"Response": {
"RequestId": "16fa1e0b-d3e8-4b1f-b15f-e1d01966acb7",
"Result": {
"Content": [
{
"ApplicationId": "application-a7rwwz4v",
"ClusterId": "cluster-yne99jdy",
"ClusterName": "cluster-app",
"ConfigCenters": [
{
"ConfigCenterInstanceId": null,
"ConfigCenterInstanceName": null,
"ConfigType": "SHARE",
"CurrentVersion": null,
"RegionId": null,
"TargetVersion": null
}
],
"ConfigId": "dcfg-yo82mmra",
"ConfigName": "app-config",
"ConfigReleaseId": "dcfgr-yxd366ov",
"ConfigVersion": "v3",
"GroupId": "group-aln2284v",
"GroupName": "group-provider",
"NamespaceId": "namespace-vw8oox6v",
"NamespaceName": "cluster-app_default",
"ReleaseDesc": "This is desc",
"ReleaseTime": "2024-12-24 15:57:15"
}
],
"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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.ConfigGroupQueryFailed | 部署组查询失败。 |
| FailedOperation.ConfigReleaseQueryFailed | 配置项发布信息查询失败。 |
| FailedOperation.TsfPrivilegeError | TSF权限模块异常，请联系系统管理员。。 |
| InternalError.UnhandledException | [%s]模块未处理异常。。 |
| InvalidParameter.ParamError | 参数错误。 |
| ResourceNotFound.MicroserviceOffline | 目标微服务已离线[%s]。。 |
| UnauthorizedOperation.NoLicense | 缺少License。。 |
| UnauthorizedOperation.NoPrivilege | 用户无权限访问该接口。。 |
