创建公共配置项

最近更新时间: 2026-10-11 00:12:05

1. 接口描述

接口请求域名: tsf.api3.fincloud.tencent.com。

创建公共配置项

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

接口更新时间:2025-08-06 23:23:55。

接口只验签名不鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action 是 否 String 公共参数,本接口取值:CreatePublicConfig
Version 是 否 String 公共参数,本接口取值:2018-03-26
Region 是 否 String 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表
EncodeWithBase64 否 否 Bool Base64编码的配置项
示例值:
ProgramIdList 否 否 Array of String 无
示例值:
ConfigName 是 否 String 配置项名称
示例值:
ConfigVersion 是 否 String 配置项版本
示例值:
ConfigValue 是 否 String 配置项值,总是接收yaml格式的内容
示例值:
ConfigVersionDesc 否 否 String 配置项版本描述
示例值:
ConfigType 否 否 String 配置项类型
示例值:

3. 输出参数

参数名称 类型 描述
Result Bool true:创建成功;false:创建失败
示例值:
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

错误码 描述
InvalidParameterValue.ConfigVersionInvalid 配置项版本不合规。
MissingParameter.ConfigValueRequired 配置项值未填写。
InvalidParameterValue.ConfigValueFormatInvalid 配置格式不符合YAML要求。
InvalidParameterValue.ConfigExists 配置项已存在。
UnauthorizedOperation.NoPrivilege 用户无权限访问该接口。。
MissingParameter.ConfigNameRequired 配置项名称未填写。

5. 示例

示例1 创建公共配置项

输入示例

POST / HTTP/1.1
Host: tsf.api3.fincloud.tencent.com
Content-Type: application/json
X-TC-Action: CreatePublicConfig
<Common Parameters>

{
  "ConfigName": "config_pub_app",
  "ConfigVersion": "v1",
  "ConfigVersionDesc": "This is desc",
  "ConfigValue": "config: enabled",
  "ConfigType": "public",
  "EncodeWithBase64": true,
  "ProgramIdList": [
    "program-6a79x94v"
  ]
}

输出示例

{
  "Response": {
    "RequestId": "a1563762-2470-42d0-a35f-6a03a05d2457",
    "Result": true
  }
}