Call the DescribeBackupPlanBilling to view the billing information of a backup plan.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeBackupPlanBilling

The parameter specified by the system. Value: DescribeBackupPlanBilling.

BackupPlanId String Yes 160813

The ID of the backup gateway.

RegionId String No cn-hangzhou

The region ID. You can call DescribeRegions query.

ClientToken String No ETnLKlblzczshOTUbOCzxxxxxxxxxx

The client token that is used to ensure the idempotency of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests. The token can only contain ASCII characters and cannot exceed 64 characters in length.

ShowStorageType Boolean No true

Indicates whether the storage type is displayed.

Response parameters

Parameter Type Example Description
ErrMessage String This backupPlan can't support this action

The error message.

ErrCode String InvalidParameter

The error code string.

HttpStatusCode Integer 400

The error code value.

Item Struct

The billing information of the backup plan.

BuyChargeType String PREPAY

The instance type. Valid values:

  • PREPAY
  • POSTPAY
BuyCreateTimestamp Long 1554560477000

The time when the instance is purchased. The format is timestamp.

BuyExpiredTimestamp Long 1554560477000

The expiration time of the instance.

Note This parameter is displayed only when BuyChargeType is set to PREPAY.
BuySpec String micro

The instance type.

ContStorageSize Long 12134

The amount of incremental backup data stored in the instance.

FullStorageSize Long 13123

The built-in storage capacity of full backup data of the instance.

IsExpired Boolean true

Indicates whether the instance expired.

Note This parameter is displayed only when BuyChargeType is set to PREPAY.
IsFreeBytesUnlimited Boolean true

Specifies whether the instance has no maximum backup traffic.

PaiedBytes Long 213213

The total paid backup traffic of the month.

QuotaEndTimestamp Long 1554560477000

The end time of the free backup data transfer billing cycle.

QuotaStartTimestamp Long 1554560477000

The start time of the free backup billing cycle.

TotalFreeBytes Long 13123

Free backup traffic for the current month.

Note This parameter is displayed only when the BuyChargeType parameter is set to PREPAY and the IsFreeBytesUnlimited parameter is set to false.
UsedFullBytes Long 1312313

The paid full backup traffic of the month.

UsedIncrementBytes Long 131231

The paid incremental backup traffic of the month.

RequestId String EB4DFD5E-3618-498D-BE35-4DBEA0072122

The ID of the request.

Success Boolean true

The success status of the request.

Examples

Sample requests

http(s)://dbs-api.cn-hangzhou.aliyuncs.com/? Action=DescribeBackupPlanBilling
&<Common request parameters>

Sample success responses

XML format

<DescribeBackupPlanBillingResponse>
  <Item>
        <IsExpired></IsExpired>
        <BuyExpiredTimestamp></BuyExpiredTimestamp>
        <TotalFreeBytes></TotalFreeBytes>
        <PaiedBytes></PaiedBytes>
        <QuotaStartTimestamp></QuotaStartTimestamp>
        <FullStorageSize></FullStorageSize>
        <BuyCreateTimestamp></BuyCreateTimestamp>
        <IsFreeBytesUnlimited></IsFreeBytesUnlimited>
        <QuotaEndTimestamp></QuotaEndTimestamp>
        <ContStorageSize></ContStorageSize>
        <BuySpec></BuySpec>
        <BuyChargeType></BuyChargeType>
        <UsedIncrementBytes></UsedIncrementBytes>
        <UsedFullBytes></UsedFullBytes>
  </Item>
  <RequestId>EB4DFD5E-3618-498D-BE35-4DBEA0072122</RequestId>
  <HttpStatusCode>400</HttpStatusCode>
  <ErrMessage>This backupPlan can't support this action</ErrMessage>
  <Success>true</Success>
  <ErrCode>InvalidParameter</ErrCode>
</DescribeBackupPlanBillingResponse>

JSON format

{"Item":{"IsExpired":"",
"BuyExpiredTimestamp":"",
"TotalFreeBytes":"",
"PaiedBytes":"",
"QuotaStartTimestamp":"",
"FullStorageSize":"",
"BuyCreateTimestamp":"",
"IsFreeBytesUnlimited":"",
"QuotaEndTimestamp":"",
"ContStorageSize":"",
"BuySpec":"",
"BuyChargeType":"",
"UsedIncrementBytes":"",
"UsedFullBytes":""},
"RequestId":"EB4DFD5E-3618-498D-BE35-4DBEA0072122",
"HttpStatusCode":"400",
"ErrMessage":"This backupPlan can't support this action",
"Success":"true",
"ErrCode":"InvalidParameter"}

Error codes

For a list of error codes, visit the API Error Center.