Tenant Cloud
Management and Audit
Metering Management
Billing
DescribeConsolidatedBillDownloadUrlGateway
1. Interface Description
Interface request domain name: bill.api3.convergecloud.com.
This API is used to generate a monthly bill. After the generation is completed, you can call DescribeBillDownloadListGateway to query the generation status and call DescribeDownloadWithAuthGateway to obtain the task by task ID.
Default interface request rate limit: 20 times per second.
Interface update time: 2025-03-31 16:18:49.
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: DescribeConsolidatedBillDownloadUrlGateway |
| 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 |
| ChildUins | No | No | Array of String | The UINs of sub-users. Example: ["130000000170"] |
| InnerOperator | No | No | String | The operator. Example: 130000000170 |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| TaskFinished | Bool | Whether task is completed. False: not completed; true: completed. Example: false |
| DownloadUrl | String | The file download URL. Example: http://example.com |
| FileName | String | The file name. Example: 100004603270-2024-11-06-Quotas-Lists-1730875608.zip_billing6a24e5f4-746d-d0d7-ff15-e2ba07ce11be |
| TaskId | String | The task ID. Example: 96553 |
| 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.