LighthouseClient (tencentcloud-sdk-java-intl-en 3.0.612 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractClient
- - com.tencentcloudapi.lighthouse.v20200324.LighthouseClient

public class LighthouseClient
extends AbstractClient

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

Constructor Summary

Constructors
Constructor and Description
`LighthouseClient(Credential credential, String region)`
`LighthouseClient(Credential credential, String region, ClientProfile profile)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ApplyInstanceSnapshotResponse`	`ApplyInstanceSnapshot(ApplyInstanceSnapshotRequest req)` This API is used to roll back the system disk snapshot of the specified instance.
`AssociateInstancesKeyPairsResponse`	`AssociateInstancesKeyPairs(AssociateInstancesKeyPairsRequest req)` This API is used to bind a user-specified key pair to an instance.
`AttachCcnResponse`	`AttachCcn(AttachCcnRequest req)` This API is used to associate a CCN instance.
`AttachDisksResponse`	`AttachDisks(AttachDisksRequest req)` This API is used to attach one or more cloud disks.
`CreateBlueprintResponse`	`CreateBlueprint(CreateBlueprintRequest req)` This API is used to create an image.
`CreateFirewallRulesResponse`	`CreateFirewallRules(CreateFirewallRulesRequest req)` This API is used to add a firewall rule on an instance.
`CreateInstancesResponse`	`CreateInstances(CreateInstancesRequest req)` This API is used to create one or more Lighthouse instances.
`CreateInstanceSnapshotResponse`	`CreateInstanceSnapshot(CreateInstanceSnapshotRequest req)` This API is used to create a system disk snapshot of the specified instance.
`CreateKeyPairResponse`	`CreateKeyPair(CreateKeyPairRequest req)` This API is used to create a key pair.
`DeleteBlueprintsResponse`	`DeleteBlueprints(DeleteBlueprintsRequest req)` This API is used to delete an image.
`DeleteFirewallRulesResponse`	`DeleteFirewallRules(DeleteFirewallRulesRequest req)` This API is used to delete a firewall rule of an instance.
`DeleteKeyPairsResponse`	`DeleteKeyPairs(DeleteKeyPairsRequest req)` This API is used to delete a key pair.
`DeleteSnapshotsResponse`	`DeleteSnapshots(DeleteSnapshotsRequest req)` This API is used to delete a snapshot.
`DescribeAllScenesResponse`	`DescribeAllScenes(DescribeAllScenesRequest req)` This API is used to query the list of scenes in all regions.
`DescribeBlueprintInstancesResponse`	`DescribeBlueprintInstances(DescribeBlueprintInstancesRequest req)` This API is used to query the information of an image instance.
`DescribeBlueprintsResponse`	`DescribeBlueprints(DescribeBlueprintsRequest req)` This API is used to query the information of an image.
`DescribeBundleDiscountResponse`	`DescribeBundleDiscount(DescribeBundleDiscountRequest req)` This API is used to query the discount information of a package.
`DescribeBundlesResponse`	`DescribeBundles(DescribeBundlesRequest req)` This API is used to query the information of a package.
`DescribeCcnAttachedInstancesResponse`	`DescribeCcnAttachedInstances(DescribeCcnAttachedInstancesRequest req)` This API is used to query the information of instances associated with CCN.
`DescribeDiskConfigsResponse`	`DescribeDiskConfigs(DescribeDiskConfigsRequest req)` This API is used to query the cloud disk configuration.
`DescribeDiskDiscountResponse`	`DescribeDiskDiscount(DescribeDiskDiscountRequest req)` This API is used to query the discount information of a cloud disk.
`DescribeDisksResponse`	`DescribeDisks(DescribeDisksRequest req)` This API is used to query the information of one or more cloud disks.
`DescribeDisksDeniedActionsResponse`	`DescribeDisksDeniedActions(DescribeDisksDeniedActionsRequest req)` This API is used to query the list of operation limits of one or more cloud disks.
`DescribeDisksReturnableResponse`	`DescribeDisksReturnable(DescribeDisksReturnableRequest req)` This API is used to query whether the specified cloud disk can be returned.
`DescribeFirewallRulesResponse`	`DescribeFirewallRules(DescribeFirewallRulesRequest req)` This API is used to query the firewall rules of an instance.
`DescribeFirewallRulesTemplateResponse`	`DescribeFirewallRulesTemplate(DescribeFirewallRulesTemplateRequest req)` This API is used to query a firewall rule template.
`DescribeGeneralResourceQuotasResponse`	`DescribeGeneralResourceQuotas(DescribeGeneralResourceQuotasRequest req)` This API is used to query the quota information of general resources.
`DescribeInstanceLoginKeyPairAttributeResponse`	`DescribeInstanceLoginKeyPairAttribute(DescribeInstanceLoginKeyPairAttributeRequest req)` This API is used to query the attributes of the default login key of an instance.
`DescribeInstancesResponse`	`DescribeInstances(DescribeInstancesRequest req)` This API is used to query the details of one or multiple instances.
`DescribeInstancesDeniedActionsResponse`	`DescribeInstancesDeniedActions(DescribeInstancesDeniedActionsRequest req)` This API is used to query the list of operation limits of one or more instances.
`DescribeInstancesDiskNumResponse`	`DescribeInstancesDiskNum(DescribeInstancesDiskNumRequest req)` This API is used to query the number of cloud disks attached to instances.
`DescribeInstancesReturnableResponse`	`DescribeInstancesReturnable(DescribeInstancesReturnableRequest req)` This API is used to query whether the specified instance can be returned.
`DescribeInstancesTrafficPackagesResponse`	`DescribeInstancesTrafficPackages(DescribeInstancesTrafficPackagesRequest req)` This API is used to query the traffic package details of one or more instances.
`DescribeInstanceVncUrlResponse`	`DescribeInstanceVncUrl(DescribeInstanceVncUrlRequest req)` This API is used to query the URL for VNC login.
`DescribeKeyPairsResponse`	`DescribeKeyPairs(DescribeKeyPairsRequest req)` This API is used to query key pairs.
`DescribeModifyInstanceBundlesResponse`	`DescribeModifyInstanceBundles(DescribeModifyInstanceBundlesRequest req)` This API is used to query the list of package options of an instance.
`DescribeRegionsResponse`	`DescribeRegions(DescribeRegionsRequest req)` This API is used to query the information of regions.
`DescribeResetInstanceBlueprintsResponse`	`DescribeResetInstanceBlueprints(DescribeResetInstanceBlueprintsRequest req)` This API is used to query the image information of a reset instance.
`DescribeScenesResponse`	`DescribeScenes(DescribeScenesRequest req)` This API is used to query the list of scenes.
`DescribeSnapshotsResponse`	`DescribeSnapshots(DescribeSnapshotsRequest req)` This API is used to query the list of snapshots.
`DescribeSnapshotsDeniedActionsResponse`	`DescribeSnapshotsDeniedActions(DescribeSnapshotsDeniedActionsRequest req)` This API is used to query the list of operation limits of one or more snapshots.
`DescribeZonesResponse`	`DescribeZones(DescribeZonesRequest req)` This API is used to query the list of AZs in a region.
`DetachCcnResponse`	`DetachCcn(DetachCcnRequest req)` This API is used to unassociate a CCN instance.
`DetachDisksResponse`	`DetachDisks(DetachDisksRequest req)` This API is used to detach one or more cloud disks.
`DisassociateInstancesKeyPairsResponse`	`DisassociateInstancesKeyPairs(DisassociateInstancesKeyPairsRequest req)` This API is used to unbind an instance from the specified key pair.
`ImportKeyPairResponse`	`ImportKeyPair(ImportKeyPairRequest req)` This API is used to import the specified key pair.
`InquirePriceCreateBlueprintResponse`	`InquirePriceCreateBlueprint(InquirePriceCreateBlueprintRequest req)` This API is used to query the price of a created image.
`InquirePriceCreateDisksResponse`	`InquirePriceCreateDisks(InquirePriceCreateDisksRequest req)` This API is used to query the price of purchasing cloud disks.
`InquirePriceCreateInstancesResponse`	`InquirePriceCreateInstances(InquirePriceCreateInstancesRequest req)` This API is used to query the price of a created instance.
`InquirePriceRenewDisksResponse`	`InquirePriceRenewDisks(InquirePriceRenewDisksRequest req)` This API is used to query the price of renewing cloud disks.
`InquirePriceRenewInstancesResponse`	`InquirePriceRenewInstances(InquirePriceRenewInstancesRequest req)` This API is used to query the price of renewing one or more instances.
`ModifyBlueprintAttributeResponse`	`ModifyBlueprintAttribute(ModifyBlueprintAttributeRequest req)` This API is used to modify an image attribute.
`ModifyDisksAttributeResponse`	`ModifyDisksAttribute(ModifyDisksAttributeRequest req)` This API is used to modify cloud disk attributes.
`ModifyDisksRenewFlagResponse`	`ModifyDisksRenewFlag(ModifyDisksRenewFlagRequest req)` This API is used to modify the configuration of auto-renewal of cloud disks.
`ModifyFirewallRuleDescriptionResponse`	`ModifyFirewallRuleDescription(ModifyFirewallRuleDescriptionRequest req)` This API is used to modify the description of a single firewall rule.
`ModifyFirewallRulesResponse`	`ModifyFirewallRules(ModifyFirewallRulesRequest req)` This API is used to reset the firewall rules of an instance.
`ModifyInstancesAttributeResponse`	`ModifyInstancesAttribute(ModifyInstancesAttributeRequest req)` This API is used to modify the attributes of instances.
`ModifyInstancesLoginKeyPairAttributeResponse`	`ModifyInstancesLoginKeyPairAttribute(ModifyInstancesLoginKeyPairAttributeRequest req)` This API is used to set the attributes of the default login key pair of an instance.
`ModifyInstancesRenewFlagResponse`	`ModifyInstancesRenewFlag(ModifyInstancesRenewFlagRequest req)` This API is used to modify the renewal flags of monthly subscribed instances.
`ModifySnapshotAttributeResponse`	`ModifySnapshotAttribute(ModifySnapshotAttributeRequest req)` This API is used to modify the attributes of a snapshot.
`RebootInstancesResponse`	`RebootInstances(RebootInstancesRequest req)` This API is used to restart instances.
`ResetAttachCcnResponse`	`ResetAttachCcn(ResetAttachCcnRequest req)` This API is used to apply for association again after a CCN instance association application expires.
`ResetInstanceResponse`	`ResetInstance(ResetInstanceRequest req)` This API is used to reinstall the image on the specified instance.
`ResetInstancesPasswordResponse`	`ResetInstancesPassword(ResetInstancesPasswordRequest req)` This API is used to reset the password of the instance OS to a user-specified password.
`StartInstancesResponse`	`StartInstances(StartInstancesRequest req)` This API is used to start one or more instances.
`StopInstancesResponse`	`StopInstances(StopInstancesRequest req)` This API is used to shut down one or more instances.
`TerminateDisksResponse`	`TerminateDisks(TerminateDisksRequest req)` This API is used to terminate one or more cloud disk.
`TerminateInstancesResponse`	`TerminateInstances(TerminateInstancesRequest req)` This API is used to terminate one or more instances.

Methods inherited from class com.tencentcloudapi.common.AbstractClient
call, getClientProfile, getCredential, getRegion, internalRequest, setClientProfile, setCredential, setRegion

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

- Constructor Detail
  - LighthouseClient
```
public LighthouseClient(Credential credential,
                        String region)
```
  - LighthouseClient
```
public LighthouseClient(Credential credential,
                        String region,
                        ClientProfile profile)
```
- Method Detail
  - ApplyInstanceSnapshot
```
public ApplyInstanceSnapshotResponse ApplyInstanceSnapshot(ApplyInstanceSnapshotRequest req)
                                                    throws TencentCloudSDKException
```
    This API is used to roll back the system disk snapshot of the specified instance.
  - Only rollback to the original system disk is supported.
  - Only snapshots in `NORMAL` status can be used for rollback. To query the status of a snapshot, you can call the `DescribeSnapshots` API and see the `SnapshotState` field in the response.
  - When a snapshot is rolled back, the status of the instance must be `STOPPED` or `RUNNING`. You can call the `DescribeInstances` API to query the instance status. Instances in `RUNNING` status will be forcibly shut down before snapshot rollback.

Parameters:: req - ApplyInstanceSnapshotRequest
Returns:: ApplyInstanceSnapshotResponse
Throws:: TencentCloudSDKException

AssociateInstancesKeyPairs
```
public AssociateInstancesKeyPairsResponse AssociateInstancesKeyPairs(AssociateInstancesKeyPairsRequest req)
                                                              throws TencentCloudSDKException
```
This API is used to bind a user-specified key pair to an instance. Only instances on LINUX_UNIX in [RUNNING, STOPPED] status are supported. Instances in `RUNNING` status will be forcibly shut down before binding. If the public key of a key pair is written to the SSH configuration of the instance, you 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 instances not available for the operation are selected, you will get an error code. This API is async. After the request is sent successfully, a `RequestId` will be returned. At this time, the operation is not completed immediately. The result of the instance operation can be queried by calling the `DescribeInstances` API. If the latest operation status (LatestOperationState) of the instance is `SUCCESS`, the operation is successful.

Parameters:

req - AssociateInstancesKeyPairsRequest

Returns:

AssociateInstancesKeyPairsResponse

Throws:

TencentCloudSDKException

AttachCcn
```
public AttachCcnResponse AttachCcn(AttachCcnRequest req)
                            throws TencentCloudSDKException
```
This API is used to associate a CCN instance.

Parameters:

req - AttachCcnRequest

Returns:

AttachCcnResponse

Throws:

TencentCloudSDKException

AttachDisks
```
public AttachDisksResponse AttachDisks(AttachDisksRequest req)
                                throws TencentCloudSDKException
```
This API is used to attach one or more cloud disks.

Parameters:

req - AttachDisksRequest

Returns:

AttachDisksResponse

Throws:

TencentCloudSDKException

CreateBlueprint

public CreateBlueprintResponse CreateBlueprint(CreateBlueprintRequest req)
                                        throws TencentCloudSDKException

This API is used to create an image.

Parameters:: req - CreateBlueprintRequest
Returns:: CreateBlueprintResponse
Throws:: TencentCloudSDKException

CreateFirewallRules
```
public CreateFirewallRulesResponse CreateFirewallRules(CreateFirewallRulesRequest req)
                                                throws TencentCloudSDKException
```
This API is used to add a firewall rule on an instance. `FirewallVersion` is the firewall version number. Every time you update the firewall rule version, it will be automatically increased by 1 to prevent the updated rule from expiring. If it is left empty, conflicts will not be considered. In the `FirewallRules` parameter: Valid values of the `Protocol` field include `TCP`, `UDP`, `ICMP`, and `ALL`. For the `Port` field, you can enter only `ALL`, a single port number, several port numbers separated by commas, or a port range indicated by two port numbers separated by a minus sign. If `Port` is a range, the port number on the left of the minus sign must be smaller than the one on the right. If `Protocol` is not `TCP` or `UDP`, `Port` can only be empty or `ALL`. The length of the `Port` field cannot exceed 64 characters. For the `CidrBlock` field, you can enter any string that conforms to the CIDR format standard. Multi-Tenant network isolation rules take precedence over private network rules in the firewall. For the `Action` field, you can enter only `ACCEPT` or `DROP`. The length of the `FirewallRuleDescription` field cannot exceed 64 characters.

Parameters:

req - CreateFirewallRulesRequest

Returns:

CreateFirewallRulesResponse

Throws:

TencentCloudSDKException

CreateInstanceSnapshot
```
public CreateInstanceSnapshotResponse CreateInstanceSnapshot(CreateInstanceSnapshotRequest req)
                                                      throws TencentCloudSDKException
```
This API is used to create a system disk snapshot of the specified instance.

Parameters:

req - CreateInstanceSnapshotRequest

Returns:

CreateInstanceSnapshotResponse

Throws:

TencentCloudSDKException

CreateInstances
```
public CreateInstancesResponse CreateInstances(CreateInstancesRequest req)
                                        throws TencentCloudSDKException
```
This API is used to create one or more Lighthouse instances.

Parameters:

req - CreateInstancesRequest

Returns:

CreateInstancesResponse

Throws:

TencentCloudSDKException

CreateKeyPair
```
public CreateKeyPairResponse CreateKeyPair(CreateKeyPairRequest req)
                                    throws TencentCloudSDKException
```
This API is used to create a key pair.

Parameters:

req - CreateKeyPairRequest

Returns:

CreateKeyPairResponse

Throws:

TencentCloudSDKException

DeleteBlueprints

public DeleteBlueprintsResponse DeleteBlueprints(DeleteBlueprintsRequest req)
                                          throws TencentCloudSDKException

This API is used to delete an image.

Parameters:: req - DeleteBlueprintsRequest
Returns:: DeleteBlueprintsResponse
Throws:: TencentCloudSDKException

DeleteFirewallRules
```
public DeleteFirewallRulesResponse DeleteFirewallRules(DeleteFirewallRulesRequest req)
                                                throws TencentCloudSDKException
```
This API is used to delete a firewall rule of an instance. `FirewallVersion` is used to specify the version of the firewall to be manipulated. If the `FirewallVersion` value passed in is not equal to the current latest version of the firewall, a failure will be returned. If `FirewallVersion` is not passed in, the specified rule will be deleted directly. In the `FirewallRules` parameter: Valid values of the `Protocol` field include `TCP`, `UDP`, `ICMP`, and `ALL`. For the `Port` field, you can enter only `ALL`, a single port number, several port numbers separated by commas, or a port range indicated by two port numbers separated by a minus sign. If `Port` is a range, the port number on the left of the minus sign must be smaller than the one on the right. If `Protocol` is not `TCP` or `UDP`, `Port` can only be empty or `ALL`. The length of the `Port` field cannot exceed 64 characters. For the `CidrBlock` field, you can enter any string that conforms to the CIDR format standard. Multi-Tenant network isolation rules take precedence over private network rules in the firewall. For the `Action` field, you can enter only `ACCEPT` or `DROP`. The length of the `FirewallRuleDescription` field cannot exceed 64 characters.

Parameters:

req - DeleteFirewallRulesRequest

Returns:

DeleteFirewallRulesResponse

Throws:

TencentCloudSDKException

DeleteKeyPairs

public DeleteKeyPairsResponse DeleteKeyPairs(DeleteKeyPairsRequest req)
                                      throws TencentCloudSDKException

This API is used to delete a key pair.

Parameters:: req - DeleteKeyPairsRequest
Returns:: DeleteKeyPairsResponse
Throws:: TencentCloudSDKException

DeleteSnapshots
```
public DeleteSnapshotsResponse DeleteSnapshots(DeleteSnapshotsRequest req)
                                        throws TencentCloudSDKException
```
This API is used to delete a snapshot. The snapshot must be in `NORMAL` status. To query the status of a snapshot, you can call the `DescribeSnapshots` API and see the `SnapshotState` field in the response.

Parameters:

req - DeleteSnapshotsRequest

Returns:

DeleteSnapshotsResponse

Throws:

TencentCloudSDKException

DescribeAllScenes
```
public DescribeAllScenesResponse DescribeAllScenes(DescribeAllScenesRequest req)
                                            throws TencentCloudSDKException
```
This API is used to query the list of scenes in all regions.

Parameters:

req - DescribeAllScenesRequest

Returns:

DescribeAllScenesResponse

Throws:

TencentCloudSDKException

DescribeBlueprintInstances

public DescribeBlueprintInstancesResponse DescribeBlueprintInstances(DescribeBlueprintInstancesRequest req)
                                                              throws TencentCloudSDKException

This API is used to query the information of an image instance.

Parameters:: req - DescribeBlueprintInstancesRequest
Returns:: DescribeBlueprintInstancesResponse
Throws:: TencentCloudSDKException

DescribeBlueprints
```
public DescribeBlueprintsResponse DescribeBlueprints(DescribeBlueprintsRequest req)
                                              throws TencentCloudSDKException
```
This API is used to query the information of an image.

Parameters:

req - DescribeBlueprintsRequest

Returns:

DescribeBlueprintsResponse

Throws:

TencentCloudSDKException

DescribeBundleDiscount
```
public DescribeBundleDiscountResponse DescribeBundleDiscount(DescribeBundleDiscountRequest req)
                                                      throws TencentCloudSDKException
```
This API is used to query the discount information of a package.

Parameters:

req - DescribeBundleDiscountRequest

Returns:

DescribeBundleDiscountResponse

Throws:

TencentCloudSDKException

DescribeBundles
```
public DescribeBundlesResponse DescribeBundles(DescribeBundlesRequest req)
                                        throws TencentCloudSDKException
```
This API is used to query the information of a package.

Parameters:

req - DescribeBundlesRequest

Returns:

DescribeBundlesResponse

Throws:

TencentCloudSDKException

DescribeCcnAttachedInstances
```
public DescribeCcnAttachedInstancesResponse DescribeCcnAttachedInstances(DescribeCcnAttachedInstancesRequest req)
                                                                  throws TencentCloudSDKException
```
This API is used to query the information of instances associated with CCN.

Parameters:

req - DescribeCcnAttachedInstancesRequest

Returns:

DescribeCcnAttachedInstancesResponse

Throws:

TencentCloudSDKException

DescribeDiskConfigs
```
public DescribeDiskConfigsResponse DescribeDiskConfigs(DescribeDiskConfigsRequest req)
                                                throws TencentCloudSDKException
```
This API is used to query the cloud disk configuration.

Parameters:

req - DescribeDiskConfigsRequest

Returns:

DescribeDiskConfigsResponse

Throws:

TencentCloudSDKException

DescribeDiskDiscount
```
public DescribeDiskDiscountResponse DescribeDiskDiscount(DescribeDiskDiscountRequest req)
                                                  throws TencentCloudSDKException
```
This API is used to query the discount information of a cloud disk.

Parameters:

req - DescribeDiskDiscountRequest

Returns:

DescribeDiskDiscountResponse

Throws:

TencentCloudSDKException

DescribeDisks
```
public DescribeDisksResponse DescribeDisks(DescribeDisksRequest req)
                                    throws TencentCloudSDKException
```
This API is used to query the information of one or more cloud disks.

Parameters:

req - DescribeDisksRequest

Returns:

DescribeDisksResponse

Throws:

TencentCloudSDKException

DescribeDisksDeniedActions
```
public DescribeDisksDeniedActionsResponse DescribeDisksDeniedActions(DescribeDisksDeniedActionsRequest req)
                                                              throws TencentCloudSDKException
```
This API is used to query the list of operation limits of one or more cloud disks.

Parameters:

req - DescribeDisksDeniedActionsRequest

Returns:

DescribeDisksDeniedActionsResponse

Throws:

TencentCloudSDKException

DescribeDisksReturnable
```
public DescribeDisksReturnableResponse DescribeDisksReturnable(DescribeDisksReturnableRequest req)
                                                        throws TencentCloudSDKException
```
This API is used to query whether the specified cloud disk can be returned.

Parameters:

req - DescribeDisksReturnableRequest

Returns:

DescribeDisksReturnableResponse

Throws:

TencentCloudSDKException

DescribeFirewallRules
```
public DescribeFirewallRulesResponse DescribeFirewallRules(DescribeFirewallRulesRequest req)
                                                    throws TencentCloudSDKException
```
This API is used to query the firewall rules of an instance.

Parameters:

req - DescribeFirewallRulesRequest

Returns:

DescribeFirewallRulesResponse

Throws:

TencentCloudSDKException

DescribeFirewallRulesTemplate

public DescribeFirewallRulesTemplateResponse DescribeFirewallRulesTemplate(DescribeFirewallRulesTemplateRequest req)
                                                                    throws TencentCloudSDKException

This API is used to query a firewall rule template.

Parameters:: req - DescribeFirewallRulesTemplateRequest
Returns:: DescribeFirewallRulesTemplateResponse
Throws:: TencentCloudSDKException

DescribeGeneralResourceQuotas

public DescribeGeneralResourceQuotasResponse DescribeGeneralResourceQuotas(DescribeGeneralResourceQuotasRequest req)
                                                                    throws TencentCloudSDKException

This API is used to query the quota information of general resources.

Parameters:: req - DescribeGeneralResourceQuotasRequest
Returns:: DescribeGeneralResourceQuotasResponse
Throws:: TencentCloudSDKException

DescribeInstanceLoginKeyPairAttribute

public DescribeInstanceLoginKeyPairAttributeResponse DescribeInstanceLoginKeyPairAttribute(DescribeInstanceLoginKeyPairAttributeRequest req)
                                                                                    throws TencentCloudSDKException

This API is used to query the attributes of the default login key of an instance.

Parameters:: req - DescribeInstanceLoginKeyPairAttributeRequest
Returns:: DescribeInstanceLoginKeyPairAttributeResponse
Throws:: TencentCloudSDKException

DescribeInstanceVncUrl
```
public DescribeInstanceVncUrlResponse DescribeInstanceVncUrl(DescribeInstanceVncUrlRequest req)
                                                      throws TencentCloudSDKException
```
This API is used to query the URL for VNC login. It does not support `STOPPED` CVMs. A VNC URL is only valid for 15 seconds. If you do not access the URL within 15 seconds, you will need to query another one. The VNC URL can be used once only. You need to query a new one if you want to log in again. Up to 30 re-connection attempts allowed in one minute. `InstanceVncUrl`: Its value will be returned after the API is successfully called. After you get the value of `InstanceVncUrl`, you need to append `InstanceVncUrl=xxxx` to the end of the link `https://img.qcloud.com/qcloud/app/active_vnc/index.html?`. The final URL can be in the following formats: ``` https://img.qcloud.com/qcloud/app/active_vnc/index.html?InstanceVncUrl=wss%3A%2F%2Fbjvnc.qcloud.com%3A26789%2Fvnc%3Fs%3DaHpjWnRVMFNhYmxKdDM5MjRHNlVTSVQwajNUSW0wb2tBbmFtREFCTmFrcy8vUUNPMG0wSHZNOUUxRm5PMmUzWmFDcWlOdDJIbUJxSTZDL0RXcHZxYnZZMmRkWWZWcEZia2lyb09XMzdKNmM9 ```

Parameters:

req - DescribeInstanceVncUrlRequest

Returns:

DescribeInstanceVncUrlResponse

Throws:

TencentCloudSDKException

DescribeInstances
```
public DescribeInstancesResponse DescribeInstances(DescribeInstancesRequest req)
                                            throws TencentCloudSDKException
```
This API is used to query the details of one or multiple instances. You can query the details of an instance according to its ID, name, or private IP. For more information on filters, please see [Filters](https://intl.cloud.tencent.com/document/product/1207/47576?from_cn_redirect=1#Filter). 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. The latest operation (LatestOperation) and the latest operation status (LatestOperationState) of the instance can be queried.

Parameters:

req - DescribeInstancesRequest

Returns:

DescribeInstancesResponse

Throws:

TencentCloudSDKException

DescribeInstancesDeniedActions
```
public DescribeInstancesDeniedActionsResponse DescribeInstancesDeniedActions(DescribeInstancesDeniedActionsRequest req)
                                                                      throws TencentCloudSDKException
```
This API is used to query the list of operation limits of one or more instances.

Parameters:

req - DescribeInstancesDeniedActionsRequest

Returns:

DescribeInstancesDeniedActionsResponse

Throws:

TencentCloudSDKException

DescribeInstancesDiskNum
```
public DescribeInstancesDiskNumResponse DescribeInstancesDiskNum(DescribeInstancesDiskNumRequest req)
                                                          throws TencentCloudSDKException
```
This API is used to query the number of cloud disks attached to instances.

Parameters:

req - DescribeInstancesDiskNumRequest

Returns:

DescribeInstancesDiskNumResponse

Throws:

TencentCloudSDKException

DescribeInstancesReturnable
```
public DescribeInstancesReturnableResponse DescribeInstancesReturnable(DescribeInstancesReturnableRequest req)
                                                                throws TencentCloudSDKException
```
This API is used to query whether the specified instance can be returned.

Parameters:

req - DescribeInstancesReturnableRequest

Returns:

DescribeInstancesReturnableResponse

Throws:

TencentCloudSDKException

DescribeInstancesTrafficPackages
```
public DescribeInstancesTrafficPackagesResponse DescribeInstancesTrafficPackages(DescribeInstancesTrafficPackagesRequest req)
                                                                          throws TencentCloudSDKException
```
This API is used to query the traffic package details of one or more instances.

Parameters:

req - DescribeInstancesTrafficPackagesRequest

Returns:

DescribeInstancesTrafficPackagesResponse

Throws:

TencentCloudSDKException

DescribeKeyPairs

public DescribeKeyPairsResponse DescribeKeyPairs(DescribeKeyPairsRequest req)
                                          throws TencentCloudSDKException

This API is used to query key pairs.

Parameters:: req - DescribeKeyPairsRequest
Returns:: DescribeKeyPairsResponse
Throws:: TencentCloudSDKException

DescribeModifyInstanceBundles

public DescribeModifyInstanceBundlesResponse DescribeModifyInstanceBundles(DescribeModifyInstanceBundlesRequest req)
                                                                    throws TencentCloudSDKException

This API is used to query the list of package options of an instance.

Parameters:: req - DescribeModifyInstanceBundlesRequest
Returns:: DescribeModifyInstanceBundlesResponse
Throws:: TencentCloudSDKException

DescribeRegions
```
public DescribeRegionsResponse DescribeRegions(DescribeRegionsRequest req)
                                        throws TencentCloudSDKException
```
This API is used to query the information of regions.

Parameters:

req - DescribeRegionsRequest

Returns:

DescribeRegionsResponse

Throws:

TencentCloudSDKException

DescribeResetInstanceBlueprints

public DescribeResetInstanceBlueprintsResponse DescribeResetInstanceBlueprints(DescribeResetInstanceBlueprintsRequest req)
                                                                        throws TencentCloudSDKException

This API is used to query the image information of a reset instance.

Parameters:: req - DescribeResetInstanceBlueprintsRequest
Returns:: DescribeResetInstanceBlueprintsResponse
Throws:: TencentCloudSDKException

DescribeScenes
```
public DescribeScenesResponse DescribeScenes(DescribeScenesRequest req)
                                      throws TencentCloudSDKException
```
This API is used to query the list of scenes.

Parameters:

req - DescribeScenesRequest

Returns:

DescribeScenesResponse

Throws:

TencentCloudSDKException

DescribeSnapshots
```
public DescribeSnapshotsResponse DescribeSnapshots(DescribeSnapshotsRequest req)
                                            throws TencentCloudSDKException
```
This API is used to query the list of snapshots.

Parameters:

req - DescribeSnapshotsRequest

Returns:

DescribeSnapshotsResponse

Throws:

TencentCloudSDKException

DescribeSnapshotsDeniedActions
```
public DescribeSnapshotsDeniedActionsResponse DescribeSnapshotsDeniedActions(DescribeSnapshotsDeniedActionsRequest req)
                                                                      throws TencentCloudSDKException
```
This API is used to query the list of operation limits of one or more snapshots.

Parameters:

req - DescribeSnapshotsDeniedActionsRequest

Returns:

DescribeSnapshotsDeniedActionsResponse

Throws:

TencentCloudSDKException

DescribeZones
```
public DescribeZonesResponse DescribeZones(DescribeZonesRequest req)
                                    throws TencentCloudSDKException
```
This API is used to query the list of AZs in a region.

Parameters:

req - DescribeZonesRequest

Returns:

DescribeZonesResponse

Throws:

TencentCloudSDKException

DetachCcn
```
public DetachCcnResponse DetachCcn(DetachCcnRequest req)
                            throws TencentCloudSDKException
```
This API is used to unassociate a CCN instance.

Parameters:

req - DetachCcnRequest

Returns:

DetachCcnResponse

Throws:

TencentCloudSDKException

DetachDisks
```
public DetachDisksResponse DetachDisks(DetachDisksRequest req)
                                throws TencentCloudSDKException
```
This API is used to detach one or more cloud disks.

Parameters:

req - DetachDisksRequest

Returns:

DetachDisksResponse

Throws:

TencentCloudSDKException

DisassociateInstancesKeyPairs
```
public DisassociateInstancesKeyPairsResponse DisassociateInstancesKeyPairs(DisassociateInstancesKeyPairsRequest req)
                                                                    throws TencentCloudSDKException
```
This API is used to unbind an instance from the specified key pair. Only instances on LINUX_UNIX in [RUNNING, STOPPED] status are supported. Instances in `RUNNING` status will be forcibly shut down before unbinding. After a key pair is unassociated from an instance, you can log in to the instance with password. If no password was set, you cannot log in to the instance with SSH after unbinding. You can call the ResetInstancesPassword API to set a login password. Batch operations are supported. The maximum number of instances in each request is 100. This API is async. After the request is sent successfully, a `RequestId` will be returned. At this time, the operation is not completed immediately. The result of the instance operation can be queried by calling the `DescribeInstances` API. If the latest operation status (LatestOperationState) of the instance is `SUCCESS`, the operation is successful.

Parameters:

req - DisassociateInstancesKeyPairsRequest

Returns:

DisassociateInstancesKeyPairsResponse

Throws:

TencentCloudSDKException

ImportKeyPair
```
public ImportKeyPairResponse ImportKeyPair(ImportKeyPairRequest req)
                                    throws TencentCloudSDKException
```
This API is used to import the specified key pair.

Parameters:

req - ImportKeyPairRequest

Returns:

ImportKeyPairResponse

Throws:

TencentCloudSDKException

InquirePriceCreateBlueprint

public InquirePriceCreateBlueprintResponse InquirePriceCreateBlueprint(InquirePriceCreateBlueprintRequest req)
                                                                throws TencentCloudSDKException

This API is used to query the price of a created image.

Parameters:: req - InquirePriceCreateBlueprintRequest
Returns:: InquirePriceCreateBlueprintResponse
Throws:: TencentCloudSDKException

InquirePriceCreateDisks
```
public InquirePriceCreateDisksResponse InquirePriceCreateDisks(InquirePriceCreateDisksRequest req)
                                                        throws TencentCloudSDKException
```
This API is used to query the price of purchasing cloud disks.

Parameters:

req - InquirePriceCreateDisksRequest

Returns:

InquirePriceCreateDisksResponse

Throws:

TencentCloudSDKException

InquirePriceCreateInstances

public InquirePriceCreateInstancesResponse InquirePriceCreateInstances(InquirePriceCreateInstancesRequest req)
                                                                throws TencentCloudSDKException

This API is used to query the price of a created instance.

Parameters:: req - InquirePriceCreateInstancesRequest
Returns:: InquirePriceCreateInstancesResponse
Throws:: TencentCloudSDKException

InquirePriceRenewDisks
```
public InquirePriceRenewDisksResponse InquirePriceRenewDisks(InquirePriceRenewDisksRequest req)
                                                      throws TencentCloudSDKException
```
This API is used to query the price of renewing cloud disks.

Parameters:

req - InquirePriceRenewDisksRequest

Returns:

InquirePriceRenewDisksResponse

Throws:

TencentCloudSDKException

InquirePriceRenewInstances
```
public InquirePriceRenewInstancesResponse InquirePriceRenewInstances(InquirePriceRenewInstancesRequest req)
                                                              throws TencentCloudSDKException
```
This API is used to query the price of renewing one or more instances.

Parameters:

req - InquirePriceRenewInstancesRequest

Returns:

InquirePriceRenewInstancesResponse

Throws:

TencentCloudSDKException

ModifyBlueprintAttribute

public ModifyBlueprintAttributeResponse ModifyBlueprintAttribute(ModifyBlueprintAttributeRequest req)
                                                          throws TencentCloudSDKException

This API is used to modify an image attribute.

Parameters:: req - ModifyBlueprintAttributeRequest
Returns:: ModifyBlueprintAttributeResponse
Throws:: TencentCloudSDKException

ModifyDisksAttribute

public ModifyDisksAttributeResponse ModifyDisksAttribute(ModifyDisksAttributeRequest req)
                                                  throws TencentCloudSDKException

This API is used to modify cloud disk attributes.

Parameters:: req - ModifyDisksAttributeRequest
Returns:: ModifyDisksAttributeResponse
Throws:: TencentCloudSDKException

ModifyDisksRenewFlag
```
public ModifyDisksRenewFlagResponse ModifyDisksRenewFlag(ModifyDisksRenewFlagRequest req)
                                                  throws TencentCloudSDKException
```
This API is used to modify the configuration of auto-renewal of cloud disks.

Parameters:

req - ModifyDisksRenewFlagRequest

Returns:

ModifyDisksRenewFlagResponse

Throws:

TencentCloudSDKException

ModifyFirewallRuleDescription
```
public ModifyFirewallRuleDescriptionResponse ModifyFirewallRuleDescription(ModifyFirewallRuleDescriptionRequest req)
                                                                    throws TencentCloudSDKException
```
This API is used to modify the description of a single firewall rule. `FirewallVersion` is used to specify the version of the firewall to be manipulated. If the `FirewallVersion` value passed in is not equal to the current latest version of the firewall, a failure will be returned. If `FirewallVersion` is not passed in, the description of the specified rule will be modified directly. In the `FirewallRule` parameter: Valid values of the `Protocol` field include `TCP`, `UDP`, `ICMP`, and `ALL`. For the `Port` field, you can enter only `ALL`, a single port number, several port numbers separated by commas, or a port range indicated by two port numbers separated by a minus sign. If `Port` is a range, the port number on the left of the minus sign must be smaller than the one on the right. If `Protocol` is not `TCP` or `UDP`, `Port` can only be empty or `ALL`. The length of the `Port` field cannot exceed 64 characters. For the `CidrBlock` field, you can enter any string that conforms to the CIDR format standard. Multi-Tenant network isolation rules take precedence over private network rules in the firewall. For the `Action` field, you can enter only `ACCEPT` or `DROP`. The length of the `FirewallRuleDescription` field cannot exceed 64 characters.

Parameters:

req - ModifyFirewallRuleDescriptionRequest

Returns:

ModifyFirewallRuleDescriptionResponse

Throws:

TencentCloudSDKException

ModifyFirewallRules
```
public ModifyFirewallRulesResponse ModifyFirewallRules(ModifyFirewallRulesRequest req)
                                                throws TencentCloudSDKException
```
This API is used to reset the firewall rules of an instance. This API deletes all firewall rules of the current instance first and then adds new rules. `FirewallVersion` is used to specify the version of the firewall to be manipulated. If the `FirewallVersion` value passed in is not equal to the current latest version of the firewall, a failure will be returned. If `FirewallVersion` is not passed in, the specified rule will be reset directly. In the `FirewallRules` parameter: Valid values of the `Protocol` field include `TCP`, `UDP`, `ICMP`, and `ALL`. For the `Port` field, you can enter only `ALL`, a single port number, several port numbers separated by commas, or a port range indicated by two port numbers separated by a minus sign. If `Port` is a range, the port number on the left of the minus sign must be smaller than the one on the right. If `Protocol` is not `TCP` or `UDP`, `Port` can only be empty or `ALL`. The length of the `Port` field cannot exceed 64 characters. For the `CidrBlock` field, you can enter any string that conforms to the CIDR format standard. Multi-Tenant network isolation rules take precedence over private network rules in the firewall. For the `Action` field, you can enter only `ACCEPT` or `DROP`. The length of the `FirewallRuleDescription` field cannot exceed 64 characters.

Parameters:

req - ModifyFirewallRulesRequest

Returns:

ModifyFirewallRulesResponse

Throws:

TencentCloudSDKException

ModifyInstancesAttribute
```
public ModifyInstancesAttributeResponse ModifyInstancesAttribute(ModifyInstancesAttributeRequest req)
                                                          throws TencentCloudSDKException
```
This API is used to modify the attributes of instances. The instance name is used only for users’ convenience. Batch operations are supported. Each request can contain up to 100 instances at a time. This API is async. A successful request will return a `RequestId`, it does not mean the operation is completed. You can call the `DescribeInstances` API to query the operation result. If the latest operation status (LatestOperationState) of the instance is `SUCCESS`, the operation is successful.

Parameters:

req - ModifyInstancesAttributeRequest

Returns:

ModifyInstancesAttributeResponse

Throws:

TencentCloudSDKException

ModifyInstancesLoginKeyPairAttribute
```
public ModifyInstancesLoginKeyPairAttributeResponse ModifyInstancesLoginKeyPairAttribute(ModifyInstancesLoginKeyPairAttributeRequest req)
                                                                                  throws TencentCloudSDKException
```
This API is used to set the attributes of the default login key pair of an instance.

Parameters:

req - ModifyInstancesLoginKeyPairAttributeRequest

Returns:

ModifyInstancesLoginKeyPairAttributeResponse

Throws:

TencentCloudSDKException

ModifyInstancesRenewFlag
```
public ModifyInstancesRenewFlagResponse ModifyInstancesRenewFlag(ModifyInstancesRenewFlagRequest req)
                                                          throws TencentCloudSDKException
```
This API is used to modify the renewal flags of monthly subscribed instances. Instances marked with "auto-renewal" will be automatically renewed for one month when they expire. Batch operations are supported. The maximum number of instances in each request is 100. The result of the instance operation can be queried by calling the `DescribeInstances` API. If the latest operation status (LatestOperationState) of the instance is `SUCCESS`, the operation is successful.

Parameters:

req - ModifyInstancesRenewFlagRequest

Returns:

ModifyInstancesRenewFlagResponse

Throws:

TencentCloudSDKException

ModifySnapshotAttribute

public ModifySnapshotAttributeResponse ModifySnapshotAttribute(ModifySnapshotAttributeRequest req)
                                                        throws TencentCloudSDKException

This API is used to modify the attributes of a snapshot.

The snapshot name is used only for users’ convenience.

Class LighthouseClient

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

LighthouseClient

LighthouseClient

Method Detail

ApplyInstanceSnapshot

AssociateInstancesKeyPairs

AttachCcn

AttachDisks

CreateBlueprint

CreateFirewallRules

CreateInstanceSnapshot

CreateInstances

CreateKeyPair

DeleteBlueprints

DeleteFirewallRules

DeleteKeyPairs

DeleteSnapshots

DescribeAllScenes

DescribeBlueprintInstances

DescribeBlueprints

DescribeBundleDiscount

DescribeBundles

DescribeCcnAttachedInstances

DescribeDiskConfigs

DescribeDiskDiscount

DescribeDisks

DescribeDisksDeniedActions

DescribeDisksReturnable

DescribeFirewallRules

DescribeFirewallRulesTemplate

DescribeGeneralResourceQuotas

DescribeInstanceLoginKeyPairAttribute

DescribeInstanceVncUrl

DescribeInstances

DescribeInstancesDeniedActions

DescribeInstancesDiskNum

DescribeInstancesReturnable

DescribeInstancesTrafficPackages

DescribeKeyPairs

DescribeModifyInstanceBundles

DescribeRegions

DescribeResetInstanceBlueprints

DescribeScenes

DescribeSnapshots

DescribeSnapshotsDeniedActions

DescribeZones

DetachCcn

DetachDisks

DisassociateInstancesKeyPairs

ImportKeyPair

InquirePriceCreateBlueprint

InquirePriceCreateDisks

InquirePriceCreateInstances

InquirePriceRenewDisks

InquirePriceRenewInstances

ModifyBlueprintAttribute

ModifyDisksAttribute

ModifyDisksRenewFlag

ModifyFirewallRuleDescription

ModifyFirewallRules

ModifyInstancesAttribute

ModifyInstancesLoginKeyPairAttribute

ModifyInstancesRenewFlag

ModifySnapshotAttribute

RebootInstances

ResetAttachCcn

ResetInstance

ResetInstancesPassword

StartInstances

StopInstances

TerminateDisks

TerminateInstances