1. Interface Description
Interface request domain name: bill.api3.convergecloud.com.
This API is used to obtain the resource bill data and summarize it by purchased instance ID.
Default interface request rate limit: 20 times per second.
Interface update time: 2025-03-31 15:58:04.
The interface is both signature verification and authentication.
2. Input Parameters
The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.
| Parameter name | Required | Allow NULL | Type | Description |
|---|---|---|---|---|
| Action | Yes | No | String | Public parameter, The value of this interface: DescribeBillSummaryByResourceGateway |
| Version | Yes | No | String | Public parameter, The value of this interface: 2018-10-25 |
| Region | No | No | String | Public parameter,Regional information This interface does not need to pass this parameter. |
| PayerUin | Yes | No | String | The UIN of the user who are querying bill data. Example: 100004603015 |
| BeginTime | Yes | No | String | The start time. The value must be the start time of the month and must be in the same month as the value of the EndTime parameter. Example: 2018-09-01 00:00:00. Example: 2018-10-24 10:00:00 |
| EndTime | Yes | No | String | The end time. The value must be the end time of the month and must be in the same month as the value of the BeginTime parameter. Example: 2018-09-30 23:59:59. Example: 2018-10-24 10:00:00 |
| Limit | Yes | No | Uint64 | The number of entries to be returned. Example: 20 |
| Offset | Yes | No | Uint64 | Offset. Example: 0 |
| NeedRecordNum | No | No | Uint64 | Specifies whether to return the total number of records. 0: No. 1: Yes. Example: 1 |
| NeedConditionValue | No | No | Uint64 | Specified whether to return the filter conditions. 0: Yes. 1: No. Example: 1 |
| Conditions | No | No | Conditions | Valid filter keys: BusinessCodes, ProductCodes, PayModes, ProjectIds, RegionIds, PayModes, ActionTypes, HideFreeCost, ResourceKeyword, and OrderByCost. Example:View |
| MemberUin | No | No | String | Member account UIN Example: 1000102441223 |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| Ready | Uint64 | Indicates whether data is ready. 0: not ready. 1: ready. Example: 1 |
| Data | Array of SummaryByResourceDataItem | The summary of resources. Example:View |
| Total | SummaryByResourceTotal | The expense summary of resources. Example:View |
| RecordNum | Uint64 | The number of records. If the value of the NeedRecordNum parameter is 0, the value of this parameter is null. Example: 1000 |
| ConditionValue | SummaryByResourceConditionValue | The filter condition. If the value of the NeedConditionValue parameter is 0, the value of this parameter is null. Example:View |
| PayAmountIncludedTax | String | Tax-included amount. Example: 10010 |
| RequestId | String | Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem. |
4. Error Code
There is no error code related to business logic for this interface, For other error codes, see public ErrorCode.