CvmClient (tencentcloud-sdk-java-intl-en 3.0.823 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractClient
- - com.tencentcloudapi.cvm.v20170312.CvmClient

public class CvmClient
extends com.tencentcloudapi.common.AbstractClient

Field Summary
- Fields inherited from class com.tencentcloudapi.common.AbstractClient
  gson, HTTP_RSP_OK, SDK_VERSION

Constructor Summary

Constructors
Constructor and Description
`CvmClient(com.tencentcloudapi.common.Credential credential, String region)`
`CvmClient(com.tencentcloudapi.common.Credential credential, String region, com.tencentcloudapi.common.profile.ClientProfile profile)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AllocateHostsResponse`	`AllocateHosts(AllocateHostsRequest req)` This API is used to create CDH instances with specified configuration.
`AssociateInstancesKeyPairsResponse`	`AssociateInstancesKeyPairs(AssociateInstancesKeyPairsRequest req)` This API is used to associate key pairs with instances.
`AssociateSecurityGroupsResponse`	`AssociateSecurityGroups(AssociateSecurityGroupsRequest req)` This API is used to associate security groups with specified instances.
`ConfigureChcAssistVpcResponse`	`ConfigureChcAssistVpc(ConfigureChcAssistVpcRequest req)` This API is used to configure the out-of-band network and deployment network of a CHC host.
`ConfigureChcDeployVpcResponse`	`ConfigureChcDeployVpc(ConfigureChcDeployVpcRequest req)` This API is used to configure the deployment network of a CHC host.
`CreateDisasterRecoverGroupResponse`	`CreateDisasterRecoverGroup(CreateDisasterRecoverGroupRequest req)` This API is used to create a [spread placement group](https://intl.cloud.tencent.com/document/product/213/15486?from_cn_redirect=1).
`CreateImageResponse`	`CreateImage(CreateImageRequest req)` This API is used to create a new image with the system disk of an instance.
`CreateKeyPairResponse`	`CreateKeyPair(CreateKeyPairRequest req)` This API is used to create an `OpenSSH RSA` key pair, which you can use to log in to a `Linux` instance.
`CreateLaunchTemplateVersionResponse`	`CreateLaunchTemplateVersion(CreateLaunchTemplateVersionRequest req)` This API is used to create an instance launch template based on the specified template ID and the corresponding template version number.
`DeleteDisasterRecoverGroupsResponse`	`DeleteDisasterRecoverGroups(DeleteDisasterRecoverGroupsRequest req)` This API is used to delete a [spread placement group](https://intl.cloud.tencent.com/document/product/213/15486?from_cn_redirect=1).
`DeleteImagesResponse`	`DeleteImages(DeleteImagesRequest req)` This API is used to delete one or more images.
`DeleteKeyPairsResponse`	`DeleteKeyPairs(DeleteKeyPairsRequest req)` This API is used to delete the key pairs hosted in Tencent Cloud.
`DeleteLaunchTemplateResponse`	`DeleteLaunchTemplate(DeleteLaunchTemplateRequest req)` This API is used to delete an instance launch template.
`DeleteLaunchTemplateVersionsResponse`	`DeleteLaunchTemplateVersions(DeleteLaunchTemplateVersionsRequest req)` This API is used to delete one or more instance launch template versions.
`DescribeChcDeniedActionsResponse`	`DescribeChcDeniedActions(DescribeChcDeniedActionsRequest req)` This API is used to query the actions not allowed for the specified CHC instances.
`DescribeChcHostsResponse`	`DescribeChcHosts(DescribeChcHostsRequest req)` This API is used to query the details of one or more CHC host.
`DescribeDisasterRecoverGroupQuotaResponse`	`DescribeDisasterRecoverGroupQuota(DescribeDisasterRecoverGroupQuotaRequest req)` This API is used to query the quota of [spread placement groups](https://intl.cloud.tencent.com/document/product/213/15486?from_cn_redirect=1).
`DescribeDisasterRecoverGroupsResponse`	`DescribeDisasterRecoverGroups(DescribeDisasterRecoverGroupsRequest req)` This API is used to query the information on [spread placement groups](https://intl.cloud.tencent.com/document/product/213/15486?from_cn_redirect=1).
`DescribeHostsResponse`	`DescribeHosts(DescribeHostsRequest req)` This API is used to query the details of CDH instances.
`DescribeImageQuotaResponse`	`DescribeImageQuota(DescribeImageQuotaRequest req)` This API is used to query the image quota of an user account.
`DescribeImagesResponse`	`DescribeImages(DescribeImagesRequest req)` This API is used to view the list of images.
`DescribeImageSharePermissionResponse`	`DescribeImageSharePermission(DescribeImageSharePermissionRequest req)` This API is used to query image sharing information.
`DescribeImportImageOsResponse`	`DescribeImportImageOs(DescribeImportImageOsRequest req)` This API is used to query the list of supported operating systems of imported images.
`DescribeInstanceFamilyConfigsResponse`	`DescribeInstanceFamilyConfigs(DescribeInstanceFamilyConfigsRequest req)` This API is used to query a list of model families available to the current user in the current region.
`DescribeInstancesResponse`	`DescribeInstances(DescribeInstancesRequest req)` This API is used to query the details of instances.
`DescribeInstancesOperationLimitResponse`	`DescribeInstancesOperationLimit(DescribeInstancesOperationLimitRequest req)` This API is used to query limitations on operations on an instance.
`DescribeInstancesStatusResponse`	`DescribeInstancesStatus(DescribeInstancesStatusRequest req)` This API is used to query the status of instances.
`DescribeInternetChargeTypeConfigsResponse`	`DescribeInternetChargeTypeConfigs(DescribeInternetChargeTypeConfigsRequest req)` This API is used to query the network billing methods.
`DescribeKeyPairsResponse`	`DescribeKeyPairs(DescribeKeyPairsRequest req)` This API is used to query key pairs.
`DescribeLaunchTemplatesResponse`	`DescribeLaunchTemplates(DescribeLaunchTemplatesRequest req)` This API is used to query one or more instance launch templates.
`DescribeLaunchTemplateVersionsResponse`	`DescribeLaunchTemplateVersions(DescribeLaunchTemplateVersionsRequest req)` This API is used to query the information of instance launch template versions.
`DescribeRegionsResponse`	`DescribeRegions(DescribeRegionsRequest req)` This API is suspended.
`DescribeReservedInstancesConfigInfosResponse`	`DescribeReservedInstancesConfigInfos(DescribeReservedInstancesConfigInfosRequest req)` This API is used to describe reserved instance (RI) offerings.
`DescribeReservedInstancesOfferingsResponse`	`DescribeReservedInstancesOfferings(DescribeReservedInstancesOfferingsRequest req)` This API is used to describe Reserved Instance offerings that are available for purchase.
`DescribeZoneInstanceConfigInfosResponse`	`DescribeZoneInstanceConfigInfos(DescribeZoneInstanceConfigInfosRequest req)` This API is used to query the configurations of models in an availability zone.
`DescribeZonesResponse`	`DescribeZones(DescribeZonesRequest req)` This API is used to query availability zones.
`DisassociateInstancesKeyPairsResponse`	`DisassociateInstancesKeyPairs(DisassociateInstancesKeyPairsRequest req)` This API is used to unbind one or more key pairs from one or more instances.
`DisassociateSecurityGroupsResponse`	`DisassociateSecurityGroups(DisassociateSecurityGroupsRequest req)` This API is used to disassociate security groups from instances.
`ExportImagesResponse`	`ExportImages(ExportImagesRequest req)` This API is used to export custom images to the specified COS bucket.
`ImportImageResponse`	`ImportImage(ImportImageRequest req)` The API is used to import an image.
`ImportKeyPairResponse`	`ImportKeyPair(ImportKeyPairRequest req)` This API is used to import key pairs.
`InquirePricePurchaseReservedInstancesOfferingResponse`	`InquirePricePurchaseReservedInstancesOffering(InquirePricePurchaseReservedInstancesOfferingRequest req)` This API is used to query the price of reserved instances.
`InquiryPriceResetInstanceResponse`	`InquiryPriceResetInstance(InquiryPriceResetInstanceRequest req)` This API is used to query the price for reinstalling an instance.
`InquiryPriceResetInstancesInternetMaxBandwidthResponse`	`InquiryPriceResetInstancesInternetMaxBandwidth(InquiryPriceResetInstancesInternetMaxBandwidthRequest req)` This API is used to query the price for upgrading the public bandwidth cap of an instance.
`InquiryPriceResetInstancesTypeResponse`	`InquiryPriceResetInstancesType(InquiryPriceResetInstancesTypeRequest req)` This API is used to query the price for adjusting the instance model.
`InquiryPriceResizeInstanceDisksResponse`	`InquiryPriceResizeInstanceDisks(InquiryPriceResizeInstanceDisksRequest req)` This API is used to query the price for expanding data disks of an instance.
`InquiryPriceRunInstancesResponse`	`InquiryPriceRunInstances(InquiryPriceRunInstancesRequest req)` This API is used to query the price of creating instances.
`ModifyChcAttributeResponse`	`ModifyChcAttribute(ModifyChcAttributeRequest req)` This API is used to modify the CHC host attributes.
`ModifyDisasterRecoverGroupAttributeResponse`	`ModifyDisasterRecoverGroupAttribute(ModifyDisasterRecoverGroupAttributeRequest req)` This API is used to modify the attributes of [spread placement groups](https://intl.cloud.tencent.com/document/product/213/15486?from_cn_redirect=1).
`ModifyHostsAttributeResponse`	`ModifyHostsAttribute(ModifyHostsAttributeRequest req)` This API is used to modify the attributes of a CDH instance, such as instance name and renewal flag.
`ModifyImageAttributeResponse`	`ModifyImageAttribute(ModifyImageAttributeRequest req)` This API is used to modify image attributes.
`ModifyImageSharePermissionResponse`	`ModifyImageSharePermission(ModifyImageSharePermissionRequest req)` This API is used to modify image sharing information.
`ModifyInstancesAttributeResponse`	`ModifyInstancesAttribute(ModifyInstancesAttributeRequest req)` The API is used to modify the attributes of an instance.
`ModifyInstancesProjectResponse`	`ModifyInstancesProject(ModifyInstancesProjectRequest req)` This API is used to change the project to which an instance is assigned.
`ModifyInstancesVpcAttributeResponse`	`ModifyInstancesVpcAttribute(ModifyInstancesVpcAttributeRequest req)` This API is used to modify the VPC attributes of an instance, such as the VPC IP address.
`ModifyKeyPairAttributeResponse`	`ModifyKeyPairAttribute(ModifyKeyPairAttributeRequest req)` This API is used to modify the attributes of key pairs.
`ModifyLaunchTemplateDefaultVersionResponse`	`ModifyLaunchTemplateDefaultVersion(ModifyLaunchTemplateDefaultVersionRequest req)` This API is used to modify the default version of the instance launch template.
`PurchaseReservedInstancesOfferingResponse`	`PurchaseReservedInstancesOffering(PurchaseReservedInstancesOfferingRequest req)` This API is used to purchase one or more specific Reserved Instances.
`RebootInstancesResponse`	`RebootInstances(RebootInstancesRequest req)` This API is used to restart instances.
`RemoveChcAssistVpcResponse`	`RemoveChcAssistVpc(RemoveChcAssistVpcRequest req)` This API is used to remove the out-of-band network and deployment network of a CHC host.
`RemoveChcDeployVpcResponse`	`RemoveChcDeployVpc(RemoveChcDeployVpcRequest req)` This API is used to remove the deployment network of a CHC host.
`ResetInstanceResponse`	`ResetInstance(ResetInstanceRequest req)` This API is used to reinstall the operating system of the specified instance.
`ResetInstancesInternetMaxBandwidthResponse`	`ResetInstancesInternetMaxBandwidth(ResetInstancesInternetMaxBandwidthRequest req)` This API is used to change the public bandwidth cap of an instance.
`ResetInstancesPasswordResponse`	`ResetInstancesPassword(ResetInstancesPasswordRequest req)` This API is used to reset the password of the operating system instances to a user-specified password.
`ResetInstancesTypeResponse`	`ResetInstancesType(ResetInstancesTypeRequest req)` This API is used to change the model of an instance.
`ResizeInstanceDisksResponse`	`ResizeInstanceDisks(ResizeInstanceDisksRequest req)` This API (ResizeInstanceDisks) is used to expand the data disks of an instance.
`RunInstancesResponse`	`RunInstances(RunInstancesRequest req)` This API is used to create one or more instances with a specified configuration.
`StartInstancesResponse`	`StartInstances(StartInstancesRequest req)` This API is used to start instances.
`StopInstancesResponse`	`StopInstances(StopInstancesRequest req)` This API is used to shut down instances.
`SyncImagesResponse`	`SyncImages(SyncImagesRequest req)` This API is used to sync a custom image to other regions.
`TerminateInstancesResponse`	`TerminateInstances(TerminateInstancesRequest req)` This API is used to return instances.

Methods inherited from class com.tencentcloudapi.common.AbstractClient
call, callOctetStream, getClientProfile, getCredential, getRegion, getRegionBreaker, internalRequest, internalRequest, internalRequestRaw, processResponseJson, processResponseSSE, retry, setClientProfile, setCredential, setRegion, setRegionBreaker

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CvmClient
```
public CvmClient(com.tencentcloudapi.common.Credential credential,
                 String region)
```
  - CvmClient
```
public CvmClient(com.tencentcloudapi.common.Credential credential,
                 String region,
                 com.tencentcloudapi.common.profile.ClientProfile profile)
```
- Method Detail
  - AllocateHosts
```
public AllocateHostsResponse AllocateHosts(AllocateHostsRequest req)
                                    throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to create CDH instances with specified configuration. When HostChargeType is PREPAID, the HostChargePrepaid parameter must be specified.
    
    Parameters:
    
    req - AllocateHostsRequest
    
    Returns:
    
    AllocateHostsResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - AssociateInstancesKeyPairs
```
public AssociateInstancesKeyPairsResponse AssociateInstancesKeyPairs(AssociateInstancesKeyPairsRequest req)
                                                              throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to associate key pairs with instances. If the public key of a key pair is written to the `SSH` configuration of the instance, users will be able to log in to the instance with the private key of the key pair. If the instance is already associated with a key, the old key will become invalid. If you currently use a password to log in, you will no longer be able to do so after you associate the instance with a key. Batch operations are supported. The maximum number of instances in each request is 100. If any instance in the request cannot be associated with a key, you will get an error code.
    
    Parameters:
    
    req - AssociateInstancesKeyPairsRequest
    
    Returns:
    
    AssociateInstancesKeyPairsResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - AssociateSecurityGroups
```
public AssociateSecurityGroupsResponse AssociateSecurityGroups(AssociateSecurityGroupsRequest req)
                                                        throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to associate security groups with specified instances.
    
    Parameters:
    
    req - AssociateSecurityGroupsRequest
    
    Returns:
    
    AssociateSecurityGroupsResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - ConfigureChcAssistVpc
```
public ConfigureChcAssistVpcResponse ConfigureChcAssistVpc(ConfigureChcAssistVpcRequest req)
                                                    throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to configure the out-of-band network and deployment network of a CHC host.
    
    Parameters:
    
    req - ConfigureChcAssistVpcRequest
    
    Returns:
    
    ConfigureChcAssistVpcResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - ConfigureChcDeployVpc
```
public ConfigureChcDeployVpcResponse ConfigureChcDeployVpc(ConfigureChcDeployVpcRequest req)
                                                    throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to configure the deployment network of a CHC host.
    
    Parameters:
    
    req - ConfigureChcDeployVpcRequest
    
    Returns:
    
    ConfigureChcDeployVpcResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - CreateDisasterRecoverGroup
```
public CreateDisasterRecoverGroupResponse CreateDisasterRecoverGroup(CreateDisasterRecoverGroupRequest req)
                                                              throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to create a [spread placement group](https://intl.cloud.tencent.com/document/product/213/15486?from_cn_redirect=1). After you create one, you can specify it for an instance when you [create the instance](https://intl.cloud.tencent.com/document/api/213/15730?from_cn_redirect=1),
    
    Parameters:
    
    req - CreateDisasterRecoverGroupRequest
    
    Returns:
    
    CreateDisasterRecoverGroupResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - CreateImage
```
public CreateImageResponse CreateImage(CreateImageRequest req)
                                throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to create a new image with the system disk of an instance. The image can be used to create new instances.
    
    Parameters:
    
    req - CreateImageRequest
    
    Returns:
    
    CreateImageResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - CreateKeyPair
```
public CreateKeyPairResponse CreateKeyPair(CreateKeyPairRequest req)
                                    throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to create an `OpenSSH RSA` key pair, which you can use to log in to a `Linux` instance. You only need to specify a name, and the system will automatically create a key pair and return its `ID` and the public and private keys. The name of the key pair must be unique. You can save the private key to a file and use it as an authentication method for `SSH`. Tencent Cloud does not save users' private keys. Be sure to save it yourself.
    
    Parameters:
    
    req - CreateKeyPairRequest
    
    Returns:
    
    CreateKeyPairResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - CreateLaunchTemplateVersion
```
public CreateLaunchTemplateVersionResponse CreateLaunchTemplateVersion(CreateLaunchTemplateVersionRequest req)
                                                                throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to create an instance launch template based on the specified template ID and the corresponding template version number. The default version number will be used when no template version numbers are specified. Each instance launch template can have up to 30 version numbers.
    
    Parameters:
    
    req - CreateLaunchTemplateVersionRequest
    
    Returns:
    
    CreateLaunchTemplateVersionResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - DeleteDisasterRecoverGroups
```
public DeleteDisasterRecoverGroupsResponse DeleteDisasterRecoverGroups(DeleteDisasterRecoverGroupsRequest req)
                                                                throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to delete a [spread placement group](https://intl.cloud.tencent.com/document/product/213/15486?from_cn_redirect=1). Only empty placement groups can be deleted. To delete a non-empty group, you need to terminate all the CVM instances in it first. Otherwise, the deletion will fail.
    
    Parameters:
    
    req - DeleteDisasterRecoverGroupsRequest
    
    Returns:
    
    DeleteDisasterRecoverGroupsResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - DeleteImages
```
public DeleteImagesResponse DeleteImages(DeleteImagesRequest req)
                                  throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to delete one or more images. If the [ImageState](https://intl.cloud.tencent.com/document/product/213/15753?from_cn_redirect=1#Image) of an image is `CREATING` or `USING`, the image cannot be deleted. Call the [DescribeImages](https://intl.cloud.tencent.com/document/api/213/15715?from_cn_redirect=1) API to query the image status. Up to 10 custom images are allowed in each region. If you have run out of the quota, delete unused images to create new ones. A shared image cannot be deleted.
    
    Parameters:
    
    req - DeleteImagesRequest
    
    Returns:
    
    DeleteImagesResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - DeleteKeyPairs
```
public DeleteKeyPairsResponse DeleteKeyPairs(DeleteKeyPairsRequest req)
                                      throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to delete the key pairs hosted in Tencent Cloud. You can delete multiple key pairs at the same time. A key pair used by an instance or image cannot be deleted. Therefore, you need to verify whether all the key pairs have been deleted successfully.
    
    Parameters:
    
    req - DeleteKeyPairsRequest
    
    Returns:
    
    DeleteKeyPairsResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - DeleteLaunchTemplate
```
public DeleteLaunchTemplateResponse DeleteLaunchTemplate(DeleteLaunchTemplateRequest req)
                                                  throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to delete an instance launch template.
    
    Parameters:
    
    req - DeleteLaunchTemplateRequest
    
    Returns:
    
    DeleteLaunchTemplateResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - DeleteLaunchTemplateVersions
```
public DeleteLaunchTemplateVersionsResponse DeleteLaunchTemplateVersions(DeleteLaunchTemplateVersionsRequest req)
                                                                  throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to delete one or more instance launch template versions.
    
    Parameters:
    
    req - DeleteLaunchTemplateVersionsRequest
    
    Returns:
    
    DeleteLaunchTemplateVersionsResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - DescribeChcDeniedActions
```
public DescribeChcDeniedActionsResponse DescribeChcDeniedActions(DescribeChcDeniedActionsRequest req)
                                                          throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to query the actions not allowed for the specified CHC instances.
    
    Parameters:
    
    req - DescribeChcDeniedActionsRequest
    
    Returns:
    
    DescribeChcDeniedActionsResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - DescribeChcHosts
```
public DescribeChcHostsResponse DescribeChcHosts(DescribeChcHostsRequest req)
                                          throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to query the details of one or more CHC host. You can filter the query results with the instance ID, name or device type. See `Filter` for more information. If no parameter is defined, a certain number of instances under the current account will be returned. The number is specified by `Limit` and is `20` by default.
    
    Parameters:
    
    req - DescribeChcHostsRequest
    
    Returns:
    
    DescribeChcHostsResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - DescribeDisasterRecoverGroupQuota
```
public DescribeDisasterRecoverGroupQuotaResponse DescribeDisasterRecoverGroupQuota(DescribeDisasterRecoverGroupQuotaRequest req)
                                                                            throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to query the quota of [spread placement groups](https://intl.cloud.tencent.com/document/product/213/15486?from_cn_redirect=1).
    
    Parameters:
    
    req - DescribeDisasterRecoverGroupQuotaRequest
    
    Returns:
    
    DescribeDisasterRecoverGroupQuotaResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - DescribeDisasterRecoverGroups
```
public DescribeDisasterRecoverGroupsResponse DescribeDisasterRecoverGroups(DescribeDisasterRecoverGroupsRequest req)
                                                                    throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to query the information on [spread placement groups](https://intl.cloud.tencent.com/document/product/213/15486?from_cn_redirect=1).
    
    Parameters:
    
    req - DescribeDisasterRecoverGroupsRequest
    
    Returns:
    
    DescribeDisasterRecoverGroupsResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - DescribeHosts
```
public DescribeHostsResponse DescribeHosts(DescribeHostsRequest req)
                                    throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to query the details of CDH instances.
    
    Parameters:
    
    req - DescribeHostsRequest
    
    Returns:
    
    DescribeHostsResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - DescribeImageQuota
```
public DescribeImageQuotaResponse DescribeImageQuota(DescribeImageQuotaRequest req)
                                              throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to query the image quota of an user account.
    
    Parameters:
    
    req - DescribeImageQuotaRequest
    
    Returns:
    
    DescribeImageQuotaResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - DescribeImageSharePermission
```
public DescribeImageSharePermissionResponse DescribeImageSharePermission(DescribeImageSharePermissionRequest req)
                                                                  throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to query image sharing information.
    
    Parameters:
    
    req - DescribeImageSharePermissionRequest
    
    Returns:
    
    DescribeImageSharePermissionResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - DescribeImages
```
public DescribeImagesResponse DescribeImages(DescribeImagesRequest req)
                                      throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to view the list of images. You specify the image ID or set filters to query the details of certain images. You can specify `Offset` and `Limit` to select a certain part of the results. By default, the information on the first 20 matching results is returned.
    
    Parameters:
    
    req - DescribeImagesRequest
    
    Returns:
    
    DescribeImagesResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - DescribeImportImageOs
```
public DescribeImportImageOsResponse DescribeImportImageOs(DescribeImportImageOsRequest req)
                                                    throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to query the list of supported operating systems of imported images.
    
    Parameters:
    
    req - DescribeImportImageOsRequest
    
    Returns:
    
    DescribeImportImageOsResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - DescribeInstanceFamilyConfigs
```
public DescribeInstanceFamilyConfigsResponse DescribeInstanceFamilyConfigs(DescribeInstanceFamilyConfigsRequest req)
                                                                    throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to query a list of model families available to the current user in the current region.
    
    Parameters:
    
    req - DescribeInstanceFamilyConfigsRequest
    
    Returns:
    
    DescribeInstanceFamilyConfigsResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - DescribeInstances
```
public DescribeInstancesResponse DescribeInstances(DescribeInstancesRequest req)
                                            throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to query the details of instances. You can filter the query results with the instance `ID`, name, or billing method. See `Filter` for more information. If no parameter is defined, a certain number of instances under the current account will be returned. The number is specified by `Limit` and is 20 by default.
    
    Parameters:
    
    req - DescribeInstancesRequest
    
    Returns:
    
    DescribeInstancesResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - DescribeInstancesOperationLimit
```
public DescribeInstancesOperationLimitResponse DescribeInstancesOperationLimit(DescribeInstancesOperationLimitRequest req)
                                                                        throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to query limitations on operations on an instance. Currently you can use this API to query the maximum number of times you can modify the configuration of an instance.
    
    Parameters:
    
    req - DescribeInstancesOperationLimitRequest
    
    Returns:
    
    DescribeInstancesOperationLimitResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - DescribeInstancesStatus
```
public DescribeInstancesStatusResponse DescribeInstancesStatus(DescribeInstancesStatusRequest req)
                                                        throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to query the status of instances. You can query the status of an instance with its `ID`. If no parameter is defined, the status of a certain number of instances under the current account will be returned. The number is specified by `Limit` and is 20 by default.
    
    Parameters:
    
    req - DescribeInstancesStatusRequest
    
    Returns:
    
    DescribeInstancesStatusResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - DescribeInternetChargeTypeConfigs
```
public DescribeInternetChargeTypeConfigsResponse DescribeInternetChargeTypeConfigs(DescribeInternetChargeTypeConfigsRequest req)
                                                                            throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to query the network billing methods.
    
    Parameters:
    
    req - DescribeInternetChargeTypeConfigsRequest
    
    Returns:
    
    DescribeInternetChargeTypeConfigsResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - DescribeKeyPairs
```
public DescribeKeyPairsResponse DescribeKeyPairs(DescribeKeyPairsRequest req)
                                          throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to query key pairs. A key pair is a pair of keys generated by an algorithm in which the public key is available to the public and the private key is available only to the user. You can use this API to query the public key but not the private key.
    
    Parameters:
    
    req - DescribeKeyPairsRequest
    
    Returns:
    
    DescribeKeyPairsResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - DescribeLaunchTemplateVersions
```
public DescribeLaunchTemplateVersionsResponse DescribeLaunchTemplateVersions(DescribeLaunchTemplateVersionsRequest req)
                                                                      throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to query the information of instance launch template versions.
    
    Parameters:
    
    req - DescribeLaunchTemplateVersionsRequest
    
    Returns:
    
    DescribeLaunchTemplateVersionsResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - DescribeLaunchTemplates
```
public DescribeLaunchTemplatesResponse DescribeLaunchTemplates(DescribeLaunchTemplatesRequest req)
                                                        throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to query one or more instance launch templates.
    
    Parameters:
    
    req - DescribeLaunchTemplatesRequest
    
    Returns:
    
    DescribeLaunchTemplatesResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - DescribeRegions
```
public DescribeRegionsResponse DescribeRegions(DescribeRegionsRequest req)
                                        throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is suspended. To query the information of regions, use [DescribeZones](https://intl.cloud.tencent.com/document/product/1596/77930?from_cn_redirect=1).
    
    Parameters:
    
    req - DescribeRegionsRequest
    
    Returns:
    
    DescribeRegionsResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - DescribeReservedInstancesConfigInfos
```
public DescribeReservedInstancesConfigInfosResponse DescribeReservedInstancesConfigInfos(DescribeReservedInstancesConfigInfosRequest req)
                                                                                  throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to describe reserved instance (RI) offerings. Currently, RIs are only offered to beta users.
    
    Parameters:
    
    req - DescribeReservedInstancesConfigInfosRequest
    
    Returns:
    
    DescribeReservedInstancesConfigInfosResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - DescribeReservedInstancesOfferings
```
public DescribeReservedInstancesOfferingsResponse DescribeReservedInstancesOfferings(DescribeReservedInstancesOfferingsRequest req)
                                                                              throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to describe Reserved Instance offerings that are available for purchase.
    
    Parameters:
    
    req - DescribeReservedInstancesOfferingsRequest
    
    Returns:
    
    DescribeReservedInstancesOfferingsResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - DescribeZoneInstanceConfigInfos
```
public DescribeZoneInstanceConfigInfosResponse DescribeZoneInstanceConfigInfos(DescribeZoneInstanceConfigInfosRequest req)
                                                                        throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to query the configurations of models in an availability zone.
    
    Parameters:
    
    req - DescribeZoneInstanceConfigInfosRequest
    
    Returns:
    
    DescribeZoneInstanceConfigInfosResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - DescribeZones
```
public DescribeZonesResponse DescribeZones(DescribeZonesRequest req)
                                    throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to query availability zones.
    
    Parameters:
    
    req - DescribeZonesRequest
    
    Returns:
    
    DescribeZonesResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - DisassociateInstancesKeyPairs
```
public DisassociateInstancesKeyPairsResponse DisassociateInstancesKeyPairs(DisassociateInstancesKeyPairsRequest req)
                                                                    throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to unbind one or more key pairs from one or more instances. It only supports [`STOPPED`](https://intl.cloud.tencent.com/document/product/213/15753?from_cn_redirect=1#InstanceStatus) Linux instances. After a key pair is disassociated from an instance, you can log in to the instance with password. If you did not set a password for the instance, you will not be able to log in via SSH after the unbinding. In this case, you can call [ResetInstancesPassword](https://intl.cloud.tencent.com/document/api/213/15736?from_cn_redirect=1) to set a login password. Batch operations are supported. The maximum number of instances in each request is 100. If instances not available for the operation are selected, you will get an error code.
    
    Parameters:
    
    req - DisassociateInstancesKeyPairsRequest
    
    Returns:
    
    DisassociateInstancesKeyPairsResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - DisassociateSecurityGroups
```
public DisassociateSecurityGroupsResponse DisassociateSecurityGroups(DisassociateSecurityGroupsRequest req)
                                                              throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to disassociate security groups from instances.
    
    Parameters:
    
    req - DisassociateSecurityGroupsRequest
    
    Returns:
    
    DisassociateSecurityGroupsResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - ExportImages
```
public ExportImagesResponse ExportImages(ExportImagesRequest req)
                                  throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to export custom images to the specified COS bucket.
    
    Parameters:
    
    req - ExportImagesRequest
    
    Returns:
    
    ExportImagesResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - ImportImage
```
public ImportImageResponse ImportImage(ImportImageRequest req)
                                throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    The API is used to import an image. The image imported can be used to create instances. Currently, this API can import images in formats like RAW, VHD, QCOW2, and VMDK.
    
    Parameters:
    
    req - ImportImageRequest
    
    Returns:
    
    ImportImageResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - ImportKeyPair
```
public ImportKeyPairResponse ImportKeyPair(ImportKeyPairRequest req)
                                    throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to import key pairs. You can use this API to import key pairs to a user account, but the key pairs will not be automatically associated with any instance. You may use [AssociasteInstancesKeyPair](https://intl.cloud.tencent.com/document/api/213/15698?from_cn_redirect=1) to associate key pairs with instances. You need to specify the names of the key pairs and the content of the public keys. If you only have private keys, you can convert them to public keys with the `SSL` tool before importing them.
    
    Parameters:
    
    req - ImportKeyPairRequest
    
    Returns:
    
    ImportKeyPairResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - InquirePricePurchaseReservedInstancesOffering
```
public InquirePricePurchaseReservedInstancesOfferingResponse InquirePricePurchaseReservedInstancesOffering(InquirePricePurchaseReservedInstancesOfferingRequest req)
                                                                                                    throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to query the price of reserved instances. It only supports querying purchasable reserved instance offerings. Currently, RIs are only offered to beta users.
    
    Parameters:
    
    req - InquirePricePurchaseReservedInstancesOfferingRequest
    
    Returns:
    
    InquirePricePurchaseReservedInstancesOfferingResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - InquiryPriceResetInstance
```
public InquiryPriceResetInstanceResponse InquiryPriceResetInstance(InquiryPriceResetInstanceRequest req)
                                                            throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to query the price for reinstalling an instance. If you have specified the `ImageId` parameter, the price query is performed with the specified image. Otherwise, the image used by the current instance is used. You can only query the price for reinstallation caused by switching between Linux and Windows OS. And the [system disk type](https://intl.cloud.tencent.com/document/api/213/15753?from_cn_redirect=1#SystemDisk) of the instance must be `CLOUD_BASIC`, `CLOUD_PREMIUM`, or `CLOUD_SSD`. Currently, this API only supports instances in Mainland China regions.
    
    Parameters:
    
    req - InquiryPriceResetInstanceRequest
    
    Returns:
    
    InquiryPriceResetInstanceResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - InquiryPriceResetInstancesInternetMaxBandwidth
```
public InquiryPriceResetInstancesInternetMaxBandwidthResponse InquiryPriceResetInstancesInternetMaxBandwidth(InquiryPriceResetInstancesInternetMaxBandwidthRequest req)
                                                                                                      throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to query the price for upgrading the public bandwidth cap of an instance. The allowed bandwidth cap varies for different models. For details, see [Purchasing Network Bandwidth](https://intl.cloud.tencent.com/document/product/213/509?from_cn_redirect=1). For bandwidth billed by the `TRAFFIC_POSTPAID_BY_HOUR` method, changing the bandwidth cap through this API takes effect in real time. You can increase or reduce bandwidth within applicable limits.
    
    Parameters:
    
    req - InquiryPriceResetInstancesInternetMaxBandwidthRequest
    
    Returns:
    
    InquiryPriceResetInstancesInternetMaxBandwidthResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - InquiryPriceResetInstancesType
```
public InquiryPriceResetInstancesTypeResponse InquiryPriceResetInstancesType(InquiryPriceResetInstancesTypeRequest req)
                                                                      throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to query the price for adjusting the instance model. Currently, you can only use this API to query the prices of instances whose [system disk type](https://intl.cloud.tencent.com/document/api/213/9452?from_cn_redirect=1#block_device) is `CLOUD_BASIC`, `CLOUD_PREMIUM`, or `CLOUD_SSD`. Currently, you cannot use this API to query the prices of [CDH](https://intl.cloud.tencent.com/document/product/416?from_cn_redirect=1) instances.
    
    Parameters:
    
    req - InquiryPriceResetInstancesTypeRequest
    
    Returns:
    
    InquiryPriceResetInstancesTypeResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - InquiryPriceResizeInstanceDisks
```
public InquiryPriceResizeInstanceDisksResponse InquiryPriceResizeInstanceDisks(InquiryPriceResizeInstanceDisksRequest req)
                                                                        throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to query the price for expanding data disks of an instance. Currently, you can only use this API to query the price of non-elastic data disks whose [disk type](https://intl.cloud.tencent.com/document/api/213/9452?from_cn_redirect=1#block_device) is `CLOUD_BASIC`, `CLOUD_PREMIUM`, or `CLOUD_SSD`. You can use [`DescribeDisks`](https://intl.cloud.tencent.com/document/api/362/16315?from_cn_redirect=1) to check whether a disk is elastic. If the `Portable` field in the response is `false`, it means that the disk is non-elastic. Currently, you cannot use this API to query the price for [CDH](https://intl.cloud.tencent.com/document/product/416?from_cn_redirect=1) instances. *Also, you can only query the price of expanding one data disk at a time.
    
    Parameters:
    
    req - InquiryPriceResizeInstanceDisksRequest
    
    Returns:
    
    InquiryPriceResizeInstanceDisksResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - InquiryPriceRunInstances
```
public InquiryPriceRunInstancesResponse InquiryPriceRunInstances(InquiryPriceRunInstancesRequest req)
                                                          throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to 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](https://intl.cloud.tencent.com/document/api/213/15730?from_cn_redirect=1).
    
    Parameters:
    
    req - InquiryPriceRunInstancesRequest
    
    Returns:
    
    InquiryPriceRunInstancesResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - ModifyChcAttribute
```
public ModifyChcAttributeResponse ModifyChcAttribute(ModifyChcAttributeRequest req)
                                              throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to modify the CHC host attributes.
    
    Parameters:
    
    req - ModifyChcAttributeRequest
    
    Returns:
    
    ModifyChcAttributeResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - ModifyDisasterRecoverGroupAttribute
```
public ModifyDisasterRecoverGroupAttributeResponse ModifyDisasterRecoverGroupAttribute(ModifyDisasterRecoverGroupAttributeRequest req)
                                                                                throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to modify the attributes of [spread placement groups](https://intl.cloud.tencent.com/document/product/213/15486?from_cn_redirect=1).
    
    Parameters:
    
    req - ModifyDisasterRecoverGroupAttributeRequest
    
    Returns:
    
    ModifyDisasterRecoverGroupAttributeResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - ModifyHostsAttribute
```
public ModifyHostsAttributeResponse ModifyHostsAttribute(ModifyHostsAttributeRequest req)
                                                  throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to modify the attributes of a CDH instance, such as instance name and renewal flag. One of the two parameters, HostName and RenewFlag, must be set, but you cannot set both of them at the same time.
    
    Parameters:
    
    req - ModifyHostsAttributeRequest
    
    Returns:
    
    ModifyHostsAttributeResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - ModifyImageAttribute
```
public ModifyImageAttributeResponse ModifyImageAttribute(ModifyImageAttributeRequest req)
                                                  throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to modify image attributes. Attributes of shared images cannot be modified.
    
    Parameters:
    
    req - ModifyImageAttributeRequest
    
    Returns:
    
    ModifyImageAttributeResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - ModifyImageSharePermission
```
public ModifyImageSharePermissionResponse ModifyImageSharePermission(ModifyImageSharePermissionRequest req)
                                                              throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to modify image sharing information. The accounts with which an image is shared can use the shared image to create instances. Each custom image can be shared with up to 50 accounts. You can use a shared image to create instances, but you cannot change its name and description. If an image is shared with another account, the shared image will be in the same region as the original image.
    
    Parameters:
    
    req - ModifyImageSharePermissionRequest
    
    Returns:
    
    ModifyImageSharePermissionResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - ModifyInstancesAttribute
```
public ModifyInstancesAttributeResponse ModifyInstancesAttribute(ModifyInstancesAttributeRequest req)
                                                          throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    The API is used to modify the attributes of an instance. Only the name and the associated security groups can be modified for now. An attribute must be specified in the request. "Instance name" is a custom name for easier management. Tencent Cloud does not use the name for online support or instance management. Batch operations are supported. Each request can modify up to 100 instances. When you modify the security groups associated with an instance is modified, the original security groups are disassociated. You can use the API [DescribeInstances](https://intl.cloud.tencent.com/document/api/213/15728?from_cn_redirect=1#.E7.A4.BA.E4.BE.8B3-.E6.9F.A5.E8.AF.A2.E5.AE.9E.E4.BE.8B.E7.9A.84.E6.9C.80.E6.96.B0.E6.93.8D.E4.BD.9C.E6.83.85.E5.86.B5) to query the instance operation result. If the 'LatestOperationState' in the response is **SUCCESS**, the operation is successful.
    
    Parameters:
    
    req - ModifyInstancesAttributeRequest
    
    Returns:
    
    ModifyInstancesAttributeResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - ModifyInstancesProject
```
public ModifyInstancesProjectResponse ModifyInstancesProject(ModifyInstancesProjectRequest req)
                                                      throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to change the project to which an instance is assigned. Project is a virtual concept. You can create multiple projects under one account, manage different resources in each project, and assign different instances to different projects. You may use the [DescribeInstances](https://intl.cloud.tencent.com/document/api/213/15728?from_cn_redirect=1) API to query instances and use the project ID to filter the results. You cannot modify the project of an instance that is bound to a load balancer. You need to unbind the load balancer from the instance by using the [DeregisterInstancesFromLoadBalancer](https://intl.cloud.tencent.com/document/api/214/1258?from_cn_redirect=1) API before using this API. Batch operations are supported. Up to 100 instances per request is allowed. You can use the API [DescribeInstances](https://intl.cloud.tencent.com/document/api/213/15728?from_cn_redirect=1#.E7.A4.BA.E4.BE.8B3-.E6.9F.A5.E8.AF.A2.E5.AE.9E.E4.BE.8B.E7.9A.84.E6.9C.80.E6.96.B0.E6.93.8D.E4.BD.9C.E6.83.85.E5.86.B5) to query the operation result. If the `LatestOperationState` in the response is `SUCCESS`, the operation is successful.
    
    Parameters:
    
    req - ModifyInstancesProjectRequest
    
    Returns:
    
    ModifyInstancesProjectResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - ModifyInstancesVpcAttribute
```
public ModifyInstancesVpcAttributeResponse ModifyInstancesVpcAttribute(ModifyInstancesVpcAttributeRequest req)
                                                                throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to modify the VPC attributes of an instance, such as the VPC IP address. This action will shut down the instance, and restart it after the modification is completed. To migrate an instance to another VPC/subnet, specify the new VPC and subnet directly. Make sure that the instance to migrate is not bound to an [ENI](https://intl.cloud.tencent.com/document/product/576?from_cn_redirect=1) or [CLB](https://intl.cloud.tencent.com/document/product/214?from_cn_redirect=1) instances. You can use the API [DescribeInstances](https://intl.cloud.tencent.com/document/api/213/15728?from_cn_redirect=1#.E7.A4.BA.E4.BE.8B3-.E6.9F.A5.E8.AF.A2.E5.AE.9E.E4.BE.8B.E7.9A.84.E6.9C.80.E6.96.B0.E6.93.8D.E4.BD.9C.E6.83.85.E5.86.B5) to query the operation result. If the `LatestOperationState` in the response is `SUCCESS`, the operation is successful.
    
    Parameters:
    
    req - ModifyInstancesVpcAttributeRequest
    
    Returns:
    
    ModifyInstancesVpcAttributeResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - ModifyKeyPairAttribute
```
public ModifyKeyPairAttributeResponse ModifyKeyPairAttribute(ModifyKeyPairAttributeRequest req)
                                                      throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to modify the attributes of key pairs. This API modifies the name and description of the key pair identified by the key pair ID. The name of the key pair must be unique. Key pair ID is the unique identifier of a key pair and cannot be modified.
    
    Parameters:
    
    req - ModifyKeyPairAttributeRequest
    
    Returns:
    
    ModifyKeyPairAttributeResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - ModifyLaunchTemplateDefaultVersion
```
public ModifyLaunchTemplateDefaultVersionResponse ModifyLaunchTemplateDefaultVersion(ModifyLaunchTemplateDefaultVersionRequest req)
                                                                              throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to modify the default version of the instance launch template.
    
    Parameters:
    
    req - ModifyLaunchTemplateDefaultVersionRequest
    
    Returns:
    
    ModifyLaunchTemplateDefaultVersionResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - PurchaseReservedInstancesOffering
```
public PurchaseReservedInstancesOfferingResponse PurchaseReservedInstancesOffering(PurchaseReservedInstancesOfferingRequest req)
                                                                            throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to purchase one or more specific Reserved Instances.
    
    Parameters:
    
    req - PurchaseReservedInstancesOfferingRequest
    
    Returns:
    
    PurchaseReservedInstancesOfferingResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - RebootInstances
```
public RebootInstancesResponse RebootInstances(RebootInstancesRequest req)
                                        throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to restart instances. You can only perform this operation on instances whose status is `RUNNING`. If the API is called successfully, the instance status will become `REBOOTING`. After the instance is restarted, its status will become `RUNNING` again. Forced restart is supported. A forced restart is similar to switching off the power of a physical computer and starting it again. It may cause data loss or file system corruption. Be sure to only force start a CVM when it cannot be restarted normally. Batch operations are supported. The maximum number of instances in each request is 100.
    
    Parameters:
    
    req - RebootInstancesRequest
    
    Returns:
    
    RebootInstancesResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - RemoveChcAssistVpc
```
public RemoveChcAssistVpcResponse RemoveChcAssistVpc(RemoveChcAssistVpcRequest req)
                                              throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to remove the out-of-band network and deployment network of a CHC host.
    
    Parameters:
    
    req - RemoveChcAssistVpcRequest
    
    Returns:
    
    RemoveChcAssistVpcResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - RemoveChcDeployVpc
```
public RemoveChcDeployVpcResponse RemoveChcDeployVpc(RemoveChcDeployVpcRequest req)
                                              throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to remove the deployment network of a CHC host.
    
    Parameters:
    
    req - RemoveChcDeployVpcRequest
    
    Returns:
    
    RemoveChcDeployVpcResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - ResetInstance
```
public ResetInstanceResponse ResetInstance(ResetInstanceRequest req)
                                    throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to reinstall the operating system of the specified instance. If you specify an `ImageId`, the specified image is used. Otherwise, the image used by the current instance is used. The system disk will be formatted and reset. Therefore, make sure that no important files are stored on the system disk. If the operating system switches between `Linux` and `Windows`, the system disk `ID` of the instance will change, and the snapshots that are associated with the system disk can no longer be used to roll back and restore data. If no password is specified, you will get a random password via internal message. You can only use this API to switch the operating system between `Linux` and `Windows` for instances whose [system disk type](https://intl.cloud.tencent.com/document/api/213/9452?from_cn_redirect=1#SystemDisk) is `CLOUD_BASIC`, `CLOUD_PREMIUM`, or `CLOUD_SSD`. Currently, this API only supports instances in Mainland China regions.
    
    Parameters:
    
    req - ResetInstanceRequest
    
    Returns:
    
    ResetInstanceResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - ResetInstancesInternetMaxBandwidth
```
public ResetInstancesInternetMaxBandwidthResponse ResetInstancesInternetMaxBandwidth(ResetInstancesInternetMaxBandwidthRequest req)
                                                                              throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to change the public bandwidth cap of an instance. The allowed bandwidth cap varies for different models. For details, see [Purchasing Network Bandwidth](https://intl.cloud.tencent.com/document/product/213/509?from_cn_redirect=1). For bandwidth billed by the `TRAFFIC_POSTPAID_BY_HOUR` method, changing the bandwidth cap through this API takes effect in real time. Users can increase or reduce bandwidth within applicable limits.
    
    Parameters:
    
    req - ResetInstancesInternetMaxBandwidthRequest
    
    Returns:
    
    ResetInstancesInternetMaxBandwidthResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - ResetInstancesPassword
```
public ResetInstancesPasswordResponse ResetInstancesPassword(ResetInstancesPasswordRequest req)
                                                      throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to reset the password of the operating system instances to a user-specified password. To modify the password of the administrator account: the name of the administrator account varies with the operating system. In Windows, it is `Administrator`; in Ubuntu, it is `ubuntu`; in Linux, it is `root`. To reset the password of a running instance, you need to set the parameter `ForceStop` to `True` for a forced shutdown. If not, only passwords of stopped instances can be reset. Batch operations are supported. You can reset the passwords of up to 100 instances to the same value once. You can call the [DescribeInstances](https://intl.cloud.tencent.com/document/api/213/15728?from_cn_redirect=1#.E7.A4.BA.E4.BE.8B3-.E6.9F.A5.E8.AF.A2.E5.AE.9E.E4.BE.8B.E7.9A.84.E6.9C.80.E6.96.B0.E6.93.8D.E4.BD.9C.E6.83.85.E5.86.B5) API and find the result of the operation in the response parameter `LatestOperationState`. If the value is `SUCCESS`, the operation is successful.
    
    Parameters:
    
    req - ResetInstancesPasswordRequest
    
    Returns:
    
    ResetInstancesPasswordResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - ResetInstancesType
```
public ResetInstancesTypeResponse ResetInstancesType(ResetInstancesTypeRequest req)
                                              throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to change the model of an instance. You can only use this API to change the models of instances whose [system disk type](https://intl.cloud.tencent.com/document/api/213/9452?from_cn_redirect=1#block_device) is `CLOUD_BASIC`, `CLOUD_PREMIUM`, or `CLOUD_SSD`. Currently, you cannot use this API to change the models of [CDH](https://intl.cloud.tencent.com/document/product/416?from_cn_redirect=1) instances.
    
    Parameters:
    
    req - ResetInstancesTypeRequest
    
    Returns:
    
    ResetInstancesTypeResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - ResizeInstanceDisks
```
public ResizeInstanceDisksResponse ResizeInstanceDisks(ResizeInstanceDisksRequest req)
                                                throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API (ResizeInstanceDisks) is used to expand the data disks of an instance. Currently, you can only use the API to expand non-elastic data disks whose [disk type](https://intl.cloud.tencent.com/document/api/213/9452?from_cn_redirect=1#block_device) is `CLOUD_BASIC`, `CLOUD_PREMIUM`, or `CLOUD_SSD`. You can use [`DescribeDisks`](https://intl.cloud.tencent.com/document/api/362/16315?from_cn_redirect=1) to check whether a disk is elastic. If the `Portable` field in the response is `false`, it means that the disk is non-elastic. Currently, this API does not support [CDH](https://intl.cloud.tencent.com/document/product/416?from_cn_redirect=1) instances. Currently, only one data disk can be expanded at a time.
    
    Parameters:
    
    req - ResizeInstanceDisksRequest
    
    Returns:
    
    ResizeInstanceDisksResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - RunInstances
```
public RunInstancesResponse RunInstances(RunInstancesRequest req)
                                  throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to create one or more instances with a specified configuration. After an instance is created successfully, it will start up automatically, and the [instance status](https://intl.cloud.tencent.com/document/api/213/9452?from_cn_redirect=1#instance_state) will become "Running". If you create a pay-as-you-go instance billed on an hourly basis, an amount equivalent to the hourly rate will be frozen. Make sure your account balance is sufficient before calling this API. The number of instances you can purchase through this API is subject to the [Quota for CVM Instances](https://intl.cloud.tencent.com/document/product/213/2664?from_cn_redirect=1). Instances created through this API and in the CVM console are counted toward the quota. This API is an async API. An instance ID list is returned after the creation request is sent. However, it does not mean the creation has been completed. The status of the instance will be `Creating` during the creation. You can use [DescribeInstances](https://intl.cloud.tencent.com/document/api/213/15728?from_cn_redirect=1) to query the status of the instance. If the status changes from `Creating` to `Running`, it means that the instance has been created successfully.
    
    Parameters:
    
    req - RunInstancesRequest
    
    Returns:
    
    RunInstancesResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - StartInstances
```
public StartInstancesResponse StartInstances(StartInstancesRequest req)
                                      throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to start instances. You can only perform this operation on instances whose status is `STOPPED`. The instance status will become `STARTING` when the API is called successfully and `RUNNING` when the instance is successfully started. Batch operations are supported. The maximum number of instances in each request is 100.
    
    Parameters:
    
    req - StartInstancesRequest
    
    Returns:
    
    StartInstancesResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - StopInstances
```
public StopInstancesResponse StopInstances(StopInstancesRequest req)
                                    throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to shut down instances. You can only perform this operation on instances whose status is `RUNNING`. The instance status will become `STOPPING` when the API is called successfully and `STOPPED` when the instance is successfully shut down. Forced shutdown is supported. A forced shutdown is similar to switching off the power of a physical computer. It may cause data loss or file system corruption. Be sure to only force shut down a CVM when it cannot be sht down normally. Batch operations are supported. The maximum number of instances in each request is 100.
    
    Parameters:
    
    req - StopInstancesRequest
    
    Returns:
    
    StopInstancesResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - SyncImages
```
public SyncImagesResponse SyncImages(SyncImagesRequest req)
                              throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to sync a custom image to other regions. Each API call syncs a single image. This API supports syncing an image to multiple regions. Each account can have up to 10 custom images in each region.
    
    Parameters:
    
    req - SyncImagesRequest
    
    Returns:
    
    SyncImagesResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - TerminateInstances
```
public TerminateInstancesResponse TerminateInstances(TerminateInstancesRequest req)
                                              throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to return instances. Use this API to return instances that are no longer required. Pay-as-you-go instances can be returned directly through this API. When this API is called for the first time, the instance will be moved to the recycle bin. When this API is called for the second time, the instance will be terminated and cannot be recovered. Batch operations are supported. The allowed maximum number of instances in each request is 100.
    
    Parameters:
    
    req - TerminateInstancesRequest
    
    Returns:
    
    TerminateInstancesResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException

Class CvmClient

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractClient

Constructor Summary

Method Summary

Methods inherited from class com.tencentcloudapi.common.AbstractClient

Methods inherited from class java.lang.Object

Constructor Detail

CvmClient

CvmClient

Method Detail

AllocateHosts

AssociateInstancesKeyPairs

AssociateSecurityGroups

ConfigureChcAssistVpc

ConfigureChcDeployVpc

CreateDisasterRecoverGroup

CreateImage

CreateKeyPair

CreateLaunchTemplateVersion

DeleteDisasterRecoverGroups

DeleteImages

DeleteKeyPairs

DeleteLaunchTemplate

DeleteLaunchTemplateVersions

DescribeChcDeniedActions

DescribeChcHosts

DescribeDisasterRecoverGroupQuota

DescribeDisasterRecoverGroups

DescribeHosts

DescribeImageQuota

DescribeImageSharePermission

DescribeImages

DescribeImportImageOs

DescribeInstanceFamilyConfigs

DescribeInstances

DescribeInstancesOperationLimit

DescribeInstancesStatus

DescribeInternetChargeTypeConfigs

DescribeKeyPairs

DescribeLaunchTemplateVersions

DescribeLaunchTemplates

DescribeRegions

DescribeReservedInstancesConfigInfos

DescribeReservedInstancesOfferings

DescribeZoneInstanceConfigInfos

DescribeZones

DisassociateInstancesKeyPairs

DisassociateSecurityGroups

ExportImages

ImportImage

ImportKeyPair

InquirePricePurchaseReservedInstancesOffering

InquiryPriceResetInstance

InquiryPriceResetInstancesInternetMaxBandwidth

InquiryPriceResetInstancesType

InquiryPriceResizeInstanceDisks

InquiryPriceRunInstances

ModifyChcAttribute

ModifyDisasterRecoverGroupAttribute

ModifyHostsAttribute

ModifyImageAttribute

ModifyImageSharePermission

ModifyInstancesAttribute

ModifyInstancesProject

ModifyInstancesVpcAttribute

ModifyKeyPairAttribute

ModifyLaunchTemplateDefaultVersion

PurchaseReservedInstancesOffering

RebootInstances

RemoveChcAssistVpc

RemoveChcDeployVpc

ResetInstance

ResetInstancesInternetMaxBandwidth

ResetInstancesPassword

ResetInstancesType

ResizeInstanceDisks

RunInstances

StartInstances

StopInstances