All Documents
Current Document
Content is empty
If you don't find the content you expect, please try another search term
Content is empty
If you don't find the content you expect, please try another search term
Last updated：2022-05-24 11:30:55
DescribeSplitItemBillDetailsThis topic describes how to call the DescribeSplitItemBillDetails operation to query split item bills. You can query split item bills generated since November 2021.
| Parameter | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | The operation that you want to perform. Set the value to DescribeSplitItemBillDetails.DescribeSplitItemBillDetails |
| Version | Yes | String | The version of the API operation. Set the value to 2020-01-01. |
| CustomerBillMonth | Yes | Integer | The start time of the bill. Set the value in the yyyyMM format, such as 202111. |
| ProductGroupCode | Yes | String | The code of the product line. Set the value to KS3_GROUP. |
| StatisticType | Yes | Integer | The statistical period. Set the value to 3, which indicates bill details. |
| PayType | No | Integer | The billing type. Valid values: 0 (Prepaid), 1 (Pay-As-You-Go), and 2 (Postpaid). |
| SubAccountId | No | Long | The ID of the sub-account managed by your Kingsoft Cloud account. |
| Page | Yes | Integer | The page number. Default value: 1. |
| Size | Yes | String | The number of records on each page. Default value: 20. Maximum value: 200. |
| filterZero | No | String | true, filter the data whose realprice is 0; false or leave blank, do not filter the data whose realprice is 0. |
| Parameter | Type | Description |
|---|---|---|
| RequestId | String | The ID of the request. |
| InstanceId | String | The ID of the instance. |
| InstanceName | String | The name of the instance. |
| ProjectId | Long | The ID of the project. |
| ProjectName | String | The name of the project. |
| CustomerBillMonth | Integer | The billing cycle. |
| BillMonth | Integer | The billing month. |
| productGroupName | String | The name of the product line. |
| productTypeName | String | The type of the product. |
| userId | Long | The ID of the customer. |
| UserName | String | The name of the customer. |
| FinanceUnitName | String | The finance unit. |
| BillItemName | String | The billing item. |
| RegionName | String | The data center. |
| AvailabilityZone | String | The availability zone. |
| BillStartTime | String | The start time of billing. |
| BillEndTime | String | The end time of billing. |
| ServiceBeginTime | String | The start time of the service. |
| MeasureValue | String | The usage. The value is a numerical string. |
| MeasureValueUnit | String | The unit of usage. |
| SplitItemName | String | The name of the split item. |
| SplitRatio | String | The usage percentage of the split item. |
| Duration | String | The billing duration. |
| Price | String | The original price. |
| RealPrice | String | The final price. |
| Cash | String | The payment in cash. |
| Reward | String | The payment by rewards. |
| CloudTicketDenomination | String | The payment by cloud checks. |
| ResourceDeductValue | String | The payment by resource packages. |
| PriceFactorInfo | JSON array | The factors that may affect the price. |
| ExtraInfo | JSON array | The extra information. |
| TagInfo | JSON array | The tags. |
| billDetailTypeName | String | The bill type. |
| payTypeName | String | The billing type |
| billTypeName | String | The billing mode. |
| CurrencyCode | String | The currency. |
| RuleRemark | String | The description. |
| Error code | Error message) | HTTP status code | Description |
|---|---|---|---|
| InvalidParameter | There is one or more invalid parameter(%s)." | 400 | The error message returned because the %s parameter is invalid. %s indicates the parameter name. |
| Forbidden Request | user %s forbidden request this api" | 400 | The error message returned because the user is not allowed to call the API operation. %s indicates the UID of the user. |
| Server unavailable | Server error | 500 | The error message returned because the backend server is unavailable. |
####Sample request
https://bill-union.api.ksyun.com?Action=DescribeSplitItemBillDetails&Version=2020-01-01&ProductGroupCode=KS3_GROUP&StatisticType=3&PayType=2&Page=1&Size=2&CustomerBillMonth=202110
&Common request parameters
{
"Status": 200,
"RequestId": "5248af7b-f583-44f8-8ab8-cc3c735b6669",
"Data": {
"Page": 1,
"Size": 2,
"Total": 283396,
"bills": [
{
{
"Status": 200,
"RequestId": "5248af7b-f583-44f8-8ab8-cc3c735b6669",
"Data": {
"Page": 1,
"Size": 2,
"Total": 283396,
"bills": [
{
"InstanceId": "55629444_KS3-CDN",
"InstanceName": "",
"ProjectId": 101255,
"ProjectName": "Personal Edition",
"ProductGroupName": "KS3",
"ProductTypeName": "KS3",
"BillItemName": "Traffic",
"BillStartTime": "2021-10-01 00:00:00",
"BillEndTime": "2021-10-31 23:59:59",
"ServiceBeginTime": "",
"RegionName": "China",
"AvailabilityZone": "",
"PayTypeName": "Postpaid",
"BillTypeName": "Pay-By-Traffic (Monthly)",
"BillDetailTypeName": "Consumption",
"MeasureValue": "347.79",
"MeasureValueUnit": "G",
"SplitItemName": "fcheckreviewcache",
"SplitRatio": "2.90%",
"Price": "139.1159",
"RealPrice": "45.21",
"Cash": "0",
"Reward": "0",
"CloudTicketDenomination": "0",
"ResourceDeductValue": "0",
"Duration": "31 days",
"RuleRemark": "",
"FinanceUnitName": "First unit",
"PriceFactorInfo": [],
"ExtraInfo": [],
"TagInfo": [],
"UserId": 55629444,
"UserName": "Kingsoft",
"BillMonth": 202110,
"CustomerBillMonth": 202110,
"CurrencyCode": "RMB"
},
{
"InstanceId": "55629444_KS3-CDN",
"InstanceName": "",
"ProjectId": 101639,
"ProjectName": "Open platform",
"ProductGroupName": "KS3",
"ProductTypeName": "KS3",
"BillItemName": "Traffic",
"BillStartTime": "2021-10-01 00:00:00",
"BillEndTime": "2021-10-31 23:59:59",
"ServiceBeginTime": "",
"RegionName": "China",
"AvailabilityZone": "",
"PayTypeName": "Postpaid",
"BillTypeName": "Pay-By-Traffic (Monthly)",
"BillDetailTypeName": "Consumption",
"MeasureValue": "0",
"MeasureValueUnit": "G",
"SplitItemName": "test-esign-web-cdn",
"SplitRatio": "0.00%",
"Price": "0",
"RealPrice": "0",
"Cash": "0",
"Reward": "0",
"CloudTicketDenomination": "0",
"ResourceDeductValue": "0",
"Duration": "31 days",
"RuleRemark": "",
"FinanceUnitName": "First unit",
"PriceFactorInfo": [],
"ExtraInfo": [],
"TagInfo": [],
"UserId": 55629444,
"UserName": "Kingsoft",
"BillMonth": 202110,
"CustomerBillMonth": 202110,
"CurrencyCode": "RMB"
}
]
},
"Error": null
}
XML format
<OpenApiResponse>
<Status>200</Status>
<RequestId></RequestId>
<Data>
<Page>1</Page>
<Size>2</Size>
<Total>320343</Total>
<bills>
<bills>
<InstanceId>55629444_KS3-CDN</InstanceId>
<InstanceName></InstanceName>
<ProjectId>101196</ProjectId>
<ProjectName>Docer</ProjectName>
<ProductGroupName>KS3</ProductGroupName>
<ProductTypeName>KS3</ProductTypeName>
<BillItemName>TRANSFER</BillItemName>
<BillStartTime>2021-09-01 00:00:00</BillStartTime>
<BillEndTime>2021-09-30 23:59:59</BillEndTime>
<ServiceBeginTime></ServiceBeginTime>
<RegionName>KS3_CN</RegionName>
<AvailabilityZone></AvailabilityZone>
<PayTypeName>Postpaid</PayTypeName>
<BillTypeName>Pay-By-Traffic (Monthly)</BillTypeName>
<BillDetailTypeName>Consume</BillDetailTypeName>
<MeasureValue>0.0279</MeasureValue>
<MeasureValueUnit>G</MeasureValueUnit>
<SplitItemName>test-wpsfile</SplitItemName>
<SplitRatio>0.43%</SplitRatio>
<Price>0.01118</Price>
<RealPrice>0</RealPrice>
<Cash>0</Cash>
<Reward>0</Reward>
<CloudTicketDenomination>0</CloudTicketDenomination>
<ResourceDeductValue>0</ResourceDeductValue>
<Duration>30 day </Duration>
<RuleRemark></RuleRemark>
<FinanceUnitName>First unit</FinanceUnitName>
<PriceFactorInfo/>
<ExtraInfo/>
<TagInfo/>
<UserId>55629444</UserId>
<UserName>Kingsoft</UserName>
<BillMonth>202109</BillMonth>
<CustomerBillMonth>202109</CustomerBillMonth>
<CurrencyCode>RMB</CurrencyCode>
</bills>
<bills>
<InstanceId>55629444_KS3-CDN</InstanceId>
<InstanceName></InstanceName>
<ProjectId>101255</ProjectId>
<ProjectName>Personal Edition</ProjectName>
<ProductGroupName>KS3</ProductGroupName>
<ProductTypeName>KS3</ProductTypeName>
<BillItemName>TRANSFER</BillItemName>
<BillStartTime>2021-09-01 00:00:00</BillStartTime>
<BillEndTime>2021-09-30 23:59:59</BillEndTime>
<ServiceBeginTime></ServiceBeginTime>
<RegionName>KS3_CN</RegionName>
<AvailabilityZone></AvailabilityZone>
<PayTypeName>Postpaid</PayTypeName>
<BillTypeName>Pay-By-Traffic (Monthly)</BillTypeName>
<BillDetailTypeName>Consume</BillDetailTypeName>
<MeasureValue>0</MeasureValue>
<MeasureValueUnit>G</MeasureValueUnit>
<SplitItemName>wwo-cdn</SplitItemName>
<SplitRatio>0.00%</SplitRatio>
<Price>0</Price>
<RealPrice>0</RealPrice>
<Cash>0</Cash>
<Reward>0</Reward>
<CloudTicketDenomination>0</CloudTicketDenomination>
<ResourceDeductValue>0</ResourceDeductValue>
<Duration>30 days </Duration>
<RuleRemark></RuleRemark>
<FinanceUnitName>First unit</FinanceUnitName>
<PriceFactorInfo/>
<ExtraInfo/>
<TagInfo/>
<UserId>55629444</UserId>
<UserName>Kingsoft</UserName>
<BillMonth>202109</BillMonth>
<CustomerBillMonth>202109</CustomerBillMonth>
<CurrencyCode>RMB</CurrencyCode>
</bills>
</bills>
</Data>
<Error/>
</OpenApiResponse>Pure Mode