1. 接口描述
接口请求域名: billing.tencentcloudapi.com 。
获取预算详细信息
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeBudget。 |
Version | 是 | String | 公共参数,本接口取值:2018-07-09。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
PageNo | 是 | Integer | 页码,整型 示例值:1 |
PageSize | 是 | Integer | 每页数目,整型 示例值:10 |
BudgetId | 否 | String | 预算项目id 示例值:1231 |
BudgetName | 否 | String | 预算名称 示例值:1元-按日-固定-全产品-三个月 |
BudgetStatus | 否 | String | EXPIRED失效,ACTIVE生效中, ACTIVATED待生效 示例值:ACTIVE |
CycleTypes.N | 否 | Array of String | DAY天 MONTH月度 QUARTER季度 YEAR年度 示例值:["DAY"] |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Data | DataForBudgetInfoPage | 预算项目详情 |
Message | String | 信息提示 注意:此字段可能返回 null,表示取不到有效值。 示例值:query success |
Code | Integer | 返回码 示例值:0 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 依据BudgetId获取预算信息
输入示例
POST / HTTP/1.1
Host: billing.tencentcloudapi.com
Content-Type: application/json
X-TC-Action:DescribeBudget
<公共请求参数>
{
"PageNo": 1,
"PageSize": 1,
"BudgetId": "1963509727611473921",
"BudgetName": null,
"BudgetStatus": null,
"CycleTypes": [
null
]
}
输出示例
{
"Response": {
"Code": 0,
"Data": {
"Current": 1,
"Pages": 1,
"Records": [
{
"BillType": "BILL",
"BudgetId": "1963509727611473921",
"BudgetName": "API创建预算计划",
"BudgetNote": "使用使用api创建预算信息",
"BudgetProgress": "0.00",
"BudgetQuota": "1200",
"BudgetQuotaJson": null,
"BudgetSendInfoForm": [
{
"BudgetId": null,
"EndTime": "23:59:59",
"Id": null,
"NoticeWays": [
"EMAIL",
"SMS",
"SITE"
],
"ReceiverIds": [],
"ReceiverType": "UIN",
"StartTime": "10:00:00",
"WeekDays": [
1,
2,
3,
4,
5,
6,
7
]
}
],
"BudgetStatus": "ACTIVE",
"CreateTime": "2025-09-04 15:49:34",
"CurDateDesc": "2025-09-11",
"CycleType": "DAY",
"DefaultMode": 0,
"Dimensions": "COST",
"DimensionsRange": {
"ActionTypes": null,
"Business": [
"p_cvm"
],
"ComponentCodes": null,
"ConsumptionTypes": null,
"OwnerUins": null,
"PayMode": null,
"PayerUins": null,
"ProductCodes": null,
"ProjectIds": null,
"RegionIds": null,
"Tags": null,
"TreeNodeUniqKeys": null,
"ZoneIds": null
},
"FeeType": "COST",
"ForecastCost": null,
"ForecastProgress": null,
"HasForecast": "1",
"MoneyStatus": 1,
"PayerUin": 909619400,
"PeriodBegin": "2025-01-01",
"PeriodEnd": "2025-12-01",
"PlanType": "FIX",
"RealCost": "0.00",
"RemindTimes": 0,
"TemplateType": null,
"UpdateTime": "2025-09-04 15:59:14",
"WarnJson": [
{
"CalType": "PERCENTAGE",
"ThresholdValue": "100",
"WarnType": "ACTUAL"
}
],
"WaveThresholdJson": [
{
"MetaType": "chain",
"PeriodType": "day",
"Threshold": "100",
"WarnType": "ACTUAL"
}
]
}
],
"Size": 1,
"Total": 1
},
"Message": "query success",
"RequestId": "9844721a-b6c5-4566-906c-41b88bf976f8"
}
}
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. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。