1. 接口描述
接口请求域名: tsf.api3.fincloud.tencent.cn。
更新参数模板
默认接口请求频率限制:20次/秒。
接口更新时间:2025-09-12 16:23:39。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数,本接口取值:UpdateConfigTemplate |
| Version | 是 | 否 | String | 公共参数,本接口取值:2018-03-26 |
| Region | 是 | 否 | String | 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| ConfigTemplateId | 是 | 否 | String | 配置模板id 示例值: |
| ConfigTemplateName | 是 | 否 | String | 配置模板名称 示例值: |
| ConfigTemplateDesc | 否 | 否 | String | 配置模板描述 示例值: |
| ConfigTemplateType | 是 | 否 | String | 配置模板对应的微服务框架 示例值: |
| ConfigTemplateValue | 是 | 否 | String | 配置模板数据 示例值: |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | Bool | 结果true:成功;false:失败; 示例值: |
| RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| MissingParameter.ConfigTemplateNameRequired | 配置模板名称未填写。 |
| MissingParameter.ConfigTemplateTypeRequired | 配置模板类型未填写。 |
| InvalidParameterValue.ConfigTemplateTypeInvalid | 配置模板类型不合规。 |
| FailedOperation.ConfigTemplateCreateFailed | 配置模板创建失败。 |
| FailedOperation.ConfigTemplateUpdateFailed | 配置模板更新失败。 |
| FailedOperation.ConfigTemplateDeleteFailed | 配置模板删除失败。 |
| FailedOperation.ConfigTemplateSearchListFailed | 配置模板分页查询失败。 |
| FailedOperation.ConfigTemplateImportFailed | 配置模板导入失败。 |
| InvalidParameterValue.ConfigTemplateDescTooLong | 配置模板描述过长。 |
| InvalidParameterValue.ConfigTemplateNameTooLong | 配置模板内容过长。 |
| MissingParameter.ConfigTemplateIdRequired | 缺少配置模板id。 |
5. 示例
示例1 更新参数模板
输入示例
POST / HTTP/1.1
Host: tsf.api3.<no value>
Content-Type: application/json
X-TC-Action: HideInstance
<公共请求参数>
{
"RegistrationId": "10.1.0.37",
"InstanceId": "10.1.0.37",
"MicroserviceId": "ms-ba22b3wa",
"MicroserviceName": "provider-demo",
"InstanceName": "tcs-10-1-0-37"
}
Content-Type: application/json
X-TC-Action: UpdateConfigTemplate
<公共请求参数>
{
"ConfigTemplateId": "dcfg_temp-aln5d3wv",
"ConfigTemplateName": "app_config",
"ConfigTemplateDesc": "This is desc",
"ConfigTemplateType": "Ribbon",
"ConfigTemplateValue": "#请求处理超时时间\\nribbon.ReadTimeout: 5000\\n#请求连接超时时间\\nribbon.ConnectTimeout: 2000\\n#同一实例最大重试次数,不包括首次调用\\nribbon.MaxAutoRetries: 0\\n#重试其他实例的最大重试次数,不包括首次所选的server\\nribbon.MaxAutoRetriesNextServer: 1\\n#是否对所有操作请求都进行重试\\nribbon.OkToRetryOnAllOperations: false\\n"
}
输出示例
{
"Response": {
"RequestId": "!2vko3112424d2322",
"Result": true
}
}