Domain name for API request: billing.intl.tencentcloudapi.com.
Retrieve budget details
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: DescribeBudget. |
| Version | Yes | String | Common Params. The value used for this API: 2018-07-09. |
| Region | No | String | Common Params. This parameter is not required for this API. |
| PageNo | Yes | Integer | Page number, int |
| PageSize | Yes | Integer | Number of items per page, integer |
| BudgetId | No | String | Budget project id |
| BudgetName | No | String | Budget Name |
| BudgetStatus | No | String | EXPIRED, ACTIVE, ACTIVATED pending activation |
| CycleTypes.N | No | Array of String | DAY day MONTH monthly QUARTER quarter YEAR annual |
| Parameter Name | Type | Description |
|---|---|---|
| Data | DataForBudgetInfoPage | Budget project detail |
| Message | String | prompt Note: This field may return null, indicating that no valid values can be obtained. |
| Code | Integer | Return code |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: billing.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action:DescribeBudget
<Common request parameters>
{
"PageNo": 1,
"PageSize": 1,
"BudgetId": "1963509727611473921",
"BudgetName": "Budget Information 001"
"BudgetStatus": "ACTIVE",
"CycleTypes": [
"DAY"
]
}
{
"Response": {
"Code": 0,
"Data": {
"Current": 1,
"Pages": 1,
"Records": [
{
"BillType": "BILL",
"BudgetId": "1963509727611473921",
"BudgetName": "API creation budget plan"
"BudgetNote": "Use api to create budget information"
"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": [
"postpay_deduct_d"
],
"Business": [
"p_cvm"
],
"ComponentCodes": [
"v_cpu"
],
"ConsumptionTypes": [
"prepay_purchase"
],
"OwnerUins": [
"909619400"
],
"PayMode": [
"postPay"
],
"PayerUins": [
"909619400"
],
"ProductCodes": [
"sp_cvm"
],
"ProjectIds": [
"0"
],
"RegionIds": [
"47"
],
"Tags": [
{
"TagKey": "Department",
"TagValue": [
"Department 123"
]
}
],
"TreeNodeUniqKeys": [
"[\"909610400-695dhs38c28\"]"
],
"ZoneIds": [
"10001"
]
},
"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"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
There is no error code related to the API business logic. For other error codes, please see Common Error Codes.
Esta página foi útil?
Você também pode entrar em contato com a Equipe de vendas ou Enviar um tíquete em caso de ajuda.
comentários