1. Interface Description
Interface request domain name: bill.api3.convergecloud.com.
API for querying the list of orders
Default interface request rate limit: 20 times per second.
Interface update time: 2020-09-04 16:56: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: DescribeDealListGateway |
| 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. |
| DealId | No | No | String | The child order ID. Example: 20240912110368 |
| BigDealId | No | No | String | The parent order ID. Example: 20240912110368 |
| StartTime | No | No | Datetime | Start time. Example: 2018-10-24 10:00:00 |
| EndTime | No | No | Datetime | End time. Example: 2018-10-24 10:00:00 |
| Payer | No | No | Uint64 | The UIN of the payer. Example: 100004603015 |
| ResourceId | No | No | String | Resource ID. Example: ins-08cxpupy |
| DealAction | No | No | String | Order type. tc_open: purchase; tc_change: configuration adjustment; tc_destroy: termination. Example: tc_destroy |
| Status | No | No | Uint64 | Status. 2: completed; 1: ongoing; 3: allocation failed. Example: 2 |
| Order | No | No | String | The sorting method. Valid values: asc and desc. asc: ascending order. desc: descending order. Example: desc |
| OrderField | No | No | String | Sort field. Example: createTime |
| Offset | Yes | No | Uint64 | Offset. Example: 0 |
| Limit | Yes | No | Uint64 | The maximum entries to be returned. Example: 20 |
| DealOrBigDealId | No | No | String | Parent orders or child orders. Example: 20240912110368 |
| PayMode | No | No | Int64 | The billing method. 0: postpaid. 1: prepaid. Example: 0 |
| ProductCodeName | No | No | String | Product name. Example: p_cvm |
| ActionName | No | No | String | The operation. Optional operations: freeze, release, refund, purchase, renew, downgrade, and upgrade. Example: Isolation |
| Creater | No | No | String | The UIN of the creator. Example: 100004603015 |
| SubProductCodeName | No | No | String | The name of the sub-product. Example: sp_cvm_s3 |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| TotalNum | Uint64 | Total number. Example: 10000 |
| List | Array of BigDealListData | Order list. Example:View |
| Timestamp | Uint64 | The current timestamp on the server. Example: 1730702488 |
| 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.