LighthouseClient (tencentcloud-sdk-java 3.1.136 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
`CreateFirewallRulesResponse`	`CreateFirewallRules(CreateFirewallRulesRequest req)` 本接口（CreateFirewallRules）用于在实例上添加防火墙规则。 Protocol 字段支持输入 TCP，UDP，或 ALL。 Port 字段允许输入 ALL，或者一个单独的端口号，或者用逗号分隔的离散端口号，或者用减号分隔的两个端口号代表的端口范围。当 Port 为范围时，减号分隔的第一个端口号小于第二个端口号。当 Protocol 字段不是 TCP 或 UDP 时，Port 字段只能为空或 ALL。Port 字段长度不得超过 64。
`DeleteFirewallRulesResponse`	`DeleteFirewallRules(DeleteFirewallRulesRequest req)` 本接口（DeleteFirewallRules）用于删除实例的防火墙规则。 Protocol 字段支持输入 TCP，UDP，或 ALL。 Port 字段允许输入 ALL，或者一个单独的端口号，或者用逗号分隔的离散端口号，或者用减号分隔的两个端口号代表的端口范围。当 Port 为范围时，减号分隔的第一个端口号小于第二个端口号。当 Protocol 字段不是 TCP 或 UDP 时，Port 字段只能为空或 ALL。Port 字段长度不得超过 64。
`DescribeBlueprintsResponse`	`DescribeBlueprints(DescribeBlueprintsRequest req)` 本接口（DescribeBlueprints）用于查询镜像信息。
`DescribeBundlesResponse`	`DescribeBundles(DescribeBundlesRequest req)` 本接口（DescribeBundles）用于查询套餐信息。
`DescribeFirewallRulesResponse`	`DescribeFirewallRules(DescribeFirewallRulesRequest req)` 本接口（DescribeFirewallRules）用于查询实例的防火墙规则。
`DescribeInstancesResponse`	`DescribeInstances(DescribeInstancesRequest req)` 本接口（DescribeInstances）用于查询一个或多个实例的详细信息。可以根据实例 ID、实例名称或者实例的内网 IP 查询实例的详细信息。过滤信息详细请见过滤器 [Filters](https://cloud.tencent.com/document/product/1207/47576#Filter) 。如果参数为空，返回当前用户一定数量（Limit 所指定的数量，默认为 20）的实例。支持查询实例的最新操作（LatestOperation）以及最新操作状态（LatestOperationState）。
`RebootInstancesResponse`	`RebootInstances(RebootInstancesRequest req)` 本接口（RebootInstances）用于重启实例。只有状态为 RUNNING 的实例才可以进行此操作。接口调用成功时，实例会进入 REBOOTING 状态；重启实例成功时，实例会进入 RUNNING 状态。支持批量操作，每次请求批量实例的上限为 100。本接口为异步接口，请求发送成功后会返回一个 RequestId，此时操作并未立即完成。实例操作结果可以通过调用 DescribeInstances 接口查询，如果实例的最新操作状态（LatestOperationState）为“SUCCESS”，则代表操作成功。
`ResetInstanceResponse`	`ResetInstance(ResetInstanceRequest req)` 本接口（ResetInstance）用于重装指定实例上的镜像。如果指定了 BlueprintId 参数，则使用指定的镜像重装；否则按照当前实例使用的镜像进行重装。系统盘将会被格式化，并重置；请确保系统盘中无重要文件。目前不支持实例使用该接口实现 LINUX_UNIX 和 WINDOWS 操作系统切换。本接口为异步接口，请求发送成功后会返回一个 RequestId，此时操作并未立即完成。实例操作结果可以通过调用 DescribeInstances 接口查询，如果实例的最新操作状态（LatestOperationState）为“SUCCESS”，则代表操作成功。
`StartInstancesResponse`	`StartInstances(StartInstancesRequest req)` 本接口（StartInstances）用于启动一个或多个实例。只有状态为 STOPPED 的实例才可以进行此操作。接口调用成功时，实例会进入 STARTING 状态；启动实例成功时，实例会进入 RUNNING 状态。支持批量操作。每次请求批量实例的上限为 100。本接口为异步接口，请求发送成功后会返回一个 RequestId，此时操作并未立即完成。实例操作结果可以通过调用 DescribeInstances 接口查询，如果实例的最新操作状态（LatestOperationState）为“SUCCESS”，则代表操作成功。
`StopInstancesResponse`	`StopInstances(StopInstancesRequest req)` 本接口（StopInstances）用于关闭一个或多个实例。只有状态为 RUNNING 的实例才可以进行此操作。接口调用成功时，实例会进入 STOPPING 状态；关闭实例成功时，实例会进入 STOPPED 状态。支持批量操作。每次请求批量实例的上限为 100。本接口为异步接口，请求发送成功后会返回一个 RequestId，此时操作并未立即完成。实例操作结果可以通过调用 DescribeInstances 接口查询，如果实例的最新操作状态（LatestOperationState）为“SUCCESS”，则代表操作成功。

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
  - CreateFirewallRules
```
public CreateFirewallRulesResponse CreateFirewallRules(CreateFirewallRulesRequest req)
                                                throws TencentCloudSDKException
```
    本接口（CreateFirewallRules）用于在实例上添加防火墙规则。 Protocol 字段支持输入 TCP，UDP，或 ALL。 Port 字段允许输入 ALL，或者一个单独的端口号，或者用逗号分隔的离散端口号，或者用减号分隔的两个端口号代表的端口范围。当 Port 为范围时，减号分隔的第一个端口号小于第二个端口号。当 Protocol 字段不是 TCP 或 UDP 时，Port 字段只能为空或 ALL。Port 字段长度不得超过 64。
    
    Parameters:
    
    req - CreateFirewallRulesRequest
    
    Returns:
    
    CreateFirewallRulesResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteFirewallRules
```
public DeleteFirewallRulesResponse DeleteFirewallRules(DeleteFirewallRulesRequest req)
                                                throws TencentCloudSDKException
```
    本接口（DeleteFirewallRules）用于删除实例的防火墙规则。 Protocol 字段支持输入 TCP，UDP，或 ALL。 Port 字段允许输入 ALL，或者一个单独的端口号，或者用逗号分隔的离散端口号，或者用减号分隔的两个端口号代表的端口范围。当 Port 为范围时，减号分隔的第一个端口号小于第二个端口号。当 Protocol 字段不是 TCP 或 UDP 时，Port 字段只能为空或 ALL。Port 字段长度不得超过 64。
    
    Parameters:
    
    req - DeleteFirewallRulesRequest
    
    Returns:
    
    DeleteFirewallRulesResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeBlueprints
```
public DescribeBlueprintsResponse DescribeBlueprints(DescribeBlueprintsRequest req)
                                              throws TencentCloudSDKException
```
    本接口（DescribeBlueprints）用于查询镜像信息。
    
    Parameters:
    
    req - DescribeBlueprintsRequest
    
    Returns:
    
    DescribeBlueprintsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeBundles
```
public DescribeBundlesResponse DescribeBundles(DescribeBundlesRequest req)
                                        throws TencentCloudSDKException
```
    本接口（DescribeBundles）用于查询套餐信息。
    
    Parameters:
    
    req - DescribeBundlesRequest
    
    Returns:
    
    DescribeBundlesResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeFirewallRules
```
public DescribeFirewallRulesResponse DescribeFirewallRules(DescribeFirewallRulesRequest req)
                                                    throws TencentCloudSDKException
```
    本接口（DescribeFirewallRules）用于查询实例的防火墙规则。
    
    Parameters:
    
    req - DescribeFirewallRulesRequest
    
    Returns:
    
    DescribeFirewallRulesResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeInstances
```
public DescribeInstancesResponse DescribeInstances(DescribeInstancesRequest req)
                                            throws TencentCloudSDKException
```
    本接口（DescribeInstances）用于查询一个或多个实例的详细信息。可以根据实例 ID、实例名称或者实例的内网 IP 查询实例的详细信息。过滤信息详细请见过滤器 [Filters](https://cloud.tencent.com/document/product/1207/47576#Filter) 。如果参数为空，返回当前用户一定数量（Limit 所指定的数量，默认为 20）的实例。支持查询实例的最新操作（LatestOperation）以及最新操作状态（LatestOperationState）。
    
    Parameters:
    
    req - DescribeInstancesRequest
    
    Returns:
    
    DescribeInstancesResponse
    
    Throws:
    
    TencentCloudSDKException
  - RebootInstances
```
public RebootInstancesResponse RebootInstances(RebootInstancesRequest req)
                                        throws TencentCloudSDKException
```
    本接口（RebootInstances）用于重启实例。只有状态为 RUNNING 的实例才可以进行此操作。接口调用成功时，实例会进入 REBOOTING 状态；重启实例成功时，实例会进入 RUNNING 状态。支持批量操作，每次请求批量实例的上限为 100。本接口为异步接口，请求发送成功后会返回一个 RequestId，此时操作并未立即完成。实例操作结果可以通过调用 DescribeInstances 接口查询，如果实例的最新操作状态（LatestOperationState）为“SUCCESS”，则代表操作成功。
    
    Parameters:
    
    req - RebootInstancesRequest
    
    Returns:
    
    RebootInstancesResponse
    
    Throws:
    
    TencentCloudSDKException
  - ResetInstance
```
public ResetInstanceResponse ResetInstance(ResetInstanceRequest req)
                                    throws TencentCloudSDKException
```
    本接口（ResetInstance）用于重装指定实例上的镜像。如果指定了 BlueprintId 参数，则使用指定的镜像重装；否则按照当前实例使用的镜像进行重装。系统盘将会被格式化，并重置；请确保系统盘中无重要文件。目前不支持实例使用该接口实现 LINUX_UNIX 和 WINDOWS 操作系统切换。本接口为异步接口，请求发送成功后会返回一个 RequestId，此时操作并未立即完成。实例操作结果可以通过调用 DescribeInstances 接口查询，如果实例的最新操作状态（LatestOperationState）为“SUCCESS”，则代表操作成功。
    
    Parameters:
    
    req - ResetInstanceRequest
    
    Returns:
    
    ResetInstanceResponse
    
    Throws:
    
    TencentCloudSDKException
  - StartInstances
```
public StartInstancesResponse StartInstances(StartInstancesRequest req)
                                      throws TencentCloudSDKException
```
    本接口（StartInstances）用于启动一个或多个实例。只有状态为 STOPPED 的实例才可以进行此操作。接口调用成功时，实例会进入 STARTING 状态；启动实例成功时，实例会进入 RUNNING 状态。支持批量操作。每次请求批量实例的上限为 100。本接口为异步接口，请求发送成功后会返回一个 RequestId，此时操作并未立即完成。实例操作结果可以通过调用 DescribeInstances 接口查询，如果实例的最新操作状态（LatestOperationState）为“SUCCESS”，则代表操作成功。
    
    Parameters:
    
    req - StartInstancesRequest
    
    Returns:
    
    StartInstancesResponse
    
    Throws:
    
    TencentCloudSDKException
  - StopInstances
```
public StopInstancesResponse StopInstances(StopInstancesRequest req)
                                    throws TencentCloudSDKException
```
    本接口（StopInstances）用于关闭一个或多个实例。只有状态为 RUNNING 的实例才可以进行此操作。接口调用成功时，实例会进入 STOPPING 状态；关闭实例成功时，实例会进入 STOPPED 状态。支持批量操作。每次请求批量实例的上限为 100。本接口为异步接口，请求发送成功后会返回一个 RequestId，此时操作并未立即完成。实例操作结果可以通过调用 DescribeInstances 接口查询，如果实例的最新操作状态（LatestOperationState）为“SUCCESS”，则代表操作成功。
    
    Parameters:
    
    req - StopInstancesRequest
    
    Returns:
    
    StopInstancesResponse
    
    Throws:
    
    TencentCloudSDKException

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

CreateFirewallRules

DeleteFirewallRules

DescribeBlueprints

DescribeBundles

DescribeFirewallRules

DescribeInstances

RebootInstances

ResetInstance

StartInstances

StopInstances