API概览
更新时间：
本产品（BssOpenApi/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消费账本 |
| QueryResellerAvailableQuota | 查询当前可用配额余额信息 | 查询用户（代付场景下设置消费配额）的当前可用配额余额信息。 |
| SetResellerUserStatus | 设置托管、冻结状态 | 开启或关闭用户sql审计功能 |
虚商账号
|
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订阅账单文件 | 使用OSS订阅账单文件，支持将账单数据存储到指定的OSS bucket中。 |
| 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 | 退订实例 | 调用本接口退订不再需要的实例。 |
订单
|
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系列产品的创建。 |
该文章对您有帮助吗？