1. Interface Description
Interface request domain name: cvm.api3.convergecloud.com.
Inquire about Price for Creating CDH Instance (When HostChargeType is PREPAID, you must specify the HostChargePrepaid parameter.)
Version 3100 and later versions only support the postpaid mode, but do not support the prepaid mode. Passing prepaid parameters will result in an error.
Default interface request rate limit: 10 times per second.
Interface update time: 2022-05-21 06:19:38.
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: InquiryPriceAllocateHosts |
| Version | Yes | No | String | Public parameter, The value of this interface: 2017-03-12 |
| Region | No | No | String | Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface |
| ClientToken | No | No | String | String used to ensure request idempotency. Example: 4668722c-b6d6-4f79-96fd-097ebe5318e5 |
| Placement | Yes | No | Placement | Location of the instance. You can specify attributes such as the availability zone and project to which the instance belongs through this parameter. Example:View |
| HostChargePrepaid | No | No | ChargePrepaid | Prepaid mode, that is, monthly subscription-related parameter settings. You can specify attributes of a monthly subscription instance, such as purchase duration and whether to set auto-renewal, through this parameter. If the billing mode of the specified instance is prepaid mode, this parameter is required. Example:View |
| HostChargeType | Yes | No | String | Instance billing type. Currently, PREPAID (prepaid, that is, a monthly subscription mode) and POSTPAID_BY_HOUR (pay-per-hour postpaid) are supported. If this parameter is not passed, postpaid by default. Example: PREPAID |
| HostType | Yes | No | String | CDH instance model. If this parameter is not passed, the default model is HS20. Example: HS1 |
| HostCount | No | No | Uint64 | Number of purchased CDH instances. Example: 1 |
| DryRun | No | No | Bool | Whether to skip the actual execution logic. Example: false |
| PurchaseSource | No | No | String | Purchase source, API and MC (MC indicates front-end call). Example: MC |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| Price | HostPrice | Price Information of CDH Instance Creation 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 |
|---|---|
| InvalidRegion.NotFound | The specified zone was not found. |
| InvalidPeriod | Invalid duration. Currently, only the following durations are supported: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36], unit: months. |
| InvalidProjectId.NotFound | Invalid project ID. The specified project ID does not exist. |
| InvalidZone.MismatchRegion | The specified zone does not exist. |