1. Interface Description
Interface request domain name: bill.api3.convergecloud.com.
This API is used to obtain the product definition list that contains the product codes, sub-product codes, billing items, billing sub-items, and units.
Default interface request rate limit: 20 times per second.
Interface update time: 2025-03-31 15:41: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: DescribeProductRelationsGateway |
| 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. |
| SearchProduct | No | No | String | The product code or name. Example: p_cvm |
| SearchSubProduct | No | No | String | The sub-product code or name. Example: sp_cvm_s1 |
| SearchBillingItem | No | No | String | The billable item code or name. Example: v_cvm_cpu |
| SearchSubBillingItem | No | No | String | The billable sub-item code or name. Example: sv_cvm_cpu |
| Status | No | No | Int64 | The status of the production definition. 1: effective. 0: ineffective. Example: 0 |
| Offset | No | No | Int64 | Page number. Example: 0 |
| Limit | No | No | Int64 | Page size. Example: 20 |
| MidasAppId | Yes | No | String | The Midas app ID. Example: 1341057229 |
| SearchProductCodes | No | No | Array of String | The codes of the products. Example: ["p_cvm"] |
| SearchSubProductCodes | No | No | Array of String | The codes of the sub-products. Example: ["sp_cvm"] |
| SearchBillingItemCodes | No | No | Array of String | The codes of the billable items. Example: ["v_cvm_cpu"] |
| SearchSubBillingItemCodes | No | No | Array of String | The codes of the billable sub-items. Example: ["sv_cvm_cpu_s3"] |
| SourceType | No | No | String | The type of the data source. local: the current system. third: a third-party data source. Default value: local. Example: local |
| ExceptHidden | No | No | Bool | Whether to filter hidden data. True indicates yes. Example: true |
| IfBilling | No | No | Int64 | Flag for filtering hidden measurement or billing data. 1: billing, 0: measurement. No parameter input indicates all are hidden. Example: 1 |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| TotalCount | Int64 | Total number. Example: 1000 |
| List | Array of ProductDefineList | API for querying product definitions. 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.