API概览

更新时间:
本产品(阿里云 Billing/2017-12-14)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(78410016550),在专家指导下进行签名对接。
在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

资金流水

API标题API概述
QueryAccountBalance查询用户账户余额信息查询用户账户余额信息。
QueryAccountTransactionDetails查询账户交易明细查询用户收支明细。
QueryAccountTransactions账户流水收支明细查询接口查询用户账户流水信息。

财务关联

API标题API概述
QueryRelationList查询企业财务关系列表查询有主子关系权限的账号的成员账号关系列表。
QueryPermissionList查询权限详情根据关系ID查询有主子关系权限的关系的权限列表。
GetAccountRelation查询财务关联查询财务关联详情。
AddAccountRelation创建财务关联创建一个财务关联关系。
ModifyAccountRelation修改财务关联权限点支持添加、删除财务关联权限点。
ConfirmRelation确认财务关联子账号确认主账号发起的邀约。
RelieveAccountRelation解除账号关联解除主、子账号关联。

资源标签

API标题API概述
QueryInstanceByTag按标签查询实例根据标签信息查询实例列表。
TagResources为资源添加标签支持添加资源上配置的标签。
UntagResources取消资源的标签取消资源上配置的标签。

卡券

API标题API概述
QueryPrepaidCards账户卡包查询查询用户卡包信息。
QueryRedeem查询提货券服务查询用户提货券信息。
QueryCashCoupons查询用户代金券信息查询用户代金券信息。

节省计划

API标题API概述
CreateSavingsPlansInstance节省计划实例创建新购一个节省计划,并自动完成支付,创建节省计划实例。
QuerySavingsPlansInstance节省计划实例查询查询当前用户保有的节省计划实例信息。
QuerySavingsPlansDeductLog节省计划抵扣明细查询查询节省计划抵扣的明细数据
DescribeSavingsPlansUsageTotal节省计划使用率汇总节省计划使用率汇总查询
DescribeSavingsPlansUsageDetail节省计划使用率明细节省计划使用率明细查询
DescribeSavingsPlansCoverageTotal节省计划覆盖率汇总节省计划覆盖率汇总查询。
DescribeSavingsPlansCoverageDetail节省计划覆盖率明细节省计划覆盖率明细查询。
QuerySavingsPlansDiscount查询节省计划折扣明细查询节省计划折扣信息列表。

虚商配额

API标题API概述
CreateResellerUserQuota创建配额账本和消费账本创建用户 Quota 配额账本和 Quota 消费账本。
SetResellerUserQuota设置用户配额账本的Quota额度创建用户quota配额账本和quota消费账本
ChangeResellerConsumeAmount进行用户 Quota 消费抵扣
QueryResellerAvailableQuota查询当前可用配额余额信息查询用户(代付场景下设置消费配额)的当前可用配额余额信息。
SetResellerUserAlarmThreshold设置Quota额度低额预警规则
QueryResellerUserAlarmThreshold查询Quota额度低额预警规则
SetResellerUserStatus设置托管、冻结状态

虚商账号

API标题API概述
CreateAgAccount创建平行账号创建一个财务关联关系。
GetCustomerAccountInfo查找虚商客户账号信息查询虚商下终端客户账号信息。
GetCustomerList查询子账号列表查询虚商下的终端客户uid列表。

资源包

API标题API概述
QueryResourcePackageInstances查询资源包实例服务查询用户某个资源包的实例,限定支持查询失效时间一年以内的资源包。
QueryDPUtilizationDetail资源包用量查询查询资源包(包含RI、scu)的使用量情况。
QueryRIUtilizationDetail预留实例用量查询查询RI的使用量情况。
DescribeResourceUsageTotal资源使用率汇总预留实例、SCU使用率汇总查询。
DescribeResourceUsageDetail资源使用率明细预留实例、SCU使用率明细查询。
DescribeResourceCoverageTotal资源覆盖率汇总预留实例、SCU覆盖率汇总查询。
DescribeResourceCoverageDetail资源覆盖率明细预留实例、SCU覆盖率明细查询。
DescribeResourcePackageProduct描述资源包产品服务查询某个资源包产品的信息。
GetResourcePackagePrice资源包产品询价服务查询用户某个资源包的价格。
CreateResourcePackage创建资源包服务创建用户某个资源包的实例。
RenewResourcePackage资源包续费服务为用户某个资源包实例续费。
UpgradeResourcePackage升级资源包服务升级用户某个资源包的实例。如本周期已升级,则无法继续升级,待次周期生效后再操作升级。

财务账单

API标题API概述
SubscribeBillToOSS导出订阅详单导出阿里云OSS订阅账单详单数据。
UnsubscribeBillToOSS取消详单订阅服务取消详单导出订阅。
QueryBillToOSSSubscription详单订阅查询查询账单订阅到OSS储存桶的记录。
QueryBillOverview账单总览查询服务查询用户某个账期内账单总览信息。
QueryBill账单查询服务查询用户某个账期内结算账单。
QueryAccountBill账号账单查询服务查询用户某个账期内的消费,并以资源所有者的维度进行汇总。
QuerySettleBill结算账单查询服务查询用户某个账期内结算账单。支持账单条目超过50000条的国内账号。
QueryInstanceBill实例账单查询服务查询用户某个账期内所有商品实例或计费项的消费汇总。API已升级为DescribeInstanceBill,此API不再提供50000行以后数据的查询。
DescribeInstanceBill查询实例账单服务查询用户某个账期内所有商品实例或计费项的消费汇总。
QueryInstanceGaapCost查询月费用分摊服务该API不再更新。请前往使用如下API获取对应分摊成本: DescribeInstanceAmortizedCostByAmortizationPeriod - 查询实例摊销月摊销成本; DescribeProductAmortizedCostByAmortizationPeriod- 查询产品摊销月摊销成本; DescribeInstanceAmortizedCostByConsumePeriod- 查询实例账期月摊销成本; DescribeProductAmortizedCostByConsumePeriod- 查询产品账期月摊销成本。
DescribeInstanceAmortizedCostByAmortizationPeriod查询实例摊销月摊销成本以摊销月视角查询月实例摊销成本。
DescribeProductAmortizedCostByAmortizationPeriod查询产品摊销月摊销成本以摊销月视角查询月产品摊销成本。
DescribeInstanceAmortizedCostByConsumePeriod查询实例账期月摊销成本以账期月视角查询月实例摊销成本。
DescribeProductAmortizedCostByConsumePeriod查询产品账期月摊销成本以账期月视角查询月产品摊销成本。
DescribeSplitItemBill分账账单服务查询分账账单。
QuerySplitItemBill查询分账账单查询分账账单。分账账单API已升级,请使用新版API:DescribeSplitItemBill。

询价

API标题API概述
InquiryPriceRefundInstance退订实例询价InquiryPriceRefundInstance:调用本接口对需要退订的实例进行询价。
GetPayAsYouGoPrice后付费产品询价服务查询后付费产品价格。
GetSubscriptionPrice预付费产品询价服务查询预付费产品价格。

实例

API标题API概述
QueryAvailableInstances实例查询服务查询用户可用实例列表。
ReleaseInstance释放实例国家云虚商侧主动释放实例。
CreateInstance实例创建服务创建一个实例资源,会创建一个新购实例资源的订单,并自动支付。不支持ECS和RDS系列产品的创建。
ModifyInstance实例变更服务对实例资源配置进行变更。调用接口会创建一个变配实例资源的订单,并自动支付。该接口不支持ECS和RDS 系列产品的变更,请查找对应产品的专有API执行变配。
SetRenewal设置实例自动续费服务调用SetRenewal为一个实例设置自动续费服务。
ConvertChargeType切换实例付费模式为一个实例变更订阅类型。目前支持SLB、EIP和NAT网关后付费实例转预付费实例,和SLB、EIP产品预付费转后付费实例操作。
RenewInstance实例续费服务对相关实例进行续费。不支持ECS、RDS、REDIS产品类实例的续费,请查找对应产品的专用续费API执行续费。
RefundInstance退订实例RefundInstance:调用本接口退订不再需要的实例。

订单

API标题API概述
GetOrderDetail订单详情查询服务查询用户或分销客户某个订单详情信息。
QueryOrders订单列表查询服务查询用户或者分销客户订单列表情况。默认查询当前时间最近1小时范围内订单,如需查询更长时间范围的订单数据,请设CreateTimeStart和CreateTimeEnd参数。
CancelOrder取消未支付订单服务调用CancelOrder取消未支付订单服务。

财务单元

API标题API概述
CreateCostUnit创建财务单元创建财务单元,支持批量创建。
AllocateCostUnitResource资源分配到财务单元资源实例(实例型和分拆型)从源财务单元分配到目标财务单元。
DeleteCostUnit删除财务单元删除财务单元。
ModifyCostUnit修改财务单元修改财务单元,支持批量修改。
QueryCostUnit查询财务单元查询财务单元树当前节点下的所有财务单元节点。当 ParentUnitId 为 -1,表示查所有财务单元。
QueryCostUnitResource查询财务单元的资源查询用户的财务单元所属的资源实例列表。当 UnitId 为 0,表示查未分配的主子资源实例。
QueryFinancialAccountInfo查看企业财务账号信息查询有主子关系权限的账号的企业财务账号信息。

发票

API标题API概述
QueryEvaluateList待开票对象查询服务查询待开票对象信息。
QueryCustomerAddressList查询发票邮寄地址服务查询阿里云发票邮寄地址信息服务。
QueryInvoicingCustomerList发票抬头查询服务查询阿里云用户发票抬头信息。
ApplyInvoice发票申请服务提交开票申请服务。

产品

API标题API概述
QuerySkuPriceList查询商品定价对象下sku列表通常一个产品功能会有1到多个SKU,有的产品会多达数万级别的SKU。 本API是用来查询一个指定的产品功能下的SKU列表及其目录价。接口入参支持按照某种SKU配置的条件来进行过滤查询。
QueryCommodityList根据产品code查询商品信息列表该接口提供根据产品code获取商品信息列表的能力。
QueryPriceEntityList商品定价对象列表查询本API是用来查询一个商品下有哪些定价对象。 定价对象是用来计量和计算费用的最小产品能力。
DescribePricingModule查询产品模块信息查询阿里云某个产品对应模块信息。
QueryProductList查询产品信息查询阿里云产品信息。

其他

API标题API概述
QueryUserOmsData根据传入的云产品查询相应的计量记录根据传入的云产品查询相应的计量记录。
SetAllExpirationDay设置ECS统一到期日为ECS实例的续费设置统一到期日。
DescribeCostBudgetsSummary查询成本管理预算概要信息查询用户 “成本管理-预算”的概要信息。
RenewChangeInstance续费变配服务对一个实例续费的同时进行变配操作,实际变配时间,是续费订单生效的时间,并自动支付。不支持ECS和RDS系列产品的创建。