All Products
Search

This Product

    Database Backup:DescribeBackupPlanBilling

    Document Center

    Database Backup:DescribeBackupPlanBilling

    Last Updated:Apr 25, 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 ID of the backup gateway.

    		160813
    ClientTokenstringNo

    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.

    		ETnLKlblzczshOTUbOCzxxxxxxxxxx
    ShowStorageTypebooleanNo

    Indicates whether the storage type is displayed.

    		true

    Response parameters

    ParameterTypeDescriptionExample
    object
    HttpStatusCodeinteger

    The HTTP status code.

    		400
    RequestIdstring

    The ID of the request.

    		EB4DFD5E-3618-498D-BE35-4DBEA0072122
    ErrCodestring

    The error code.

    		InvalidParameter
    Successboolean

    Indicates whether the request is successful.

    		true
    ErrMessagestring

    The error message.

    		This backupPlan can't support this action
    Itemobject

    The billing information of the backup schedule.

    BuyCreateTimestamplong

    The timestamp that indicates when the instance was purchased.

    		1554560477000
    FullStorageSizelong

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

    		13123
    BuyExpiredTimestamplong

    The timestamp that indicates when the instance expires.

    Note This parameter is available only if the value of the BuyChargeType parameter is PREPAY.
    		1554560477000
    BuySpecstring

    The specifications of the instance.

    		micro
    QuotaEndTimestamplong

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

    		1554560477000
    IsExpiredboolean

    Indicates whether the instance expired.

    Note This parameter is available only if the value of the BuyChargeType parameter is PREPAY.
    		true
    QuotaStartTimestamplong

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

    		1554560477000
    TotalFreeByteslong

    The total free backup traffic in the current month.

    Note This parameter is available only if the value of the BuyChargeType parameter is PREPAY and the value of the IsFreeBytesUnlimited parameter is false.
    		13123
    PaiedByteslong

    The total paid backup traffic in the current month.

    		213213
    UsedFullByteslong

    The paid full backup traffic in the current month.

    		1312313
    IsFreeBytesUnlimitedboolean

    Indicates whether the instance has no backup traffic limit.

    		true
    ContStorageSizelong

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

    		12134
    BuyChargeTypestring

    The billing method. Valid values:

    • PREPAY
    • POSTPAY
    		PREPAY
    UsedIncrementByteslong

    The paid incremental backup traffic in the current month.

    		131231

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    HTTP status codeError codeError message
    403Request.ForbiddenHave no Permissions

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

    Change history

    Change timeSummary of changesOperation
    No change history