All Products
Search
Document Center

BSS OpenAPI:List of operations by function

Last Updated:Dec 03, 2024
This product(BssOpenApi/2017-12-14) OpenAPI adopts RPC Signature style. See signature details in Description of the signature mechanism. We have packaged SDKs for common programming languages for developers. Developers can directly call the OpenAPI of this product by downloading the SDK without paying attention to the technical details. If the existing SDK cannot meet the usage requirements, you can connect through the signature mechanism. It will take about 5 working days. Therefore, it is recommended to join our DingTalk service group (78410016550) and sign under the guidance of experts.
Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (SDK, CLI, etc.). For details see getAccessKey.

Capital Flow

APITitleDescription
QueryAccountBalanceQueryAccountBalanceQueries the balance of your account.
QueryAccountTransactionDetailsQueryAccountTransactionDetailsQueries the details of transactions within your account.
QueryAccountTransactionsQueryAccountTransactionsQueries transactions within your Alibaba Cloud account.

Financial Association

APITitleDescription
QueryRelationListQueryRelationListQueries the members of a management account.
QueryPermissionListQueryPermissionListQueries, by relationship ID, permissions granted to accounts between which a management-member relationship is established.
GetAccountRelationGetAccountRelationQueries the details of a financial relationship.
AddAccountRelationAddAccountRelationCreates a financial relationship.
ModifyAccountRelationModifyAccountRelationAdds or removes permissions granted to a member in a financial relationship.
ConfirmRelationConfirmRelationConfirms the invitation initiated by the master account.
RelieveAccountRelationRelieveAccountRelationTerminates a financial relationship between the management account and a member.

Resource Tag

APITitleDescription
QueryInstanceByTagQueryInstanceByTagQueries instances by tag.
TagResourcesTagResourcesAdd tags to resources.
UntagResourcesUntagResourcesRemoves tags from resources.

Card Coupon

APITitleDescription
QueryPrepaidCardsQueryPrepaidCardsQueries prepaid cards.
QueryRedeemQueryRedeemQueries the information about a voucher.
QueryCashCouponsQueryCashCouponsQueries the information about vouchers.

Saving Plan

APITitleDescription
CreateSavingsPlansInstanceCreateSavingsPlansInstanceCreates a savings plan. After you call this operation, a savings plan is purchased and paid for.
QuerySavingsPlansInstanceQuerySavingsPlansInstanceQueries the information about the savings plans of the current user.
QuerySavingsPlansDeductLogQuerySavingsPlansDeductLogQueries the deduction details of savings plans.
DescribeSavingsPlansUsageTotalDescribeSavingsPlansUsageTotalQueries the usage summary of savings plans.
DescribeSavingsPlansUsageDetailDescribeSavingsPlansUsageDetailQueries the usage details of savings plans.
DescribeSavingsPlansCoverageTotalDescribeSavingsPlansCoverageTotalQueries the coverage summary of savings plans.
DescribeSavingsPlansCoverageDetailDescribeSavingsPlansCoverageDetailQueries the coverage details of savings plans.
QuerySavingsPlansDiscountQuerySavingsPlansDiscountQueries discounts on savings plans.

Virtual Quotient Quota

APITitleDescription
SetResellerUserQuotaModify the quota ledger and consumption ledger.Modify the quota ledger and consumption ledger.
ChangeResellerConsumeAmountChangeResellerConsumeAmount
SetResellerUserStatusSetResellerUserStatus

Virtual Merchant Account

APITitleDescription
CreateAgAccountCreateAgAccountCreates an account to establish a financial relationship.
GetCustomerAccountInfoGetCustomerAccountInfoQueries the account information about a customer of a virtual network operator (VNO).
GetCustomerListGetCustomerListQueries the IDs of customers of a virtual network operator (VNO).

Resource Package

APITitleDescription
QueryResourcePackageInstancesQueryResourcePackageInstancesQueries the instances of a resource plan. You can query the resource plans that are expired within one year.
QueryDPUtilizationDetailQueryDPUtilizationDetailQueries the usage of resource plans, including reserved instances (RIs) and storage capacity units (SCUs).
QueryRIUtilizationDetailQueryRIUtilizationDetailQueries the usage details of a reserved instance (RI).
DescribeResourceUsageTotalDescribeResourceUsageTotalQueries the total usage data of reserved instances or storage capacity units (SCUs).
DescribeResourceUsageDetailDescribeResourceUsageDetailQueries the usage details of reserved instances (RIs) or storage capacity units (SCUs).
DescribeResourceCoverageTotalDescribeResourceCoverageTotalQueries the total coverage data of reserved instances (RIs) or storage capacity units (SCUs).
DescribeResourceCoverageDetailDescribeResourceCoverageDetailQueries the coverage details of reserved instances (RIs) or storage capacity units (SCUs).
DescribeResourcePackageProductDescribeResourcePackageProductQueries the information about resource plans of an Alibaba Cloud service.
GetResourcePackagePriceGetResourcePackagePriceQueries the price of a resource plan.
CreateResourcePackageCreateResourcePackageCreates a resource plan.
RenewResourcePackageRenewResourcePackageRenews a resource plan.
UpgradeResourcePackageUpgradeResourcePackageUpgrades a resource plan.

Financial Bills

APITitleDescription
SubscribeBillToOSSSubscribeBillToOSSSubscribes to the bills that are stored in Object Storage Service (OSS) buckets.
UnsubscribeBillToOSSUnsubscribeBillToOSSUnsubscribes from the bills that are stored in Object Storage Service (OSS) buckets.
QueryBillToOSSSubscriptionQueryBillToOSSSubscriptionQueries the subscribed bills that are stored in Object Storage Service (OSS) bucket.
QueryBillOverviewQueryBillOverviewQueries the bill overview information in a billing cycle.
QueryBillQueryBillQueries the bills in a billing cycle.
QueryAccountBillQueryAccountBillQueries the bills of your Alibaba Cloud account within a billing cycle. You can summarize the bills by resource owner.
QueryInstanceBillQueryInstanceBillQueries the bills of instances or billable items in a billing cycle.
DescribeInstanceBillDescribeInstanceBillQueries the billing information about instances or billable items in a billing cycle.
DescribeSplitItemBillDescribeSplitItemBillQueries split bills.

Inquiry

APITitleDescription
InquiryPriceRefundInstanceInquiryPriceRefundInstanceQueries the refundable amount for an instance from which you want to unsubscribe.
GetPayAsYouGoPriceGetPayAsYouGoPriceQueries the pay-as-you-go price of an Alibaba Cloud service.
GetSubscriptionPriceGetSubscriptionPriceQueries the subscription price of an Alibaba Cloud service.

Instance

APITitleDescription
QueryAvailableInstancesQueryAvailableInstancesQueries available instances.
ReleaseInstanceReleaseInstanceReleases instances by Virtual Network Operators (VNOs).
CreateInstanceCreateInstanceCreates 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.
ModifyInstanceModifyInstanceModifies the configurations of an instance. When you call this operation, the system generates a modification order and automatically completes the payment. You cannot call this operation to modify the configurations of an Elastic Compute Service (ECS) instance or ApsaraDB RDS instance. To modify the configurations of an ECS or ApsaraDB RDS instance, call the dedicated operation of the corresponding service.
SetRenewalSetRenewalEnables auto-renewal for an instance.
ConvertChargeTypeConvertChargeTypeChanges the billing method of an instance. You can call this operation to switch the billing method from pay-as-you-go to subscription for Server Load Balancer (SLB) instances, elastic IP addresses (EIPs), and NAT gateways, and switch the billing method from subscription to pay-as-you-go for SLB instances and EIPs.
RenewInstanceRenewInstanceRenews a specified instance. You cannot call this operation to renew Elastic Compute Service (ECS) instances, ApsaraDB RDS instances, or ApsaraDB for Redis instances. To renew these types of instances, call the dedicated operation of the corresponding service.
RefundInstanceRefundInstanceUnsubscribes from an instance that is no longer needed.

Order

APITitleDescription
GetOrderDetailGetOrderDetailQueries the details of an order that belongs to your Alibaba Cloud account or distributors.
QueryOrdersQueryOrdersQueries the orders of your Alibaba Cloud account or distributors. By default, orders within the last hour are queried. To query earlier orders, specify the CreateTimeStart and CreateTimeEnd parameters.
CancelOrderCancelOrderCancels an unpaid order.

Financial Unit

APITitleDescription
CreateCostUnitCreateCostUnitCreates a cost center. You can create multiple cost centers at a time.
AllocateCostUnitResourceAllocateCostUnitResourceTransfers resource instances from the source cost center to the destination cost center.
DeleteCostUnitDeleteCostUnitDeletes a cost center.
ModifyCostUnitModifyCostUnitModifies one or more cost centers.
QueryCostUnitQueryCostUnitQueries 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.
QueryCostUnitResourceQueryCostUnitResourceQueries 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.
QueryFinancialAccountInfoQueryFinancialAccountInfoQueries the information about a financial account.

Invoice

APITitleDescription
QueryEvaluateListQueryEvaluateListQueries the information about the orders for which you want to apply for invoices.
QueryCustomerAddressListQueryCustomerAddressListQueries the addresses to which invoices are mailed.
QueryInvoicingCustomerListQueryInvoicingCustomerListQueries the information about invoice titles.
ApplyInvoiceApplyInvoiceSubmits an application for an invoice.

Product

APITitleDescription
QuerySkuPriceListQuerySkuPriceListQueries the stock keeping units (SKUs) of a service. In most cases, a service has one or more SKUs. A service may even have tens of thousands of SKUs. You can call this operation to query the SKUs of a specific service and the prices of the SKUs. You can configure request parameters to query the specified SKUs based on the configurations of the SKUs.
QueryCommodityListQueryCommodityListQueries the information about a service based on the service code.
QueryPriceEntityListQueryPriceEntityListQueries the billable items of a service.
DescribePricingModuleDescribePricingModuleQueries the pricing information about an Alibaba Cloud service.
QueryProductListQueryProductListQueries the information about all Alibaba Cloud services.

Other

APITitleDescription
QueryUserOmsDataQueryUserOmsDataQueries the usage data of an Alibaba Cloud service.
SetAllExpirationDaySetAllExpirationDaySets an expiration date for all Elastic Compute Service (ECS) instances.
DescribeCostBudgetsSummaryDescribeCostBudgetsSummaryQuery the summary information of the user "Cost Management-Budget".