1. 接口描述
接口请求域名: billing.tencentcloudapi.com 。
获取云账户余额信息。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeAccountBalance。 |
Version | 是 | String | 公共参数,本接口取值:2018-07-09。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Balance | Integer | 接口做过变更,为兼容老接口,本字段与RealBalance相同,为当前真实可用余额,单位 分 示例值:10000 |
Uin | Integer | 查询的用户Uin 示例值:1 |
RealBalance | Float | 当前真实可用余额,单位 分 示例值:1 |
CashAccountBalance | Float | 现金账户余额,单位 分 示例值:1 |
IncomeIntoAccountBalance | Float | 收益转入账户余额,单位 分 示例值:1 |
PresentAccountBalance | Float | 赠送账户余额,单位 分 示例值:1 |
FreezeAmount | Float | 冻结金额,单位 分 示例值:1 |
OweAmount | Float | 欠费金额,单位 分 示例值:1 |
IsAllowArrears | Boolean | 是否允许欠费消费 示例值:true |
IsCreditLimited | Boolean | 是否限制信用额度 示例值:true |
CreditAmount | Float | 信用额度,单位 分 示例值:1 |
CreditBalance | Float | 可用信用额度,单位 分 示例值:1 |
RealCreditBalance | Float | 真实可用信用额度,单位 分 示例值:1 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取账户余额示例
输入示例
https://billing.tencentcloudapi.com/?Action=DescribeAccountBalance
&<公共请求参数>
输出示例
{
"Response": {
"Uin": "90961",
"RealBalance": 9647442,
"CashAccountBalance": 1299806668,
"IncomeIntoAccountBalance": 0,
"PresentAccountBalance": 209512,
"FreezeAmount": 1290368738,
"OweAmount": 0,
"RequestId": "1323",
"IsAllowArrears": true,
"IsCreditLimited": true,
"Balance": -6188426,
"CreditAmount": 200,
"CreditBalance": -6188226,
"RealCreditBalance": -6188226
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
FailedOperation.PayPriceError | 支付失败,请联系腾讯云工作人员处理。 |
InternalError | 内部错误。 |
InternalError.GatewayError | 网关错误。 |
UnauthorizedOperation.CamNoAuth | 账号没有cam授权。 |
UnsupportedOperation | 操作不支持。 |