微服务平台 TSF
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > 微服务平台 TSF > API 文档 > 其他接口 > 创建参数模板返回详细信息

创建参数模板返回详细信息

最近更新时间：2024-03-12 02:00:22

我的收藏

本页目录：

1. 接口描述

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

创建参数模板，并返回模板详细信息

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：CreateConfigTemplateWithDetailResp。
Version 是 String 公共参数，本接口取值：2018-03-26。
Region 是 String 公共参数，详见产品支持的 地域列表。
ConfigTemplateName 是 String 配置模板名称
示例值：配置1
ConfigTemplateType 是 String 配置模板对应的微服务框架
示例值：Ribbon
ConfigTemplateValue 是 String 配置模板数据
示例值：#请求处理超时时间ribbon.ReadTimeout: 5000#请求连接超时时间ribbon.ConnectTimeout: 2000#同一实例最大重试次数，不包括首次调用ribbon.MaxAutoRetries: 0#重试其他实例的最大重试次数，不包括首次所选的serverribbon.MaxAutoRetriesNextServer: 1#是否对所有操作请求都进行重试ribbon.OkToRetryOnAllOperations: false
ConfigTemplateDesc 否 String 配置模板描述
示例值：test
ProgramIdList.N 否 Array of String 无

3. 输出参数

参数名称 类型 描述
Result ConfigTemplate 创建成功，返回 ID
注意：此字段可能返回 null，表示取不到有效值。
示例值：config-xxx
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建配置模板

创建配置模板

输入示例

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

{
    "ConfigTemplateName": "abc",
    "ConfigTemplateDesc": "abc",
    "ConfigTemplateType": "abc",
    "ConfigTemplateValue": "abc",
    "ProgramIdList": [
        "abc"
    ]
}

输出示例

{
    "Response": {
        "Result": {
            "ConfigTemplateId": "abc",
            "ConfigTemplateName": "abc",
            "ConfigTemplateDesc": "abc",
            "ConfigTemplateType": "abc",
            "ConfigTemplateValue": "abc",
            "CreateTime": "abc",
            "UpdateTime": "abc"
        },
        "RequestId": "xxxxxxxxxxx"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.ConfigTemplateCreateFailed 配置模板创建失败。
FailedOperation.ConfigTemplateDeleteFailed 配置模板删除失败。
FailedOperation.ConfigTemplateImportFailed 配置模板导入失败。
FailedOperation.ConfigTemplateSearchListFailed 配置模板分页查询失败。
FailedOperation.ConfigTemplateUpdateFailed 配置模板更新失败。
InvalidParameter.ConfigTemplateNameInvalid 配置模板名称不符合规范。
InvalidParameterValue.ConfigTemplateDescTooLong 配置模板描述过长。
InvalidParameterValue.ConfigTemplateNameInvalid 配置模板名称不合规。
InvalidParameterValue.ConfigTemplateNameTooLong 配置模板内容过长。
InvalidParameterValue.ConfigTemplateTypeInvalid 配置模板类型不合规。
InvalidParameterValue.ConfigValueFormatInvalid 配置格式不符合YAML要求。
MissingParameter.ConfigTemplateIdRequired 缺少配置模板id。
MissingParameter.ConfigTemplateNameRequired 配置模板名称未填写。
MissingParameter.ConfigTemplateTypeRequired 配置模板类型未填写。
中国站