Last updated: 2018-04-02 17:51:04
Cloud Virtual Machine (CVM), which runs at the Tencent Data Center, provides auto scaling computing services and can be used to build and host software systems based on your business needs.
The CVM solution delivers a flexible set of computing, storage and network resources. You can conduct operations like creating/terminating/restarting CVM and changing bandwidth configuration via APIs described in this document. For more information, please see API Overview.
It's recommended to read CVM Overview before using these APIs.
- All CVM APIs under this module have been updated. All new features related to the CVM are added to the APIs under this module. For new users, it's recommended to use new APIs.
- The old APIs remain available. For more information, please see API Overview (old).
The key terms involved in the document are as follows:
|Instance||A cloud virtual machine.|
|Region||A region where resources reside. Each region contains multiple availability zones.|
|Availability Zone||Tencent Cloud physical data centers in the same region with independent power and network resources. They are designed to ensure that the failures within an availability zone can be isolated without spreading to and affecting other zones, so as to ensure customers' business stability.|
|Image||A copy of the software environment on a CVM instance, which generally includes operation system and installed software, and is used to create an instance.|
|Security Group||A type of virtual firewall with a state-based packet filtering feature. It's an important network security isolation method used to control the network access of CVM instances.|
|Elastic IP||A type of public IP. Unlike an ordinary public IP, an elastic IP belongs to a user account rather than an instance. The mapping relationship between an instance and a public IP address can be changed at any time.|
|Prepaid||A billing model. For more information, please see Billing Model Instruction.|
|Postpaid||A billing model. For more information, please see Billing Model Instruction.|
Definitions of Input and Response Parameters
Limit and Offset
These two parameters are used to control number of entries in one page. When results in the list exceeds the Limit value, only the Limit defined number of values is returned. You can use Limit and Offset to control entries per page. Limit indicates the maximum number of entries returned at a time, and Offset indicates the offset value.
For example, if you set
Offset=0&Limit=20, the 1st to 20th entries are returned; if you set Offset=20&Limit=20, the 20th to 40th entries are returned; if you set Offset=40&Limit=20, the 40th to 60th entries are returned, and so on.
Formats for entering multiple parameters at the same time. When you encounter a format like this, you can enter multiple input parameters at the same time. For example:
And so on (starting from 0).
API Quick Start
Let's start from APIs for postpaid CVMs:
- Create Postpaid Instances API: Create postpaid instances with the specified information like availability zone ID, image ID, model, and parameters.
- Change Configurations of Postpaid Instances API: Upgrade configurations of postpaid instances by changing CPU and memory through adjustment of instance model.
- Stop Instances API: Stop running of unnecessary CVMs.
- Return Postpaid Instances API: Return and terminate postpaid instances and stop charging.
- CVM API calling limit: Total 1,000 times per minute (100 times/min for a single API).
- CVMs created via API are subject to the number limit described in the Restrictions on CVM Instance Purchase, and share the quota with machines created on the Console.
- For more information about the restrictions, please see the document for each API or the relevant product document.