1. Interface Description
Interface request domain name: tpo.api3.convergecloud.com.
API for querying products in each level
Default interface request rate limit: 20 times per second.
Interface update time: 2022-11-18 17:30:37.
The interface only verifies the signature but does not authenticate.
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: DescribeProductTree |
| Version | Yes | No | String | Public parameter, The value of this interface: 2020-09-20 |
| Region | No | No | String | Public parameter,Regional information This interface does not need to pass this parameter. |
| ProductCode | No | No | String | Level-1 product. Example: p_cvm |
| SubProductCode | No | No | String | Level-2 product. Example: sp_cvm_vself2 |
| BillingItemCode | No | No | String | Level-3 product. Example: v_eip_hour |
| SubBillingItemCode | No | No | String | Level-4 product. Example: sv_eip_hour |
| AccessTypes | No | No | Array of String | Method to obtain resource IDs. Valid values: billing and local. billing: synchronizes resource IDs from resource billing. local: synchronizes resource IDs from vertical products. Example: ["local"] |
| Status | No | No | String | Quota Status. Example: 1 |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| ProductSet | Array of Product | List of level-1 products. Example:View |
| SubProductSet | Array of Product | List of level-2 products. Example:View |
| BillingItemSet | Array of Product | List of level-3 products. Example:View |
| SubBillingItemSet | Array of Product | List of level-4 products. 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
The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.
| Error Code | Description |
|---|---|
| InternalError.ThirdPartServiceBadRequest | Failed to call the service. |
| InternalError.ComponentFail | Failed to call an API of other components. |
| InternalError.InvalidHTTPCode | Invalid HTTP code. |