调用SubscribeBillToOSS导出阿里云OSS订阅账单详单数据。

在调用该接口时,请注意:

  • 用户一次订阅一个类型的账单文件。
  • 订阅后次日开始每日推送上一日生成的账单文件,每月3号推送上月整账期的全量账单文件。月账单PDF每月4号推送上月账单文件。
  • 按天生成的账单文件可能存在时延,延迟生成的账单会在生成次日推送,也可能会包含上一日之前延迟到上一日生成的账单。建议每个月初拉取上个月全量文件。
  • 需要给订阅用户授予AliyunConsumeDump2OSSRole权限。
  • 本订阅与费用中心首页的“账单数据存储”为同一功能,订阅互通。
  • 文件名:
    • BillingItemDetailForBillingPeriod
      • 每日推送文件名格式:UID_BillingItemDetail_YYYYMMDD,例如:169**_BillingItemDetail_20190310
      • 下月初完整文件名格式:UID_BillingItemDetail_YYYYMM,例如:169**_BillingItemDetail_201903
    • InstanceDetailForBillingPeriod
      • 每日推送文件名格式:UID_InstanceDetail_YYYYMMDD,例如:169**_InstanceDetail_20190310
      • 下月初完整文件名格式:UID_InstanceDetail_YYYYMM,例如:169**_InstanceDetail_201903
    • InstanceDetailMonthly
      • 每日推送文件名格式:UID_InstanceDetailMonthly_YYYYMM,例如:169**_InstanceDetailMonthly_201903。每日更新此文件直至次月3号。
    • BillingItemDetailMonthly
      • 每日推送文件名格式:UID_BillingItemDetailMonthly_YYYYMM,例如:169**_BillingItemDetailMonthly_201903。每日更新此文件直至次月3号。
    • MonthBill
      • 每月推送文件名格式:UID_MonthBill_YYYYMM,例如:169**_MonthBill_201903。每月4号推送上月账单文件。
  • 除MonthBill为pdf文件外,其余文件类型为csv文件。但如果账单数据行数超过一定阈值,会自动拆分成多个csv文件,并合并压缩成一个zip文件,zip文件名格式相同。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String SubscribeBillToOSS

系统规定参数。取值:SubscribeBillToOSS。

SubscribeBucket String xxxxxx-bucket

指定详单导出的OSS Bucket。

SubscribeType String BillingItemDetailForBillingPeriod

订阅类型。取值类型:

  • BillingItemDetailForBillingPeriod:计费项消费明细。
  • InstanceDetailForBillingPeriod:实例消费明细。
  • BillingItemDetailMonthly:计费项消费账期汇总。
  • InstanceDetailMonthly:实例消费账期汇总。
  • MonthBill:月账单PDF。仅支持订阅MA。
MultAccountRelSubscribe String MA

对于多级账号,可指定推送账单的类型。可选值为:

  • MA:推送主账号及财务云非托管子账号账单。
  • ACP1:推送虚商子账号账单。
  • ACE1:推送财务托管子账号。

默认:MA。

BucketOwnerId Long 12341324

如果是Bid/ReSeller订阅则需要指定Oss Owner对应的UID,并对此账号授予AliyunConsumeDump2OSSRole权限。

普通用户则无需指定,默认为调用账号。

BeginBillingCycle String 2021-03

推送起始账期。订阅成功后,系统会自动推送起始账期到当前时间的数据。月账单PDF订阅时此参数无效,不会对历史数据重新推送。最多可推送最近1年内数据。

返回数据

名称 类型 示例值 描述
Code String Success

状态码。

Message String Successful!

错误信息。

RequestId String F61FCE4B-9B56-4FD9-A17E-******

请求参数。

Success Boolean true

是否成功。

示例

请求示例

http(s)://[Endpoint]/?Action=SubscribeBillToOSS
&SubscribeBucket=xxxxxx-bucket
&<公共请求参数>

正常返回示例

XML格式

<SubscribeBillToOSSResponse>
      <Message>Successful!</Message>
      <RequestId>F61FCE4B-9B56-4FD9-A17E-******</RequestId>
      <Success>true</Success>
      <Code>Success</Code>
</SubscribeBillToOSSResponse>

JSON格式

{
    "Message": "Successful!",
    "RequestId": "F61FCE4B-9B56-4FD9-A17E-******",
    "Success": true,
    "Code": "Success"
}

错误码

访问错误中心查看更多错误码。