Tenant Cloud
Management and Audit
Metering Management
Billing
DescribeBillDownloadCommonSummaryGateway
1. Interface Description
Interface request domain name: bill.api3.convergecloud.com.
This API is used to download the bill summary in both the product dimension and the tag dimension.
Default interface request rate limit: 20 times per second.
Interface update time: 2025-03-31 15:56:20.
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: DescribeBillDownloadCommonSummaryGateway |
| 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 |
| TaxSwitch | No | No | Uint64 | Tax status. 0: disabled; 1: enabled. Example: 0 |
| TaskId | No | No | String | TaskId parameter returned in the last call of this API. Example: 0 |
| MemberUin | No | No | String | Member account UIN Example: 1000102441223 |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| Ready | Uint64 | Indicates where the task is completed. 0: uncompleted. 1: completed. Example: 1 |
| Name | String | The file name. If the task is completed, this parameter is returned. Example: 100004603270-2024-11-06-Quotas-Lists-1730875608.zip_billing6a24e5f4-746d-d0d7-ff15-e2ba07ce11be |
| DownloadUrl | String | The download URL. If the task is completed, this parameter is returned. Example: http://example.com |
| TaskId | String | Download task ID. 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.