SubscribeBillToOSS - 设置OSS订阅账单文件
使用OSS订阅账单文件,支持将账单数据存储到指定的OSS bucket中。
接口说明
在调用该接口时,请注意:
- 
用户一次订阅一个类型的账单文件。
 - 
订阅后次日开始每日推送上一日生成的账单文件,每月 4 号推送上月整账期的全量账单文件。月账单 PDF 每月 4 号推送上月账单文件。
 - 
按天生成的账单文件可能存在时延,延迟生成的账单会在生成次日推送,也可能会包含上一日之前延迟到上一日生成的账单。建议每个月初拉取上个月全量文件。
 
首次使用 OSS 订阅,需要给订阅用户授予 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代码示例。
        
            调试
        
    
授权信息
| 
                                 操作  | 
                            
                                 访问级别  | 
                            
                                 资源类型  | 
                            
                                 条件关键字  | 
                            
                                 关联操作  | 
                        
| 
                                 bss:ModifySubscribeToOSS  | 
                            
                                 create  | 
                            
                                     *全部资源 
  | 
                            无 | 无 | 
请求参数
| 
                             名称  | 
                        
                             类型  | 
                        
                             必填  | 
                        
                             描述  | 
                        
                             示例值  | 
                    
| SubscribeBucket | 
                             string  | 
                        
                             是  | 
                        
                             存储订阅账单文件的 OSS Bucket 名称。  | 
                        
                             xxxxxx-bucket  | 
                    
| SubscribeType | 
                             string  | 
                        
                             否  | 
                        
                             订阅的账单类型。取值类型: 
  | 
                        
                             BillingItemDetailForBillingPeriod  | 
                    
| MultAccountRelSubscribe | 
                             string  | 
                        
                             否  | 
                        
                             对于多级账号,可指定推送账单的类型。可选值为: 
 默认:MA。  | 
                        
                             MA  | 
                    
| BucketOwnerId | 
                             integer  | 
                        
                             否  | 
                        
                             存储文件的 Oss Owner 对应的 UID。如果是 Bid/ReSeller 订阅,并需要推送到子账号的 OSS 上时指定,需要此账号为调用账号子账号,并对此账号授予 AliyunConsumeDump2OSSRole 权限。 普通用户则无需指定,默认为调用账号。  | 
                        
                             12341324  | 
                    
| BeginBillingCycle | 
                             string  | 
                        
                             否  | 
                        
                             推送起始账期。订阅成功后,系统会自动推送起始账期到当前时间的数据。月账单 PDF 订阅时此参数无效,不会对历史数据重新推送。最多可推送最近 1 年内数据。  | 
                        
                             2021-03  | 
                    
| BucketPath | 
                             string  | 
                        
                             否  | 
                        
                             订阅至 Bucket 下的指定目录。  | 
                        
                             testpath  | 
                    
| RowLimitPerFile | 
                             integer  | 
                        
                             否  | 
                        
                             单文件行数上限。当账单文件超过上限后,会拆成多个文件,并合并成一个压缩包。  | 
                        
                             300000  | 
                    
| UsingSsl | 
                             string  | 
                        
                             否  | 
                        
                             是否通过 SSL(Secure Sockets Layer)加密协议来保护网络通信。取值: 
  | 
                        
                             true  | 
                    
返回参数
| 
                             名称  | 
                        
                             类型  | 
                        
                             描述  | 
                        
                             示例值  | 
                    
| 
                             object  | 
                        |||
| Code | 
                             string  | 
                        
                             状态码。  | 
                        
                             Success  | 
                    
| Message | 
                             string  | 
                        
                             错误信息。  | 
                        
                             Successful!  | 
                    
| RequestId | 
                             string  | 
                        
                             请求 ID。  | 
                        
                             F61FCE4B-9B56-4FD9-A17E-******  | 
                    
| Success | 
                             boolean  | 
                        
                             是否成功。  | 
                        
                             true  | 
                    
示例
正常返回示例
JSON格式
{
  "Code": "Success",
  "Message": "Successful!",
  "RequestId": "F61FCE4B-9B56-4FD9-A17E-******",
  "Success": true
}
            错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。