API概览

更新时间:
复制 MD 格式

API标准及多语言预置SDK

本产品(BssOpenApi/2023-09-30)的OpenAPI采用RPC签名风格。我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(147535001692),在专家指导下进行签名对接。

在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey。

自定义签名场景

若您的业务场景有特殊需求,需通过自签名方式对接 API,建议优先咨询我们的技术支持团队(服务钉钉群:147535001692),获取专业指导以确保高效接入。

账号与安全准备

阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露,所有相关资源都将面临未经授权访问的风险。为确保安全,建议创建一个仅具备 API 访问权限的RAM用户并配置其 AccessKey,同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下,才使用阿里云账号。

订单

API

标题

API概述

GetOrders 订单列表查询服务 查询用户或者分销客户订单列表情况。默认查询当前时间最近1小时范围内订单,如需查询更长时间范围的订单数据,请设CreateTimeStart和CreateTimeEnd参数。
GetOrderDetail 订单详情查询服务 查询用户或分销客户某个订单详情信息。

发票

API

标题

API概述

ListInvoiceTitle 发票抬头查询服务 查询可用的发票抬头列表
ListInvoiceCandidate 开票对象查询服务 查询开票对象数据,可根据该数据进行开票
CreateInvoice 发票申请 申请发票

资金账户

API

标题

API概述

CreateFundAccountPayRelation 创建资金账户的付款关系 创建资金账户的付款关系
SetFundAccountLowAvailableAmountAlarm 设置资金账户低额预警 设置资金账户低额预警
GetFundAccountCanWithdrawAmount 查询资金账户可提现金额 查询资金账户可提现金额
GetFundAccountAvailableAmount 查询资金账户可用金 查询资金账户可用金
GetFundAccountLowAvailableAmountAlarm 查询资金账户低额预警 查询资金账户低额预警
ListFundAccount 查询资金账户列表 查询资金账户列表
CancelFundAccountLowAvailableAmountAlarm 取消资金账户低额预警 取消资金账户低额预警
GetFundAccountCanAllocateCreditAmount 查询资金账户可分配信控额度 查询资金账户可分配信控额度
ListFundAccountPayRelation 查询账户的付款关系 查询账户的付款关系
GetFundAccountCanRecycleAmount 查询资金账户可回收金额 查询资金账户可回收金额
CreateFundAccountTransfer 创建账户划拨/回收 创建账户划拨/回收
GetFundAccountTransactionDetails 查询资金账户收支明细 查询资金账户收支明细
SetFundAccountCreditAmount 设置资金账户的信控限额 设置资金账户的信控限额
GetFundAccountCanTransferAmount 查询资金账户的可转出金额 查询资金账户的可转出金额

优惠券

API

标题

API概述

DescribeCoupon 查询优惠券列表 查询优惠券列表
DescribeCouponItemList 查询优惠券可用商品列表 查询优惠券可用商品列表

账单

API

标题

API概述

CreateReportDefinition 创建报告订阅 创建账单报告订阅。
ListReportDefinitions 查看订阅报告 查看已订阅的报告列表
DeleteReportDefinition 删除报告订阅 删除账单报告导出订阅。

财务单元

API

标题

API概述

SaveCostCenterShareRule 修改财务单元分摊规则 修改财务单元分摊规则,包括对分摊规则的创建、修改、删除
QueryCostCenterShareRule 查询财务单元分摊规则 查询财务单元分摊规则。
CreateCostCenter 创建财务单元 创建财务单元
ModifyCostCenter 修改财务单元 修改财务单元
DeleteCostCenter 删除财务单元 删除财务单元
QueryCostCenter 查询财务单元 查询财务单元
QueryCostCenterResource 查询财务单元的资源 查询用户的财务单元所属的资源实例列表。当 CostCenterId 为 0,表示查未分配的主子资源实例。
CreateCostCenterRule 创建财务单元自动分配规则 创建财务单元自动分配规则
ModifyCostCenterRule 修改财务单元自动分配规则 修改财务单元规则
DeleteCostCenterRule 删除财务单元自动分配规则 删除财务单元自动分配规则
QueryCostCenterRule 查询财务单元自动分配规则 查询财务单元规则
AllocateCostCenterResource 资源分配到财务单元 资源实例(实例型和分拆型)从源财务单元分配到目标财务单元。
QueryCostByCostCenter 查询财务单元费用概览结果 查询财务单元费用概览

其他

API

标题

API概述

DescribeDeductLogs 查询资源包抵扣记录 查询资源包抵扣记录
DescribeFrInstances 查询资源包实例 查询资源包实例
QueryMonthlySlaList SLA赔付查询 查询用户SLA赔付列表情况。
SubmitSlaCouponApply SLA赔付申领 用户申领近两月优惠券。