创建预算项目

最近更新时间:2025-09-23 01:11:59

我的收藏

1. 接口描述

接口请求域名: billing.tencentcloudapi.com 。

创建预算信息

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateBudget。
Version String 公共参数,本接口取值:2018-07-09。
Region String 公共参数,本接口不需要传递此参数。
BudgetName String 预算名称
示例值:API创建预算计划
CycleType String DAY 天,MONTH 月度,QUARTER 季度 ,YEAR 年度
示例值:DAY
PeriodBegin String 有效期起始时间 2025-01-01(周期: 天) / 2025-01(周期: 月)
示例值:2025-01-01
PeriodEnd String 有效期结束时间 2025-12-01(周期:天) / 2025-12(周期:月)
示例值:2025-12-01
PlanType String FIX 固定预算,CYCLE 计划预算
示例值:FIX
BudgetQuota String 预算值额度
预算计划类型为FIX(固定预算)时传定值;
预算计划类型为CYCLE(计划预算)时传[{"dateDesc":"2025-07","quota":"1000"},{"dateDesc":"2025-08","quota":"2000"}];
示例值:1000
BillType String BILL 系统账单,CONSUMPTION 消耗账单
示例值:BILL
FeeType String COST 原价,REAL_COST 实际费用,CASH 现金,INCENTIVE 赠送金,VOUCHER 代金券,TRANSFER 分成金,TAX 税,AMOUNT_BEFORE_TAX 现金支付(税前)
示例值:COST
WarnJson.N Array of BudgetWarn 阈值提醒
BudgetNote String 预算备注
示例值:使用api创建预算信息
DimensionsRange BudgetConditionsForm 预算维度范围条件
WaveThresholdJson.N Array of WaveThresholdForm 波动提醒

3. 输出参数

参数名称 类型 描述
Data BudgetInfoApiResponse 创建预算返回信息
Message String create success
示例值:信息提示
Code Integer 返回码
示例值:0
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建预算项目

输入示例

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

{
    "BudgetName": "testapi111",
    "CycleType": "DAY",
    "PeriodBegin": "2025-01-01",
    "PeriodEnd": "2025-12-01",
    "PlanType": "FIX",
    "BudgetQuota": "1000",
    "BillType": "BILL",
    "FeeType": "COST",
    "WarnJson": [
        {
            "WarnType": "ACTUAL",
            "CalType": "PERCENTAGE",
            "ThresholdValue": "100"
        }
    ],
    "BudgetNote": "使用api创建预算信息",
    "DimensionsRange": {
        "Business": [
            null
        ],
        "PayMode": [
            null
        ],
        "ProductCodes": [
            null
        ],
        "ComponentCodes": [
            null
        ],
        "ZoneIds": [
            null
        ],
        "RegionIds": [
            null
        ],
        "ProjectIds": [
            null
        ],
        "ActionTypes": [
            null
        ],
        "ConsumptionTypes": [
            null
        ],
        "Tags": [
            {
                "TagKey": null,
                "TagValue": [
                    null
                ]
            }
        ],
        "PayerUins": [
            null
        ],
        "OwnerUins": [
            null
        ],
        "TreeNodeUniqKeys": [
            null
        ]
    },
    "WaveThresholdJson": [
        {
            "WarnType": null,
            "Threshold": null,
            "MetaType": null,
            "PeriodType": null
        }
    ]
}

输出示例

{
    "Response": {
        "Code": 0,
        "Data": {
            "BudgetId": "1963509727611474000",
            "UpdateTime": "2025-09-04 15:49:33"
        },
        "Message": "create success",
        "RequestId": "922dcc4b-55b2-401d-8eb8-9160117d07d4"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

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

错误码 描述
InternalError.GatewayError 网关错误。
InternalError.UnknownError 未定义异常。