发布配置返回详细信息

最近更新时间:2024-12-27 11:24:06

我的收藏

1. 接口描述

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

发布配置,并且返回配置 ID

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ReleaseConfigWithDetailResp。
Version String 公共参数,本接口取值:2018-03-26。
Region String 公共参数,详见产品支持的 地域列表
ConfigId String 配置ID
示例值:dcfg-yo82mmra
GroupId String 部署组ID
示例值:group-aln2284v
ReleaseDesc String 发布描述
示例值:This is desc

3. 输出参数

参数名称 类型 描述
Result ConfigRelease 配置项发布 ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:{"ApplicationId":null,"ClusterId":null,"ClusterName":null,"ConfigCenters":null,"ConfigId":null,"ConfigName":null,"ConfigReleaseId":"dcfgr-yxd366ov","ConfigVersion":null,"DualStatus":null,"GroupId":null,"GroupName":null,"NamespaceId":null,"NamespaceName":null,"ReleaseDesc":null,"ReleaseTime":null}
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 发布配置

将一个应用配置项发布到指定的应用部署组

输入示例

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

{
    "ConfigId": "dcfg-yo82mmra",
    "GroupId": "group-aln2284v",
    "ReleaseDesc": "This is desc"
}

输出示例

{
    "Response": {
        "RequestId": "1892e2c1-9223-4979-bf25-1935c7eeed12",
        "Result": {
            "ApplicationId": null,
            "ClusterId": null,
            "ClusterName": null,
            "ConfigCenters": null,
            "ConfigId": null,
            "ConfigName": null,
            "ConfigReleaseId": "dcfgr-yxd366ov",
            "ConfigVersion": null,
            "GroupId": null,
            "GroupName": null,
            "NamespaceId": null,
            "NamespaceName": null,
            "ReleaseDesc": null,
            "ReleaseTime": null
        }
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.ConfigGroupQueryFailed 部署组查询失败。
FailedOperation.UnhandledException 模块未处理异常。
InternalError.CanNotConnConsulServer 配置发布失败:无法连接配置中心服务器。
InternalError.ConsulServerError 配置发布失败:配置中心服务器处理失败。
InternalError.UnhandledException [%s]模块未处理异常。。
InvalidParameter.ParamError 参数错误。
InvalidParameterValue.ConfigAlreadyReleased 配置项已经发布过。
InvalidParameterValue.ConfigGroupApplicationIdNotMatch 配置项和部署组所属应用不一致。
InvalidParameterValue.ConfigNotExistsOrPermissionDenied 无法获取配置项或无权限访问。
InvalidParameterValue.GroupNotExists 无法获取部署组。
InvalidParameterValue.ResourcePermissionDenied 无权限操作资源%s。
MissingParameter.ConfigIdRequired 配置项ID未填写。
MissingParameter.GroupIdRequired 部署组ID未填写。
UnauthorizedOperation.NoPrivilege 用户无权限访问该接口。。