API standards and multilingual preset SDKs
The OpenAPI of this product (BssOpenApi/2017-12-14) uses the RPC signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.
Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.
Custom signature scenarios
If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.
Account and security preparation
Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.
Fund transactions
|
API |
Title |
Description |
| QueryAccountBalance | QueryAccountBalance | Queries the user's account balance. |
| QueryAccountTransactionDetails | Query account transaction details | Queries the income and expense details of a user. |
| QueryAccountTransactions | Query account transaction details | Queries the transaction details of a user account. |
Account linking
|
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. |
| GetAccountRelation | GetAccountRelation | Queries the details of a financial relationship. |
| AddAccountRelation | AddAccountRelation | Creates a financial relationship. |
| 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 tags
|
API |
Title |
Description |
| QueryInstanceByTag | QueryInstanceByTag | Queries a list of instances by tags. |
| TagResources | TagResources | Adds tags to resources. |
| UntagResources | UntagResources | Removes tags from resources. |
Coupons and vouchers
|
API |
Title |
Description |
| QueryPrepaidCards | QueryPrepaidCards | Queries information about a user's prepaid cards. |
| QueryRedeem | QueryRedeem | Queries the information about a voucher. |
| QueryCashCoupons | QueryCashCoupons | Queries the information about vouchers. |
Savings plans
|
API |
Title |
Description |
| QuerySavingsPlansInstance | QuerySavingsPlansInstance | Queries information about your savings plan instances. |
| QuerySavingsPlansDeductLog | QuerySavingsPlansDeductLog | Queries the details of savings plan deductions. |
| DescribeSavingsPlansUsageTotal | DescribeSavingsPlansUsageTotal | Queries the total usage of savings plans. |
| DescribeSavingsPlansUsageDetail | DescribeSavingsPlansUsageDetail | Queries the usage details of savings plans. |
| DescribeSavingsPlansCoverageTotal | DescribeSavingsPlansCoverageTotal | Queries the total coverage of savings plans. |
| DescribeSavingsPlansCoverageDetail | DescribeSavingsPlansCoverageDetail | Queries detailed information about savings plan coverage. |
| QuerySavingsPlansDiscount | QuerySavingsPlansDiscount | Queries the discount information for savings plans. |
Partner quotas
|
API |
Title |
Description |
| CreateResellerUserQuota | CreateResellerUserQuota | Creates a user quota ledger and a quota consumption ledger. |
| SetResellerUserQuota | Modify the quota ledger and consumption ledger. | Modify the quota ledger and 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. |
Partner accounts
|
API |
Title |
Description |
| CreateAgAccount | CreateAgAccount | Creates an account linking relationship. |
| GetCustomerAccountInfo | Query partner customer account information | Queries the account information of an end customer under a partner. |
| GetCustomerList | Query sub-account list | Queries the list of end customer UIDs under a partner. |
Resource plans
|
API |
Title |
Description |
| QueryResourcePackageInstances | QueryResourcePackageInstances | Queries the instances of a resource plan. You can query the resource plans that are valid. |
| 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). |
| DescribeResourceUsageTotal | DescribeResourceUsageTotal | Queries the total usage data of reserved instances or storage capacity units (SCUs). |
| DescribeResourceUsageDetail | DescribeResourceUsageDetail | Queries the usage 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). |
| DescribeResourceCoverageDetail | DescribeResourceCoverageDetail | Queries the coverage details of reserved instances (RIs) or storage capacity units (SCUs). |
| DescribeResourcePackageProduct | DescribeResourcePackageProduct | Queries the information about resource plans of an Alibaba Cloud service. |
| GetResourcePackagePrice | GetResourcePackagePrice | Queries the price of a resource plan. |
| RenewResourcePackage | RenewResourcePackage | Renews a resource package instance. |
| UpgradeResourcePackage | UpgradeResourcePackage | Upgrades a resource plan. |
Financial bills
|
API |
Title |
Description |
| SubscribeBillToOSS | Set up OSS bill file subscription | Subscribes to bill files by using Object Storage Service (OSS), which stores billing data in a specified OSS bucket. |
| UnsubscribeBillToOSS | Cancel detailed list subscription service | Cancels a detailed list export subscription. |
| QueryBillToOSSSubscription | Query bill subscription to OSS | Queries the records of bill subscriptions to OSS buckets. |
| QueryBillOverview | Query bill overview | Queries the bill overview of a user for a specific billing cycle. |
| QueryBill | Query settlement bills | Queries the settlement bills of a user within a specific billing cycle. |
| QueryAccountBill | QueryAccountBill | Queries account spending within a billing cycle and aggregates the data by resource owner. |
| QuerySettleBill | Query settlement bills | Queries the settlement bills of a user for a specific billing cycle. Supports domestic accounts with 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. |
Pricing inquiry
|
API |
Title |
Description |
| InquiryPriceRefundInstance | Query refund price for instance unsubscription | Queries the refund amount for an instance that you want to unsubscribe from. |
| GetPayAsYouGoPrice | Query pay-as-you-go product pricing | Queries the price of a pay-as-you-go product. |
| GetSubscriptionPrice | Query subscription product price | Queries the price of a subscription product. |
Instances
|
API |
Title |
Description |
| QueryAvailableInstances | QueryAvailableInstances | Queries available instances. |
| ReleaseInstance | ReleaseInstance | Releases instances by Virtual Network Operators (VNOs). |
| CreateInstance | Create an instance resource | Creates an instance resource. This operation creates an order for a new instance resource and completes automatic payment. ECS and RDS product series are not supported. |
| ModifyInstance | Modify instance configuration | Modifies the resource configuration of an instance. Invoking this operation creates an order for the Upgrade/Downgrade of instance resources and processes automatic payment. This operation does not support configuration changes for ECS or RDS products. Use the dedicated API of the corresponding product to execute the Upgrade/Downgrade. |
| SetRenewal | SetRenewal | Enables auto-renewal for an instance. |
| ConvertChargeType | Switch instance billing method | Changes the subscription type for an instance. Currently, this operation supports converting pay-as-you-go instances of SLB, EIP, and NAT Gateway to subscription instances, and converting subscription instances of SLB and EIP to pay-as-you-go instances. |
| RenewInstance | Renew an instance | Renews a specified instance. This operation does not support renewing ECS, RDS, or Redis instances. To renew these instances, call the dedicated renewal API of the corresponding service. |
| RefundInstance | Unsubscribe from an instance | Unsubscribes from an instance that is no longer needed. |
Orders
|
API |
Title |
Description |
| GetOrderDetail | Query order details | Queries the details of a specific order for a user or a reseller customer. |
| QueryOrders | Query order list | Queries the order list of a user or a reseller customer. By default, orders within the most recent 1 hour from the current time are queried. To query orders over a longer time range, set the CreateTimeStart and CreateTimeEnd parameters. |
| CancelOrder | CancelOrder | Cancels an unpaid order. |
Financial units
|
API |
Title |
Description |
| CreateCostUnit | Create financial units | Creates financial units. Batch creation is supported. |
| AllocateCostUnitResource | Allocate resources to a financial unit | Allocates resource instances (instance-based and attached-resource-based) from a source financial unit to a destination financial unit. |
| DeleteCostUnit | Delete a financial unit | Deletes a financial unit. |
| ModifyCostUnit | Modify financial units | Modifies financial units. Batch modification is supported. |
| QueryCostUnit | Query financial units | Queries all financial unit nodes under the current node of the financial unit tree. If ParentUnitId is set to -1, all financial units are queried. |
| QueryCostUnitResource | Query resources of a financial unit | Queries the list of resource instances that belong to a financial unit of a user. When UnitId is set to 0, the query returns unallocated primary and sub-resource instances. |
| QueryFinancialAccountInfo | View enterprise financial account information | Queries the enterprise financial account information of an account that has primary-subsidiary relationship permissions. |
Invoices
|
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. |
Products
|
API |
Title |
Description |
| QuerySkuPriceList | Query SKU list under a commodity pricing entity | Queries the list of SKUs and their list prices under a specified pricing entity of a commodity. A product feature typically has 1 to multiple SKUs, and some products can have tens of thousands of SKUs. The request parameters support filtered queries based on specific SKU configuration conditions. |
| QueryCommodityList | Query commodity information list by product code | Retrieves a list of commodity information based on a product code. |
| QueryPriceEntityList | Query commodity pricing entities | Queries the pricing entities under a commodity. A pricing entity is the smallest product capability used for metering and cost calculation. |
| DescribePricingModule | Query product module information | Queries the module information of a specified Alibaba Cloud product. |
| QueryProductList | Query product information | Queries the list of products available for the current account to order. The response includes the product code, product name, and subscription type (subscription or pay-as-you-go). |
Others
|
API |
Title |
Description |
| QueryUserOmsData | QueryUserOmsData | Queries the metering records for a specified cloud product. |
| SetAllExpirationDay | SetAllExpirationDay | Sets an expiration date for all Elastic Compute Service (ECS) instances. |
| 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. |