QueryBalanceAcct - 查询用户账户余额信息--费用中心-火山引擎

文档中心

立即注册

导航

QueryBalanceAcct - 查询用户账户余额信息

最近更新时间：2024.06.20 15:49:31首次发布时间：2024.03.19 18:30:56

查询账户余额信息

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	QueryBalanceAcct	要执行的操作，取值：QueryBalanceAcct。
Version	String	是	2022-01-01	API的版本，取值：2022-01-01。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
ArrearsBalance	String	1.01	欠费金额
AvailableBalance	String	1.01	可用余额
CashBalance	String	1.01	现金余额
CreditLimit	String	1.01	信控额度
FreezeAmount	String	1.01	冻结金额
AccountID	Integer	21000000X	账号ID

请求示例

GET /?Action=QueryBalanceAcct&Version=2022-01-01 HTTP/1.1
Host: https://open.volcengineapi.com?Action= QueryBalanceAcct&Version=2022-01-01
--header 'Authorization: Basic QUtUQWIwQTRhaxxxxxxxxxxxxxxxxxxxxxxxx' \
--header 'X-Top-Service: billing' \
--header 'X-Top-Account-Id: 21000xxxxx'

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202308231151163C400BE8545DED89B87D",
        "Action": "QueryBalanceAcct",
        "Version": "2022-01-01",
        "Service": "billing"
    },
    "Result": {
        "AccountID": 210xxxxxxx,
        "ArrearsBalance": "1.01",
        "AvailableBalance": "77.01",
        "CashBalance": "83.01",
        "CreditLimit": "0.01",
        "FreezeAmount": "5.01",
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	RecordNoFound	The Record No Found.	查询无记录
400	InvalidParam	The parameter is invalid	请求参数非法
500	InternalError	The request has failed due to an unknown error	系统未知异常，请重试