All Products
Search
Document Center

Database Backup:DescribeBackupPlanBilling

Last Updated:Mar 03, 2024

Queries the billing information of a backup schedule.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
dbs:DescribeBackupPlanBillingRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
BackupPlanIdstringYes

The timestamp that indicates when the billing cycle of free backup traffic ends.

1554560477000
ClientTokenstringNo

The timestamp that indicates when the billing cycle of free backup traffic starts.

ETnLKlblzczshOTUbOCzxxxxxxxxxx
ShowStorageTypebooleanNo

Indicates whether the instance has no backup traffic limit.

true

Response parameters

ParameterTypeDescriptionExample
object
HttpStatusCodeinteger

The ID of the backup gateway.

400
RequestIdstring

The size of the built-in storage for storing full backup data.

12134
ErrCodestring

true

InvalidParameter
Successboolean

The billing method. Valid values:

  • PREPAY
  • POSTPAY
true
ErrMessagestring

1554560477000

This backupPlan can't support this action
Itemobject

The timestamp that indicates when the instance was purchased.

BuyCreateTimestamplong

The paid full backup traffic in the current month.

The HTTP status code.
FullStorageSizelong

EB4DFD5E-3618-498D-BE35-4DBEA0072122

1554560477000
BuyExpiredTimestamplong

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

The size of the built-in storage for storing incremental backup data.
BuySpecstring

Indicates whether the storage type is displayed.

micro
QuotaEndTimestamplong

The timestamp that indicates when the instance expires.

Note This parameter is available only if the value of the BuyChargeType parameter is PREPAY.
The total paid backup traffic in the current month.
IsExpiredboolean

213213

true
QuotaStartTimestamplong

ETnLKlblzczshOTUbOCzxxxxxxxxxx

The specifications of the instance.
TotalFreeByteslong

The error code.

The total free backup traffic in the current month. > This parameter is available only if the value of the BuyChargeType parameter is PREPAY and the value of the IsFreeBytesUnlimited parameter is false.
PaiedByteslong

131231

The error message.
UsedFullByteslong

1554560477000

1312313
IsFreeBytesUnlimitedboolean

The ID of the request.

true
ContStorageSizelong

Queries the billing information of a backup schedule.

BuyChargeTypestring
PREPAY
UsedIncrementByteslong

Examples

Sample success responses

JSONformat

{
  "HttpStatusCode": 400,
  "RequestId": "12134",
  "ErrCode": "InvalidParameter",
  "Success": true,
  "ErrMessage": "This backupPlan can't support this action",
  "Item": {
    "BuyCreateTimestamp": 0,
    "FullStorageSize": 1554560477000,
    "BuyExpiredTimestamp": 0,
    "BuySpec": "micro",
    "QuotaEndTimestamp": 0,
    "IsExpired": true,
    "QuotaStartTimestamp": 0,
    "TotalFreeBytes": 0,
    "PaiedBytes": 0,
    "UsedFullBytes": 1312313,
    "IsFreeBytesUnlimited": true,
    "ContStorageSize": 0,
    "BuyChargeType": "PREPAY",
    "UsedIncrementBytes": 0
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history