文档

SubscribeBillToOSS - 导出订阅详单

更新时间:
一键部署

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

接口说明

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

  • 用户一次订阅一个类型的账单文件。

  • 订阅后次日开始每日推送上一日生成的账单文件,每月4号推送上月整账期的全量账单文件。月账单PDF每月4号推送上月账单文件。

  • 按天生成的账单文件可能存在时延,延迟生成的账单会在生成次日推送,也可能会包含上一日之前延迟到上一日生成的账单。建议每个月初拉取上个月全量文件。

说明 需要给订阅用户授予AliyunConsumeDump2OSSRole权限。
  • 本订阅与费用中心首页的“账单数据存储”为同一功能,订阅互通。

  • 订阅至Bucket下的目录时,请注意符合目录命名规范:

    • 不允许使用表情符,请使用符合要求的 UTF-8 字符。
    • / 用于分割路径,可快速创建子目录,但不要以 / 或 \ 开头,不要出现连续的 /。
    • 不允许出现名为 .. 的子目录。
    • 总长度控制在 1~254 个字符。
  • 文件名:

    • 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。此文件每日更新月初至当日的全量数据,直至次月4号。
    • BillingItemDetailMonthly(计费项账单账期汇总)

      • 每日推送文件名格式:UID_BillingItemDetailMonthly_YYYYMM,例如:169**_BillingItemDetailMonthly_201903。此文件每日更新月初至当日的全量数据,直至次月4号。
    • SplitItemDetailDaily(分账账单按天汇总)

      • 每日推送文件名格式:UID_SplitItemDetailDaily_YYYYMM,例如:169**_SplitItemDetailDaily_201903。此文件每日更新月初至当日的全量数据,直至次月4号。
    • MonthBill(月账单PDF)

      • 每月推送文件名格式:UID_MonthBill_YYYYMM,例如:169**_MonthBill_201903。每月4号推送上月账单文件。
  • 除MonthBill为PDF文件外,其余文件类型为csv文件。但如果账单数据行数超过一定阈值,会自动拆分成多个csv文件,并合并压缩成一个zip文件,zip文件名格式相同。

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
bssapi:SubscribeBillToOSSWRITE
  • 全部资源
    *

请求参数

名称类型必填描述示例值
SubscribeBucketstring

指定详单导出的OSS Bucket。

xxxxxx-bucket
SubscribeTypestring

订阅类型。取值类型:

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

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

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

默认:MA。

MA
BucketOwnerIdlong

存储文件的Oss Owner对应的UID。如果是Bid/ReSeller订阅,并需要推送到子账号的OSS上时指定,需要此账号为调用账号子账号,并对此账号授予AliyunConsumeDump2OSSRole权限。 普通用户则无需指定,默认为调用账号。

12341324
BeginBillingCyclestring

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

2021-03
BucketPathstring

OSS Bucket存储路径。

testpath
RowLimitPerFileinteger

单文件行数上限。当账单文件超过上限后,会拆成多个文件,并合并成一个压缩包。

300000

返回参数

名称类型描述示例值
object
Codestring

状态码。

Success
Messagestring

错误信息。

Successful!
RequestIdstring

请求ID。

F61FCE4B-9B56-4FD9-A17E-******
Successboolean

是否成功。

true

示例

正常返回示例

JSON格式

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

错误码

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

  • 本页导读 (0)
文档反馈