微服务平台 TSF 创建文件配置项并返回详细信息-API 文档-文档中心-腾讯云

1. 接口描述

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

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

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreateFileConfigWithDetailResp。
Version	是	String	公共参数，本接口取值：2018-03-26。
Region	是	String	公共参数，详见产品支持的地域列表。
ConfigName	是	String	配置项名称示例值：consumer-config
ConfigVersion	是	String	配置项版本示例值：1
ConfigFileName	是	String	配置项文件名示例值：update
ConfigFileValue	是	String	配置项文件内容（原始内容编码需要 utf-8 格式，如果 ConfigFileCode 为 gbk，后台会进行转换）示例值：workdir
ApplicationId	是	String	配置项关联应用ID 示例值：application-dapbkdgy
ConfigFilePath	是	String	发布路径示例值：/root
ConfigVersionDesc	否	String	配置项版本描述示例值：first
ConfigFileCode	否	String	配置项文件编码，utf-8 或 gbk。注：如果选择 gbk，需要新版本 tsf-consul-template （公有云虚拟机需要使用 1.32 tsf-agent，容器需要从文档中获取最新的 tsf-consul-template-docker.tar.gz）的支持示例值：utf-8
ConfigPostCmd	否	String	后置命令示例值：/usr/bin/bash
EncodeWithBase64	否	Boolean	Base64编码的配置项示例值：true
ProgramIdList.N	否	Array of String	无

3. 输出参数

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

4. 示例

示例1 创建文件配置项

为应用创建文件配置

输入示例

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

{
    "ConfigName": "abc",
    "ConfigVersion": "abc",
    "ConfigVersionDesc": "abc",
    "ConfigFileName": "abc",
    "ConfigFileValue": "abc",
    "ConfigFileCode": "abc",
    "ApplicationId": "abc",
    "ConfigFilePath": "abc",
    "ConfigPostCmd": "abc",
    "EncodeWithBase64": true,
    "ProgramIdList": [
        "abc"
    ]
}

输出示例

{
    "Response": {
        "Result": {
            "ConfigId": "abc",
            "ConfigName": "abc",
            "ConfigVersion": "abc",
            "ConfigVersionDesc": "abc",
            "ConfigFileName": "abc",
            "ConfigFileValue": "abc",
            "ConfigFileCode": "abc",
            "CreationTime": "abc",
            "ApplicationId": "abc",
            "ApplicationName": "abc",
            "DeleteFlag": true,
            "ConfigVersionCount": 0,
            "LastUpdateTime": "abc",
            "ConfigFilePath": "abc",
            "ConfigPostCmd": "abc",
            "ConfigFileValueLength": 1
        },
        "RequestId": "abc"
    }
}

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	配置项创建失败。
InvalidParameterValue.ApplicationNotExists	无法获取应用。
InvalidParameterValue.ConfigExists	配置项已存在。
InvalidParameterValue.FileConfigExists	文件配置项已存在。
InvalidParameterValue.FileConfigExistsPath	配置文件路径重复。
InvalidParameterValue.FileConfigExistsPathOther	其他用户已发布此配置文件路径。
InvalidParameterValue.FileConfigFileNameInvalid	文件配置项文件名称不合规。
InvalidParameterValue.FileConfigFilePathInvalid	文件配置项文件路径不合规。
InvalidParameterValue.FileConfigNameInvalid	文件配置项名称不合规。
InvalidParameterValue.FileConfigVersionDescInvalid	文件配置项版本描述不合规。
InvalidParameterValue.FileConfigVersionInvalid	文件配置项版本不合规。
InvalidParameterValue.ResourcePermissionDenied	无权限操作资源%s。
MissingParameter.FileConfigFileValueRequired	文件配置项文件内容未填写。

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

本页目录：