1. 接口描述
接口请求域名: tsf.tencentcloudapi.com 。
创建公共配置项,并返回配置项详细信息
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreatePublicConfigWithDetailResp。 |
Version | 是 | String | 公共参数,本接口取值:2018-03-26。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
ConfigName | 是 | String | 配置项名称 示例值:app-config |
ConfigVersion | 是 | String | 配置项版本 示例值:v1 |
ConfigValue | 是 | String | 配置项值,总是接收yaml格式的内容 示例值:config: enabled |
ConfigVersionDesc | 否 | String | 配置项版本描述 示例值:This is desc |
ConfigType | 否 | String | 配置项类型 示例值:public |
EncodeWithBase64 | 否 | Boolean | Base64编码的配置项 示例值:true |
ProgramIdList.N | 否 | Array of String | 无 示例值:["program-6a79x94v"] |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Result | Config | 公共配置项 ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:{"ApplicationId":null,"ApplicationName":null,"ConfigId":"dcfg-p-vkj5dnky","ConfigName":"app-config","ConfigType":"public","ConfigValue":"config: enabled","ConfigVersion":"v1","ConfigVersionCount":null,"ConfigVersionDesc":"This is desc","CreationTime":null,"DeleteFlag":null,"EncodeWithBase64":true,"LastUpdateTime":null} |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建公共配置项
创建公共配置项
输入示例
POST / HTTP/1.1
Host: tsf.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreatePublicConfigWithDetailResp
<公共请求参数>
{
"ConfigName": "app-config",
"ConfigVersion": "v1",
"ConfigVersionDesc": "This is desc",
"ConfigValue": "config: enabled",
"ConfigType": "public",
"EncodeWithBase64": true
}
输出示例
{
"Response": {
"RequestId": "354e3865-d1ae-4cde-8de6-a50732fd00e5",
"Result": {
"ApplicationId": null,
"ApplicationName": null,
"ConfigId": "dcfg-p-vkj5dnky",
"ConfigName": "app-config",
"ConfigType": "public",
"ConfigValue": "config: enabled",
"ConfigVersion": "v1",
"ConfigVersionCount": null,
"ConfigVersionDesc": "This is desc",
"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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InvalidParameterValue.ConfigExists | 配置项已存在。 |
InvalidParameterValue.ConfigValueFormatInvalid | 配置格式不符合YAML要求。 |
InvalidParameterValue.ConfigVersionInvalid | 配置项版本不合规。 |
MissingParameter.ConfigValueRequired | 配置项值未填写。 |
UnauthorizedOperation.NoPrivilege | 用户无权限访问该接口。。 |