微服务平台 TSF 创建配置项并返回详细信息

1. 接口描述

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

创建配置项，返回详细信息

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreateConfigWithDetailResp。
Version	是	String	公共参数，本接口取值：2018-03-26。
Region	是	String	公共参数，详见产品支持的地域列表。
ConfigName	是	String	配置项名称，最多支持60个字符，只能包含字母、数字及分隔符（“-”、“_”），且不能以分隔符开头或结尾。示例值：app_config
ConfigVersion	是	String	配置项版本，只能包含小写字母、数字及分隔符("-"，".")，且必须以小写字母或数字开头、以小写字母或数字结尾，中间不能有连续的"-"或"."。示例值：v1.0
ConfigValue	是	String	配置项值。示例值：api.invok.limit: 5000
ApplicationId	是	String	应用ID。该参数可以通过调用 DescribeApplications 的返回值中的 ApplicationId 字段来获取或通过登录控制台查看；也可以调用CreateApplication创建新的应用。示例值：application-gyq2xry5
ConfigVersionDesc	否	String	配置项版本描述，最多支持200个字符。示例值：This is desc
ConfigType	否	String	配置项值类型，固定值。示例值：application
EncodeWithBase64	否	Boolean	Base64编码的配置项。 - true：开启 - false：关闭示例值：true
ProgramIdList.N	否	Array of String	需要绑定的数据集ID。该参数可以通过调用 DescribePrograms 的返回值中的 ProgramId 字段来获取或通过登录控制台查看；也可以调用CreateProgram创建新的数据集。示例值：["program-6a79x94v"]

3. 输出参数

参数名称	类型	描述
Result	Config	配置项。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建配置项

为应用创建配置项

输入示例

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

{
    "ConfigName": "app-config",
    "ConfigVersion": "v1.0",
    "ConfigValue": "config: enabled",
    "ApplicationId": "application-yx8m24ga"
}

输出示例

{
    "Response": {
        "RequestId": "52fb20a9-efc0-443d-97e3-cf43478f1b0d",
        "Result": {
            "ApplicationId": "application-yx8m24ga",
            "ApplicationName": null,
            "ConfigId": "dcfg-vw83k2zv",
            "ConfigName": "app-config",
            "ConfigType": null,
            "ConfigValue": "config: enabled",
            "ConfigVersion": "v1.0",
            "ConfigVersionCount": null,
            "ConfigVersionDesc": null,
            "CreationTime": null,
            "DeleteFlag": null,
            "LastUpdateTime": null
        }
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
FailedOperation.ConfigCreateFailed	配置项创建失败。
InternalError.UnhandledException	模块未处理异常。
InvalidParameterValue.ApplicationNotExists	无法获取应用。
InvalidParameterValue.ConfigExists	配置项已存在。
InvalidParameterValue.ConfigNameInvalid	配置项名称不合规。
InvalidParameterValue.ConfigValueFormatInvalid	配置格式不符合YAML要求。
InvalidParameterValue.ConfigValueTooLong	配置项值内容大小[当前值]超过限制。
InvalidParameterValue.ConfigVersionDescInvalid	配置项版本描述不合规。
InvalidParameterValue.ConfigVersionInvalid	配置项版本不合规。
InvalidParameterValue.ResourcePermissionDenied	无权限操作资源[资源ID]。
MissingParameter.ApplicationIdRequired	应用ID未填写。
MissingParameter.ConfigNameRequired	配置项名称未填写。
MissingParameter.ConfigTypeRequired	配置项类型未填写。
MissingParameter.ConfigValueRequired	配置项值未填写。
MissingParameter.ConfigVersionRequired	配置项版本未填写。
UnauthorizedOperation.NoPrivilege	用户无权限访问该接口。

创建配置项并返回详细信息

本页目录：