DescribeBackupPlanBilling - Data Management - Alibaba Cloud Documentation Center

This operation queries the billing information of a backup plan.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dbs:DescribeBackupPlanBilling

get

*BackupPlan

acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}

None

Request parameters

Parameter	Type	Required	Description	Example
BackupPlanId	string	Yes	The ID of the backup plan. Call the DescribeBackupPlanList operation to obtain the value of this parameter.	dbstooi01ex****
ClientToken	string	No	A client token to ensure the idempotence of the request. The client generates this value. It must be unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.	ETnLKlblzczshOTUbOCzxxxxxxxxxx
ShowStorageType	boolean	No	Specifies whether to display the storage class.	true

Response elements

Element	Type	Description	Example
	object
HttpStatusCode	integer	The HTTP status code.	400
RequestId	string	The request ID.	DD7BC7F5-4E3A-5DF3-BFF9-831503C4D9E3
ErrCode	string	The error code.	InvalidParameter
Success	boolean	Indicates whether the request is successful.	true
ErrMessage	string	The error message.	This backupPlan can't support this action
Item	object	The billing information of the backup plan.
BuyCreateTimestamp	integer	The timestamp that indicates when the instance was purchased.	1658372830000
FullStorageSize	integer	The storage space used by full backup data. Unit: bytes.	151
BuyExpiredTimestamp	integer	The timestamp that indicates when the instance expires. Note This parameter is returned only when BuyChargeType is set to PREPAY.	1661097600000
BuySpec	string	The instance type.	micro
QuotaEndTimestamp	integer	The timestamp that indicates the end of the billing cycle for the free backup traffic.	1659283200000
IsExpired	boolean	Indicates whether the instance has expired. Note This parameter is returned only when BuyChargeType is set to PREPAY.	true
QuotaStartTimestamp	integer	The timestamp that indicates the start of the billing cycle for the free backup traffic.	1656604800000
TotalFreeBytes	integer	The total free backup traffic in the current month. Unit: bytes. Note This parameter is returned only when BuyChargeType is set to PREPAY and IsFreeBytesUnlimited is false.	858993459200
PaiedBytes	integer	The total paid backup traffic in the current month. Unit: bytes.	0
UsedFullBytes	integer	The paid traffic for full backups in the current month. Unit: bytes.	0
IsFreeBytesUnlimited	boolean	Indicates whether the instance provides unlimited free backup traffic.	true
ContStorageSize	integer	The storage space used by incremental backup data. Unit: bytes.	10437039
BuyChargeType	string	The billing method of the instance. Valid values: PREPAY: subscription POSTPAY: pay-as-you-go	PREPAY
UsedIncrementBytes	integer	The paid traffic for incremental backups in the current month. Unit: bytes.	9406734

Examples

Success response

JSON format

{
  "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
  }
}

Error codes

HTTP status code	Error code	Error message	Description
403	Request.Forbidden	Have no Permissions

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.