1. Interface Description
Interface request domain name: bill.api3.convergecloud.com.
API for querying download records.
Default interface request rate limit: 20 times per second.
Interface update time: 2020-09-04 20:25:35.
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: DescribeBillDownloadRecordListGateway |
| 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 |
| GroupMemberOrgId | No | No | String | Account ID Example: 1000102441223 |
| Limit | Yes | No | Uint64 | The number of entries to be returned. Example: 20 |
| Offset | Yes | No | Uint64 | Offset. Example: 1 |
| NeedRecordNum | No | No | Uint64 | Specifies whether to return the number of the records. 0: Yes. 1: No. Default value: 1. Example: 1 |
| Sort | No | No | GetDownloadListSort | Sort rules. Example:View |
| Conditions | No | No | Conditions | Valid filter keys: FIleIds, FileTypes, and Status. Example:View |
| NeedConditionValue | No | No | String | Specifies whether to return values of the conditions. 0: No. 1: Yes. Default value: 0. Example: 1 |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| RecordNum | String | The number of records. If the value of the NeedRecordNum parameter is 0, the value of this parameter is null. Example: 1000 |
| Records | Array of GetDownloadListRecordItem | The download records returned. Example:View |
| ConditionValue | GetDownloadListConditionValue | The filter condition. If the value of the NeedConditionValue parameter is 0, the value of this parameter is null. Example:View |
| 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.