该接口用于查看备份计划计费信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
dbs:DescribeBackupPlanBilling |
get |
*BackupPlan
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| BackupPlanId |
string |
是 |
备份计划 ID,可通过调用 DescribeBackupPlanList 接口获取该参数的值。 |
dbstooi01ex**** |
| ClientToken |
string |
否 |
用于保证请求的幂等性,防止重复提交请求。由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过 64 个 ASCII 字符,且该参数值中不能包含非 ASCII 字符。 |
ETnLKlblzczshOTUbOCzxxxxxxxxxx |
| ShowStorageType |
boolean |
否 |
是否展示存储类型。 |
true |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| HttpStatusCode |
integer |
错误码值。 |
400 |
| RequestId |
string |
请求 ID。 |
DD7BC7F5-4E3A-5DF3-BFF9-831503C4D9E3 |
| ErrCode |
string |
错误码字符串。 |
InvalidParameter |
| Success |
boolean |
请求成功状态。 |
true |
| ErrMessage |
string |
错误信息。 |
This backupPlan can't support this action |
| Item |
object |
备份计划计费信息列表。 |
|
| BuyCreateTimestamp |
integer |
实例购买时间,格式为时间戳。 |
1658372830000 |
| FullStorageSize |
integer |
实例全量备份数据内置存储量,单位为字节(B)。 |
151 |
| BuyExpiredTimestamp |
integer |
实例到期时间,格式为时间戳。 说明
该参数仅在 BuyChargeType 选择 PREPAY 时显示。 |
1661097600000 |
| BuySpec |
string |
实例规格。 |
micro |
| QuotaEndTimestamp |
integer |
免费备份流量计费周期结束时间,格式为时间戳。 |
1659283200000 |
| IsExpired |
boolean |
实例是否过期。 说明
该参数仅在 BuyChargeType 选择 PREPAY 时显示。 |
true |
| QuotaStartTimestamp |
integer |
免费备份流量计费周期开始时间,格式为时间戳。 |
1656604800000 |
| TotalFreeBytes |
integer |
当月免费备份总流量,单位为字节(B)。 说明
该参数仅在 BuyChargeType 选择 PREPAY 且 IsFreeBytesUnlimited 为 false 时显示。 |
858993459200 |
| PaiedBytes |
integer |
当月付费备份流量合计,单位为字节(B)。 |
0 |
| UsedFullBytes |
integer |
当月付费全量备份流量,单位为字节(B)。 |
0 |
| IsFreeBytesUnlimited |
boolean |
实例是否为无备份流量上限规格。 |
true |
| ContStorageSize |
integer |
实例增量备份数据内置存储量,单位为字节(B)。 |
10437039 |
| BuyChargeType |
string |
购买费用类型,返回值如下:
|
PREPAY |
| UsedIncrementBytes |
integer |
当月付费增量备份流量,单位为字节(B)。 |
9406734 |
示例
正常返回示例
JSON格式
{
"HttpStatusCode": 400,
"RequestId": "DD7BC7F5-4E3A-5DF3-BFF9-831503C4D9E3",
"ErrCode": "InvalidParameter",
"Success": true,
"ErrMessage": "This backupPlan can't support this action",
"Item": {
"BuyCreateTimestamp": 1658372830000,
"FullStorageSize": 151,
"BuyExpiredTimestamp": 1661097600000,
"BuySpec": "micro",
"QuotaEndTimestamp": 1659283200000,
"IsExpired": true,
"QuotaStartTimestamp": 1656604800000,
"TotalFreeBytes": 858993459200,
"PaiedBytes": 0,
"UsedFullBytes": 0,
"IsFreeBytesUnlimited": true,
"ContStorageSize": 10437039,
"BuyChargeType": "PREPAY",
"UsedIncrementBytes": 9406734
}
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 403 | Request.Forbidden | Have no Permissions | 当前操作未被授权,请联系主账号在RAM控制台进行授权后再执行操作 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。