调用QueryInstanceBill查询用户某个账期内所有商品实例或计费项的消费汇总。API已升级为DescribeInstanceBill,此API不再提供50000行以后数据的查询。
API描述
在调用本接口时,请注意:
- 实例账单API已升级,请使用新版API:DescribeInstanceBill。此API不再提供50000行以后数据的查询。
- 实例账单是根据账单数据拆分生成,一般会有一天延迟。
- 实例信息在账期内会变化,月汇总的实例Config和Spec对应记录生成时间信息,如需详情可参考对应明细账单。
- 云通信产品可查询从2020年6月以后的数据; 万网产品可查询从2020年11月以后的数据。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | QueryInstanceBill |
系统规定参数。取值:QueryInstanceBill。 |
BillingCycle | String | 是 | 2020-03 |
账期YYYY-MM。 |
ProductCode | String | 否 | rds |
产品代码。 |
ProductType | String | 否 | rds |
产品类型。当ProductCode为云市场产品code时,此参数必填。 |
SubscriptionType | String | 否 | PayAsYouGo |
订阅类型。取值:
说明 必须和ProductCode参数一起使用。
|
IsBillingItem | Boolean | 否 | false |
是否按照计费项维度拉取数据。
默认 false。 |
PageNum | Integer | 否 | 1 |
页码,默认值为1。 |
PageSize | Integer | 否 | 20 |
每页数量,默认值:20,最大值:300。 |
IsHideZeroCharge | Boolean | 否 | false |
根据原价(PretaxGrossAmount)和应付(PretaxAmount)是否都为0做过滤。取值:
|
BillingDate | String | 否 | 2020-03-03 |
账单日期,仅当Granularity为DAILY时必填,格式为YYYY-MM-DD。 |
Granularity | String | 否 | MONTHLY |
查询账单的颗粒度。取值:
选择DAILY需指定BillingDate。 |
BillOwnerId | Long | 否 | 122 |
子账号ID。设置可查看财务云子账号账单,不填默认查看当前调用账号。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Code | String | Success |
状态码。 |
Message | String | Successful! |
错误信息。 |
RequestId | String | 79EE7556-0CFD-44EB-9CD6-B3B526E3A85F |
请求ID。 |
Success | Boolean | true |
是否成功。 |
Data | Object |
返回数据。 |
|
PageNum | Integer | 1 |
页码。 |
BillingCycle | String | 2020-03 |
账单日期,格式:YYYY-MM。 |
AccountID | String | 185xxxx3489 |
账号ID。 |
PageSize | Integer | 20 |
每页数量。 |
TotalCount | Integer | 2 |
总记录数。 |
AccountName | String | test@test.aliyunid.com |
用户账号。 |
Items | Array of Item |
账单详情。 |
|
Item | |||
BillingDate | String | 2020-03 |
账单日期,仅当Granularity为DAILY时有值,格式为YYYY-MM-DD。 |
InstanceConfig | String | CPU:12 |
实例详细配置。 |
InternetIP | String | 34.xx.x.x |
公网IP。 |
Item | String | PayAsYouGoBill |
账单类型:
|
Tag | String | tag |
标签。 |
InstanceID | String | i-kjhdskjgshfdlkjfdh |
实例ID。 |
Currency | String | CNY |
币种,取值:
|
DeductedByCashCoupons | Float | 0 |
代金券抵扣。 |
SubscriptionType | String | PayAsYouGo |
订阅类型,取值:
说明 必须和ProductCode参数一起使用。
|
InstanceSpec | String | ecs.sn1ne.3xlarge |
实例规格。 |
DeductedByCoupons | Float | 0 |
优惠券优惠金额。 |
BillingItem | String | 其他 |
计费项。仅当IsBillingItem=true有值。 |
Region | String | 杭州 |
地域。 |
OutstandingAmount | Float | 0 |
未结清金额 |
CostUnit | String | 未分配 |
财务单元。 |
ListPriceUnit | String | 元 |
单价单位, 仅当isBillingItem为true时有效。 |
ResourceGroup | String | 默认资源组 |
资源组。 |
PipCode | String | rds |
产品Code,与费用中心账单产品Code一致 |
ServicePeriodUnit | String | 秒 |
服务周期单位 |
PretaxAmount | Float | 0 |
应付金额。 |
CommodityCode | String | rds |
商品Code,与费用中心产品明细Code一致 |
ProductName | String | 云数据库RDS |
产品名称。 |
AdjustAmount | Float | 0 |
信用额度退款抵扣。 |
NickName | String | test |
实例昵称。 |
ProductDetail | String | 云数据库RDS |
产品明细。 |
Usage | String | 100 |
用量, 仅当isBillingItem为true时有效。 |
IntranetIP | String | 192.xx.xx.xx |
内网IP。 |
OwnerID | String | 169***013 |
子账号AccountID(多账号代付场景)。 |
DeductedByPrepaidCard | Float | 0 |
储值卡抵扣。 |
UsageUnit | String | GB |
用量单位, 仅当isBillingItem为true时有效。 |
PaymentAmount | Float | 0 |
现金支付。 |
InvoiceDiscount | Float | 0 |
优惠金额。 |
DeductedByResourcePackage | String | NULL |
资源包抵扣。 |
ProductType | String | rds |
产品类型。 |
ServicePeriod | String | 10 |
服务周期。 |
Zone | String | cn-hangzhou-h |
可用区。 |
ListPrice | String | 100 |
单价, 仅当isBillingItem为true时有效。 |
PretaxGrossAmount | Float | 0 |
原始金额。 |
CashAmount | Float | 0 |
现金支付(不包含信用额度退款抵扣)。 |
ProductCode | String | rds |
产品代码。 |
BillingType | String | 其它 |
计费方式。 |
示例
请求示例
http(s)://[Endpoint]/?Action=QueryInstanceBill
&BillingCycle=2018-07
&<公共请求参数>
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<QueryInstanceBillResponse>
<Message>Successful!</Message>
<RequestId>79EE7556-0CFD-44EB-9CD6-B3B526E3A85F</RequestId>
<Data>
<BillingCycle>2020-03</BillingCycle>
<TotalCount>2</TotalCount>
<AccountID>18xxxxx3489</AccountID>
<PageSize>20</PageSize>
<PageNum>1</PageNum>
<Items>
<Item>
<InstanceSpec>rds.mysql.s3.large</InstanceSpec>
<ProductName>云数据库RDS</ProductName>
<InstanceID>rm-bp1xxxxxxxe</InstanceID>
<DeductedByCashCoupons>0</DeductedByCashCoupons>
<ListPriceUnit/>
<BillingDate/>
<ListPrice/>
<PaymentAmount>0.01</PaymentAmount>
<DeductedByPrepaidCard>0</DeductedByPrepaidCard>
<InvoiceDiscount>11447.99</InvoiceDiscount>
<SubscriptionType>Subscription</SubscriptionType>
<Item>SubscriptionOrder</Item>
<PretaxGrossAmount>11448</PretaxGrossAmount>
<InstanceConfig>数据库类型:MySQL;实例规格:rds.mysql.s3.large;存储:5;内存:8192</InstanceConfig>
<Currency>CNY</Currency>
<CostUnit>未分配</CostUnit>
<ResourceGroup>默认资源组</ResourceGroup>
<BillingType>其它</BillingType>
<Usage/>
<DeductedByCoupons>0</DeductedByCoupons>
<ProductDetail>关系型数据库RDS(包月)</ProductDetail>
<ProductCode>rds</ProductCode>
<Zone>cn-hangzhou-b</Zone>
<ProductType>rds</ProductType>
<OutstandingAmount>0</OutstandingAmount>
<BillingItem/>
<NickName/>
<IntranetIP/>
<ServicePeriod>31583763</ServicePeriod>
<ServicePeriodUnit>秒</ServicePeriodUnit>
<DeductedByResourcePackage/>
<UsageUnit/>
<OwnerID>18576xxxxx489</OwnerID>
<PretaxAmount>0.01</PretaxAmount>
<InternetIP/>
<Region>华东1(杭州)</Region>
<Tag/>
</Item>
</Items>
<AccountName>test@test.aliyunid.com</AccountName>
</Data>
<Code>Success</Code>
<Success>true</Success>
</QueryInstanceBillResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"Message" : "Successful!",
"RequestId" : "79EE7556-0CFD-44EB-9CD6-B3B526E3A85F",
"Data" : {
"BillingCycle" : "2020-03",
"TotalCount" : 2,
"AccountID" : "18xxxxx3489",
"PageSize" : 20,
"PageNum" : 1,
"Items" : {
"Item" : [ {
"InstanceSpec" : "rds.mysql.s3.large",
"ProductName" : "云数据库RDS",
"InstanceID" : "rm-bp1xxxxxxxe",
"DeductedByCashCoupons" : 0,
"ListPriceUnit" : "",
"BillingDate" : "",
"ListPrice" : "",
"PaymentAmount" : 0.01,
"DeductedByPrepaidCard" : 0,
"InvoiceDiscount" : 11447.99,
"SubscriptionType" : "Subscription",
"Item" : "SubscriptionOrder",
"PretaxGrossAmount" : 11448,
"InstanceConfig" : "数据库类型:MySQL;实例规格:rds.mysql.s3.large;存储:5;内存:8192",
"Currency" : "CNY",
"CostUnit" : "未分配",
"ResourceGroup" : "默认资源组",
"BillingType" : "其它",
"Usage" : "",
"DeductedByCoupons" : 0,
"ProductDetail" : "关系型数据库RDS(包月)",
"ProductCode" : "rds",
"Zone" : "cn-hangzhou-b",
"ProductType" : "rds",
"OutstandingAmount" : 0,
"BillingItem" : "",
"NickName" : "",
"IntranetIP" : "",
"ServicePeriod" : "31583763",
"DeductedByResourcePackage" : "",
"UsageUnit" : "",
"OwnerID" : "18576xxxxx489",
"PretaxAmount" : 0.01,
"InternetIP" : "",
"Region" : "华东1(杭州)",
"Tag" : ""
} ]
},
"AccountName" : "test@test.aliyunid.com"
},
"Code" : "Success",
"Success" : true
}
错误码
访问错误中心查看更多错误码。