cvm — Cloud Virtual Machine
cvm · 2017-03-12
InquiryPriceRunInstances
POST
Query the price of creating instances. You can only use this API for instances whose configuration is within the purchase limit. For more information, see RunInstances.
Wire call
Converge Cloud is RPC over HTTP. There is one path — / — and the action travels in the X-TC-Action header. The /cvm/InquiryPriceRunInstances path used in the OpenAPI document is a documentation convenience so each action is addressable; it is not a route on the server.
curl
curl -sS https://cvm.api3.convergecloud.com/ \
-H 'Authorization: TC3-HMAC-SHA256 Credential=<SecretId>/<YYYY-MM-DD>/cvm/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=<sig>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'Host: cvm.api3.convergecloud.com' \
-H 'X-TC-Action: InquiryPriceRunInstances' \
-H 'X-TC-Version: 2017-03-12' \
-H 'X-TC-Timestamp: <unix-seconds>' \
-H 'X-TC-Region: luzon' \
-d '{"Placement":"<Placement>","ImageId":"<ImageId>"}'Request parameters
| Field | Type | Required | Description |
|---|---|---|---|
| Placement | Placement | Yes | Location of the instance. You can use this parameter to specify the attributes of the instance, such as its availability zone and project. |
| ImageId | string | Yes | Image ID in the format of `img-xxx`. There are three types of images: Public images Custom images Shared images You can obtain the available image IDs in the following ways: For IDs of `public images`, `custom images`, and `shared images`, log in to the CVM console to query the information. Call DescribeImages and look for `ImageId` in the response. |
| InstanceChargeType | string | No | The instance billing method. POSTPAID_BY_HOUR: Pay-as-you-go on an hourly basis Default value: POSTPAID_BY_HOUR. |
| InstanceChargePrepaid | InstanceChargePrepaid | No | Details of the monthly subscription, including the purchase period, auto-renewal. It is required if the `InstanceChargeType` is `PREPAID`. |
| InstanceType | string | No | Instance model. Different instance models specify different resource specifications. |
| SystemDisk | SystemDisk | No | System disk configuration of the instance. If this parameter is not specified, the default value will be used. |
| DataDisks | DataDisk[] | No | Data disk configuration of the instance. If the parameter is not specified, no data disk will be purchased by default. If you want to purchase data disks, you can specify 21 data disks, including up to 1 `LOCAL_BASIC` data disk or `LOCAL_SSD` data disk and up to 20 `CLOUD_BASIC` data disks, `CLOUD_PREMIUM` data disks, or `CLOUD_SSD` data disks. |
| VirtualPrivateCloud | VirtualPrivateCloud | No | VPC configurations (VPC ID, subnet ID, etc). If It's not specified, the classic network will be used by default. If a VPC IP is specified in this parameter, the `InstanceCount` can only be 1. |
| InternetAccessible | InternetAccessible | No | Configuration of public network bandwidth. If it's not specified, 0 Mbps is used by default. |
| InstanceCount | integer | No | Number of instances to purchase. Value range: 1 (default) to 100. It cannot exceed the remaining CVM quota of the user. For more information on quota, see Restrictions on CVM Instance Purchase. |
| InstanceName | string | No | Instance display name. if no instance display name is specified, it will display 'unnamed' by default. when purchasing multiple instances, if the pattern string `{R:x}` is specified, it means generating numbers `[x, x+n-1]`, where `n` represents the number of purchased instances. for example, `server_{R:3}`: when purchasing 1 instance, the instance display name is `server_3`; when purchasing 2 … |
| LoginSettings | LoginSettings | No | Login settings of the instance. You can use this parameter to set the login method, password, and key of the instance, or keep the original login settings of the image. By default, a random password will be generated and sent to you via the Message Center. |
| SecurityGroupIds | string[] | No | Security group to which an instance belongs. obtain this parameter by calling the `SecurityGroupId` field in the return value of DescribeSecurityGroups. if not specified, bind the default security group under the designated project. if the default security group does not exist, automatically create it. |
| EnhancedService | EnhancedService | No | Enhanced services. You can use this parameter to specify whether to enable services such as Cloud Security and Cloud Monitor. If this parameter is not specified, Cloud Monitor and Cloud Security will be enabled by default. |
| ClientToken | string | No | A unique string supplied by the client to ensure that the request is idempotent. Its maximum length is 64 ASCII characters. If this parameter is not specified, the idempotency of the request cannot be guaranteed. For more information, see Ensuring Idempotency. |
| HostName | string | No | Hostname of Cloud Virtual Machine. Period (.) and hyphen (-) should not be used as the first or last character of the hostname, and should not be used consecutively. Windows instances: The hostname should contain 2 to 15 characters, including letters (case insensitive), digits, and hyphens (-), does not support periods (.), and should not be all digits. Instances of other types (such as Linux i… |
| TagSpecification | TagSpecification[] | No | The tag description list. This parameter is used to bind a tag to a resource instance. A tag can only be bound to CVM instances. |
| InstanceMarketOptions | InstanceMarketOptionsRequest | No | The market options of the instance. |
| Metadata | Metadata | No | Custom metadata, supports creating key-value pairs of custom metadata when creating a CVM. |
| HpcClusterId | string | No | HPC cluster ID. |
| CpuTopology | CpuTopology | No | Information about the CPU topology of an instance. If not specified, it is determined by system resources. |
| LaunchTemplate | LaunchTemplate | No | Instance launch template. |
Response
Fields are returned inside the Response envelope. Converge Cloud answers HTTP 200 for errors as well as successes, so read Response.Error rather than the status code — and test for the presence of that object, because Code is occasionally the empty string.
| Field | Type | Description |
|---|---|---|
| Price | Price | Price of the instance with the specified configurations. |
| RequestId | string | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
Success
{
"Response": {
"Price": …,
"RequestId": "…"
}
}Error
{
"Response": {
"Error": { "Code": "…", "Message": "…" },
"RequestId": "…"
}
}Try it
CredentialThe key never leaves this tab — it signs the request here. The signed request goes to /api-relay/cvm.
Request bodyvalid JSONPOST cvm.api3.convergecloud.com · InquiryPriceRunInstances
Read-only. Creates nothing.
Recorded example response — captured 2026-09-16
{
"Placement": {
"Zone": "ncr-1"
},
"ImageId": "img-mjx5nesp",
"InstanceType": "M8A.SMALL4",
"InstanceChargeType": "POSTPAID_BY_HOUR",
"InstanceCount": 1
}