全部产品
Search
文档中心

数据库备份 DBS:DescribeBackupPlanBilling - 查看备份计划计费信息

更新时间:Nov 14, 2024

该接口用于查看备份计划计费信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dbs:DescribeBackupPlanBillingget
  • BackupPlan
    acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}

请求参数

名称类型必填描述示例值
BackupPlanIdstring

备份计划 ID,可通过调用 DescribeBackupPlanList 接口获取该参数的值。

dbstooi01ex****
ClientTokenstring

用于保证请求的幂等性,防止重复提交请求。由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过 64 个 ASCII 字符,且该参数值中不能包含非 ASCII 字符。

ETnLKlblzczshOTUbOCzxxxxxxxxxx
ShowStorageTypeboolean

是否展示存储类型。

true

返回参数

名称类型描述示例值
object
HttpStatusCodeinteger

错误码值。

400
RequestIdstring

请求 ID。

DD7BC7F5-4E3A-5DF3-BFF9-831503C4D9E3
ErrCodestring

错误码字符串。

InvalidParameter
Successboolean

请求成功状态。

true
ErrMessagestring

错误信息。

This backupPlan can't support this action
Itemobject

备份计划计费信息列表。

BuyCreateTimestamplong

实例购买时间,格式为时间戳。

1658372830000
FullStorageSizelong

实例全量备份数据内置存储量,单位为字节(B)。

151
BuyExpiredTimestamplong

实例到期时间,格式为时间戳。

说明 该参数仅在 BuyChargeType 选择 PREPAY 时显示。
1661097600000
BuySpecstring

实例规格。

micro
QuotaEndTimestamplong

免费备份流量计费周期结束时间,格式为时间戳。

1659283200000
IsExpiredboolean

实例是否过期。

说明 该参数仅在 BuyChargeType 选择 PREPAY 时显示。
true
QuotaStartTimestamplong

免费备份流量计费周期开始时间,格式为时间戳。

1656604800000
TotalFreeByteslong

当月免费备份总流量,单位为字节(B)。

说明 该参数仅在 BuyChargeType 选择 PREPAY 且 IsFreeBytesUnlimited 为 false 时显示。
858993459200
PaiedByteslong

当月付费备份流量合计,单位为字节(B)。

0
UsedFullByteslong

当月付费全量备份流量,单位为字节(B)。

0
IsFreeBytesUnlimitedboolean

实例是否为无备份流量上限规格。

true
ContStorageSizelong

实例增量备份数据内置存储量,单位为字节(B)。

10437039
BuyChargeTypestring

购买费用类型,返回值如下:

  • PREPAY:预付费(包年包月)
  • POSTPAY:后付费(按量付费)
PREPAY
UsedIncrementByteslong

当月付费增量备份流量,单位为字节(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错误码错误信息描述
403Request.ForbiddenHave no Permissions当前操作未被授权,请联系主账号在RAM控制台进行授权后再执行操作

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史