1. Interface Description
Interface request domain name: bill.api3.convergecloud.com.
API for querying the information about the voucher
Default interface request rate limit: 20 times per second.
Interface update time: 2020-12-25 18:21: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: CouponInfo |
| 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. |
| MidasAppId | Yes | No | String | The Midas app ID. Example: 1341057229 |
| SpStatus | No | No | String | Specified query status. 1: to be used; 2: frozen; 3: voided; 9: used; 15: expired; 16: not yet valid. Example: 1 |
| ProductCode | No | No | String | The designated product. Example: p_cvm |
| SpId | No | No | String | The voucher number. Example: 1341057229_202411010011000000010909452710bat672366379274a_001 |
| SortField | No | No | String | SortField Example: EndTime |
| SortOrder | No | No | String | The sorting method. Valid values: asc and desc. asc: ascending order. desc: descending order. Example: desc |
| Limit | Yes | No | Int64 | The number of entries to be returned on each page. Default value: 10. Example: 20 |
| Offset | Yes | No | Int64 | The number of the page to return. Default value: 1. Example: 0 |
| EndTime | No | No | String | The point in time when the voucher expires. Example: 2018-10-24 10:00:00 |
| LargestEndTime | No | No | String | The point in time when the voucher will expire. Example: 2018-10-25 00:00:00 |
| ProductInfo | No | No | String | The product definition. Example: [{"name": "\u89c4\u683c\u7c7b\u578b", "value": "\u6807\u51c6\u7248"}, {"name": "\u4ea7\u54c1\u578b\u53f7", "value": "\u5165\u95e8\u578b"}, {"name": "\u5cf0\u503c\u5e26\u5bbd", "value": "1MB/s"}, {"name": "\u78c1\u76d8\u5bb9\u91cf", "value": "10GB"}, {"name": "\u7f51\u7edc", "value": "vpc-ofn1s40f"}, {"name": "\u5b50\u7f51", "value": "subnet-cgh97d9w"}, {"name": "\u96c6\u7fa4", "value": "yf1 cluster"}, {"name": "\u5b9e\u4f8b\u540d", "value": "drms-4df61cdc"}, {"name": "\u6d88\u606f\u4fdd\u7559\u65f6\u957f", "value": "1440\u5206"}] |
| MemberUin | No | No | String | Member account UIN Example: 1000102441223 |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| CouponsList | Array of CouponInfo | Information about the vouchers. Example:View |
| TotalNum | Int64 | Total number of records. Example: 10000 |
| TotalBalance | Int64 | Total number of records. Example: 10000 |
| 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
The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.
| Error Code | Description |
|---|---|
| InvalidParameter | Parameter error. |
| InvalidParameterValue | Parameter value error. |
| FailedOperation | Operation failed. |