1. 接口描述
接口请求域名: clb.tencentcloudapi.com 。
创建Budget对象。BudgetConfigs最多支持1d、7d、30d三个刷新周期各一个;BudgetResetAt不支持作为入参设置,由系统自动维护。可在创建时通过Resources同时关联已存在的企业型模型路由实例或企业型实例下的Key。创建请求提交后,可通过DescribeBudgets查询状态。
默认接口请求频率限制:20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:CreateBudget。 |
| Version | 是 | String | 公共参数,本接口取值:2018-03-17。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-guangzhou, ap-shanghai, ap-singapore, na-siliconvalley 。 |
| BudgetConfigs.N | 否 | Array of BudgetConfigInput | 预算配置数组。 数组长度最大为3,最多可同时配置1d、7d、30d三个刷新周期,且每种刷新周期只能出现一次。BudgetResetAt不支持作为入参设置,系统会按配置的刷新周期自动维护刷新时间。 |
| BudgetName | 否 | String | Budget名称。 不传默认为 '-'。 示例值:production-budget |
| RateLimitConfig | 否 | RateLimitConfigForBudget | Budget限速配置。 |
| Resources.N | 否 | Array of BudgetResource | 创建Budget时同时关联的资源列表。 仅支持企业型模型路由实例和企业型实例下的Key。如果资源不存在或不可关联,创建请求失败;资源已关联其他Budget时将替换为新创建的Budget。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| BudgetId | String | Budget ID。 创建请求提交后返回,可通过DescribeBudgets查询状态。 示例值:budget-1a2b3c4d |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建Budget并关联实例
输入示例
POST / HTTP/1.1
Host: clb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateBudget
<公共请求参数>
{
"BudgetName": "production-budget",
"BudgetConfigs": [
{
"MaxBudget": 100,
"BudgetDuration": "1d"
},
{
"MaxBudget": 1000,
"BudgetDuration": "30d"
}
],
"RateLimitConfig": {
"TPM": 100000,
"RPM": 60
},
"Resources": [
{
"Type": "ModelRouter",
"ModelRouterId": "cmr-abc12345"
}
]
}
输出示例
{
"Response": {
"BudgetId": "budget-1a2b3c4d",
"RequestId": "dde9fece-1d15-4494-ae62-1632cc6b9f6f"
}
}
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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter.InvalidFieldValue | 参数不合规。 |
| InvalidParameterCombination | 无效参数组合 |
| InvalidParameterValue.InvalidFieldValue | 参数不合规。 |