API standard and pre-built SDKs in multi-language
The OpenAPI specification of this product (BssOpenApi/2017-12-14) follows the RPC standard. Alibaba Cloud provides pre-built SDKs for popular programming languages to abstract low-level complexities such as request signing. This enables developers to call APIs using language-specific syntax without dealing with HTTP details directly.
Custom signature
If your specific needs, such as a customized signature, are not supported by the SDK, manually sign requests using the signature mechanism. Note that manual signing requires significant effort (usually about 5 business days). For support, join our DingTalk group (ID: 147535001692).
Before you begin
An Alibaba Cloud account has full administrative privileges. A compromised AccessKey pair exposes all associated resources to unauthorized access, posing a significant security risk. To call APIs securely, create a Resource Access Management (RAM) user with API access only, configure its AccessKey pairs, and implement the principle of least privilege (PoLP) through RAM policies. Use the Alibaba Cloud account only when its permissions are explicitly required for specific scenarios.
Capital Flow
|
API |
Title |
Description |
| QueryAccountBalance | QueryAccountBalance | Queries the user's account balance. |
| QueryAccountTransactionDetails | QueryAccountTransactionDetails | Queries the details of account transactions (income and expenditure). |
Financial Association
|
API |
Title |
Description |
| QueryRelationList | QueryRelationList | Queries a list of the relationships of member accounts. |
| QueryPermissionList | QueryPermissionList | Queries the permissions for a master-member relationship based on the relationship ID. |
| ModifyAccountRelation | ModifyAccountRelation | Adds or deletes permissions for an account linking relationship. |
| ConfirmRelation | ConfirmRelation | Confirms an invitation from an Alibaba Cloud account. |
| RelieveAccountRelation | RelieveAccountRelation | Disassociates a RAM user from an Alibaba Cloud account. |
Resource Tag
|
API |
Title |
Description |
| QueryInstanceByTag | QueryInstanceByTag | Queries a list of instances by tags. |
| TagResources | TagResources | Adds tags to resources. |
| UntagResources | UntagResources | Removes tags from resources. |
Card Coupon
|
API |
Title |
Description |
| QueryPrepaidCards | QueryPrepaidCards | Queries information about a user's prepaid cards. |
Saving Plan
|
API |
Title |
Description |
| QuerySavingsPlansInstance | QuerySavingsPlansInstance | Queries information about your savings plan instances. |
| QuerySavingsPlansDeductLog | QuerySavingsPlansDeductLog | Queries the details of savings plan deductions. |
| DescribeSavingsPlansCoverageDetail | DescribeSavingsPlansCoverageDetail | Queries detailed information about savings plan coverage. |
| QuerySavingsPlansDiscount | QuerySavingsPlansDiscount | Queries the discount information for savings plans. |
Virtual Quotient Quota
|
API |
Title |
Description |
| CreateResellerUserQuota | CreateResellerUserQuota | Creates a user quota ledger and a quota consumption ledger. |
| QueryResellerAvailableQuota | QueryResellerAvailableQuota | Queries the available quota for a user in a reseller payment scenario. |
| SetResellerUserStatus | SetResellerUserStatus | Enables or disables the SQL audit feature for users. |
Virtual Merchant Account
|
API |
Title |
Description |
| CreateAgAccount | CreateAgAccount | Creates an account linking relationship. |
| GetCustomerAccountInfo | GetCustomerAccountInfo | Queries the account information of a customer. |
Resource Package
|
API |
Title |
Description |
| RenewResourcePackage | RenewResourcePackage | Renews a resource package instance. |
Financial Bills
|
API |
Title |
Description |
| SubscribeBillToOSS | SubscribeBillToOSS | Subscribes to bill files and stores the bill data in a specified Object Storage Service (OSS) bucket. |
| UnsubscribeBillToOSS | UnsubscribeBillToOSS | Unsubscribes from the detailed bill export service. |
| QueryBillOverview | QueryBillOverview | Queries the bill overview of an account for a specified billing cycle. |
| QueryBill | QueryBill | Queries the settlement bills for an account in a specified billing cycle. |
| QueryAccountBill | QueryAccountBill | Queries account spending within a billing cycle and aggregates the data by resource owner. |
| QuerySettleBill | QuerySettleBill | Queries the settlement bills of an account for a specific billing cycle. This operation is available for accounts on the Alibaba Cloud China Website that have more than 50,000 bill entries. |
| QueryInstanceBill | QueryInstanceBill | Queries the usage summary of all product instances or billable items for an account in a billing cycle. This operation has been upgraded to DescribeInstanceBill. This operation no longer queries data beyond the 50,000th row. |
| DescribeInstanceBill | DescribeInstanceBill | Queries the consumption summary of all product instances or billable items for an account within a billing cycle. |
| DescribeInstanceAmortizedCostByAmortizationPeriod | DescribeInstanceAmortizedCostByAmortizationPeriod | Queries the monthly amortized costs of instances for a specified amortization month. |
| DescribeProductAmortizedCostByAmortizationPeriod | DescribeProductAmortizedCostByAmortizationPeriod | Queries the monthly amortized cost of products for a specified month. |
| DescribeInstanceAmortizedCostByConsumePeriod | DescribeInstanceAmortizedCostByConsumePeriod | Queries the monthly amortized cost of an instance by billing cycle. |
| DescribeProductAmortizedCostByConsumePeriod | DescribeProductAmortizedCostByConsumePeriod | Queries the monthly amortized cost of a product for a specific billing cycle. |
| DescribeSplitItemBill | DescribeSplitItemBill | Queries split bills. |
| QuerySplitItemBill | QuerySplitItemBill | Queries split bills. This API has been upgraded. We recommend that you use the new DescribeSplitItemBill operation. |
Inquiry
|
API |
Title |
Description |
| GetPayAsYouGoPrice | GetPayAsYouGoPrice | Queries the prices of pay-as-you-go products. |
| GetSubscriptionPrice | GetSubscriptionPrice | Queries the price of a subscription product. |
Instance
|
API |
Title |
Description |
| QueryAvailableInstances | QueryAvailableInstances | Queries available instances. |
| ModifyInstance | ModifyInstance | Modifies the configuration of an instance resource. Calling this operation creates an order to modify the instance configuration and automatically completes the payment. This operation does not support configuration changes for ECS or RDS products. To do so, call the product-specific API operation instead. |
| ConvertChargeType | ConvertChargeType | Changes the billing method for an instance. You can convert Server Load Balancer (SLB), elastic IP addresses (EIPs), and NAT Gateway instances from pay-as-you-go to subscription. You can also convert SLB and EIP instances from subscription to pay-as-you-go. |
| RenewInstance | RenewInstance | Renews a specified instance. This operation cannot be used to renew ECS, RDS, or Redis instances. To renew these instances, call the dedicated renewal API for the specific product. |
| RefundInstance | RefundInstance | Cancels subscriptions for instances that you no longer need. |
Order
|
API |
Title |
Description |
| QueryOrders | QueryOrders | Queries the orders of a user or a distribution customer. By default, the query returns orders created within the last hour. To query orders over a longer period, set the CreateTimeStart and CreateTimeEnd parameters. |
| CancelOrder | CancelOrder | Cancels an unpaid order. |
Financial Unit
|
API |
Title |
Description |
| CreateCostUnit | CreateCostUnit | Creates one or more cost centers. |
| DeleteCostUnit | DeleteCostUnit | Deletes a cost center. |
| ModifyCostUnit | ModifyCostUnit | Modifies one or more cost centers. |
| QueryFinancialAccountInfo | QueryFinancialAccountInfo | Queries the financial information of an enterprise account that is part of a management-member relationship. |
Invoice
|
API |
Title |
Description |
| QueryEvaluateList | QueryEvaluateList | Queries a list of objects that are eligible for invoicing. |
| QueryCustomerAddressList | QueryCustomerAddressList | Queries the mailing addresses for Alibaba Cloud invoices. |
| QueryInvoicingCustomerList | QueryInvoicingCustomerList | Queries the invoicing information of an Alibaba Cloud user. |
| ApplyInvoice | ApplyInvoice | Submits an invoicing request. |
Product
|
API |
Title |
Description |
| QuerySkuPriceList | QuerySkuPriceList | Queries the SKUs and their list prices for a specific product feature. You can also filter the query by specifying SKU configurations in the request parameters. |
| QueryCommodityList | QueryCommodityList | Queries a list of commodity information by product code. |
| QueryPriceEntityList | QueryPriceEntityList | Queries the pricing objects of a product. A pricing object is the smallest unit of a product's capability used for metering and billing. |
| DescribePricingModule | DescribePricingModule | Queries the pricing modules of an Alibaba Cloud product. |
| QueryProductList | QueryProductList | Queries information about Alibaba Cloud products. |
Other
|
API |
Title |
Description |
| DescribeCostBudgetsSummary | DescribeCostBudgetsSummary | Queries a summary of cost budgets. |
| RenewChangeInstance | RenewChangeInstance | Renews an instance and changes its configuration. The configuration change is applied after the renewal order takes effect. Payment is processed automatically. This operation cannot be used to create ECS or RDS instances. |
Others
|
API |
Title |
Description |
| AddAccountRelation | AddAccountRelation | Creates a financial relationship. |
| AllocateCostUnitResource | AllocateCostUnitResource | Transfers resource instances from the source cost center to the destination cost center. |
| CreateInstance | CreateInstance | Creates an instance. If you call this operation, an order for a new instance is created and the order is automatically paid for. You cannot create Elastic Compute Service (ECS) instances or ApsaraDB RDS instances by calling the operation. |
| DescribeResourceCoverageDetail | DescribeResourceCoverageDetail | Queries the coverage details of reserved instances (RIs) or storage capacity units (SCUs). |
| DescribeResourceCoverageTotal | DescribeResourceCoverageTotal | Queries the total coverage data of reserved instances (RIs) or storage capacity units (SCUs). |
| DescribeResourcePackageProduct | DescribeResourcePackageProduct | Queries the information about resource plans of an Alibaba Cloud service. |
| DescribeResourceUsageDetail | DescribeResourceUsageDetail | Queries the usage details of reserved instances (RIs) or storage capacity units (SCUs). |
| DescribeResourceUsageTotal | DescribeResourceUsageTotal | Queries the total usage data of reserved instances or storage capacity units (SCUs). |
| DescribeSavingsPlansCoverageTotal | DescribeSavingsPlansCoverageTotal | Queries the total coverage of savings plans. |
| DescribeSavingsPlansUsageDetail | DescribeSavingsPlansUsageDetail | Queries the usage details of savings plans. |
| DescribeSavingsPlansUsageTotal | DescribeSavingsPlansUsageTotal | Queries the total usage of savings plans. |
| GetAccountRelation | GetAccountRelation | Queries the details of a financial relationship. |
| GetCustomerList | GetCustomerList | Queries the IDs of customers of a virtual network operator (VNO). |
| GetOrderDetail | GetOrderDetail | Queries the details of an order that belongs to your Alibaba Cloud account or distributors. |
| GetResourcePackagePrice | GetResourcePackagePrice | Queries the price of a resource plan. |
| InquiryPriceRefundInstance | InquiryPriceRefundInstance | Queries the refundable amount for an instance from which you want to unsubscribe. |
| QueryAccountTransactions | QueryAccountTransactions | Queries transactions within your Alibaba Cloud account. |
| QueryBillToOSSSubscription | QueryBillToOSSSubscription | Queries the subscribed bills that are stored in Object Storage Service (OSS) bucket. |
| QueryCashCoupons | QueryCashCoupons | Queries the information about vouchers. |
| QueryCostUnit | QueryCostUnit | Queries all cost centers within the current node of the cost center tree. If the ParentUnitId parameter is set to -1, all cost centers are queried. |
| QueryCostUnitResource | QueryCostUnitResource | Queries the resource instances that are allocated to a cost center. If the unitId parameter is set to 0, the unallocated primary resource instances and sub-resource instances are queried. |
| QueryDPUtilizationDetail | QueryDPUtilizationDetail | Queries the usage of resource plans, including reserved instances (RIs) and storage capacity units (SCUs). |
| QueryRIUtilizationDetail | QueryRIUtilizationDetail | Queries the usage details of a reserved instance (RI). |
| QueryRedeem | QueryRedeem | Queries the information about a voucher. |
| QueryResourcePackageInstances | QueryResourcePackageInstances | Queries the instances of a resource plan. You can query the resource plans that are valid. |
| QueryUserOmsData | QueryUserOmsData | Queries the metering records for a specified cloud product. |
| ReleaseInstance | ReleaseInstance | Releases instances by Virtual Network Operators (VNOs). |
| SetAllExpirationDay | SetAllExpirationDay | Sets an expiration date for all Elastic Compute Service (ECS) instances. |
| SetRenewal | SetRenewal | Enables auto-renewal for an instance. |
| SetResellerUserQuota | Modify the quota ledger and consumption ledger. | Modify the quota ledger and consumption ledger. |
| UpgradeResourcePackage | UpgradeResourcePackage | Upgrades a resource plan. |