API standards and multilingual preset SDKs
The OpenAPI of this product (BssOpenApi/2023-09-30) 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.
Order
|
API |
Title |
Description |
| GetOrders | Query order list | Queries the order list of a user or a reseller customer. By default, this operation queries orders created within the most recent hour. To query orders over a longer time range, set the CreateTimeStart and CreateTimeEnd parameters. |
| GetOrderDetail | Query Order Details | Queries the details of a specific order for a user or a reseller's customer. |
Invoice
|
API |
Title |
Description |
| ListInvoiceTitle | Invoice title query service | Query the list of available invoice titles |
| ListInvoiceCandidate | Invoice Candidate Query Service | Query invoice candidate data, which can be used for invoicing. |
| CreateInvoice | Invoice Application | Apply for Invoice |
Fund account
|
API |
Title |
Description |
| CreateFundAccountPayRelation | Create payment relationships for a fund account | Create payment relationships for a fund account |
| SetFundAccountLowAvailableAmountAlarm | Set Fund Account Low Balance Alert | Set Fund Account Low Balance Alert |
| GetFundAccountCanWithdrawAmount | Query Withdrawable Amount of Fund Account | Query Withdrawable Amount of Fund Account |
| GetFundAccountAvailableAmount | Query available balance of fund account | Query available balance of fund account |
| GetFundAccountLowAvailableAmountAlarm | Query Fund Account Low Balance Alert | Query Fund Account Low Balance Alert |
| ListFundAccount | Query fund account list | Query fund account list |
| CancelFundAccountLowAvailableAmountAlarm | Cancel low balance alert for a fund account | Cancels the low balance alert for a fund account. |
| GetFundAccountCanAllocateCreditAmount | Query allocatable credit limit of a fund account | Query allocatable credit limit of a fund account |
| ListFundAccountPayRelation | Query payment relationships of an account | Query payment relationships of an account |
| GetFundAccountCanRecycleAmount | Query reclaimable amount of a fund account | Queries the reclaimable amount of a fund account. |
| CreateFundAccountTransfer | Create account transfer or revocation | Creates an account transfer or revocation. |
| GetFundAccountTransactionDetails | Query fund account transaction details | Query fund account transaction details |
| SetFundAccountCreditAmount | Set the credit control limit for a fund account | Set the credit control limit for a fund account |
| GetFundAccountCanTransferAmount | Query the transferable amount of a fund account | Query the transferable amount of a fund account |
Coupon.
|
API |
Title |
Description |
| DescribeCoupon | Query coupon list | Query coupon list |
| DescribeCouponItemList | Query the list of products available for a coupon | Queries the list of products available for a coupon. |
Bill
|
API |
Title |
Description |
| CreateReportDefinition | Create Report Subscription | Creates a billing report subscription. |
| ListReportDefinitions | View subscription report | View the list of subscribed reports |
| DeleteReportDefinition | Delete a report subscription | Deletes a bill report export subscription. |
Financial unit
|
API |
Title |
Description |
| SaveCostCenterShareRule | ModifyCostCenterShareRules | Modifies cost center sharing rules, including creating, modifying, and deleting sharing rules. |
| QueryCostCenterShareRule | Query cost center sharing rules | Query cost center sharing rules |
| CreateCostCenter | Create cost center | Create cost center |
| ModifyCostCenter | Modify cost centers | Modify cost centers |
| DeleteCostCenter | Delete Cost Center | Delete Cost Center |
| QueryCostCenter | Query Cost Centers | Query Cost Centers |
| QueryCostCenterResource | Query resources of a cost center | Queries the list of resource instances that belong to a cost center of the user. When CostCenterId is 0, it queries unallocated primary and sub-resource instances. |
| CreateCostCenterRule | Create a financial unit auto-allocation rule | Create a financial unit auto-allocation rule |
| ModifyCostCenterRule | Modify financial unit auto-allocation rules | Modify financial unit rules |
| DeleteCostCenterRule | Delete financial unit automatic allocation rule | Delete financial unit automatic allocation rule |
| QueryCostCenterRule | Query cost center auto-allocation rules | Query cost center rules |
| AllocateCostCenterResource | Allocate resources to a cost center | Allocates resource instances (instance-based and attached-resource-based) from a source cost center to a destination cost center. |
| QueryCostByCostCenter | Query cost center expense overview results | Query cost center expense overview |
Other
|
API |
Title |
Description |
| CheckBudgetNameExists | Check whether a budget name exists | Checks whether a specified budgetName exists. |
| CreateBudget | Create a budget | Creates a budget. |
| DeleteBudget | DeleteBudget | Deletes a budget. |
| DescribeBudget | Query Single Budget Details | Query a Single Budget |
| DescribeBudgets | Query budget list | Query budget list |
| QueryCostByCostCenter | Query cost center expense overview results | Query cost center expense overview |
| QueryMonthlySlaList | Query SLA Compensation | Queries the SLA compensation list of a user. |