LighthouseClient (tencentcloud-sdk-java 3.1.353 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)` 本接口（ApplyInstanceSnapshot）用于回滚指定实例的系统盘快照。仅支持回滚到原系统盘。用于回滚的快照必须处于 NORMAL 状态。快照状态可以通 DescribeSnapshots 接口查询，见输出参数中 SnapshotState 字段解释。回滚快照时，实例的状态必须为 STOPPED 或 RUNNING，可通过 DescribeInstances 接口查询实例状态。处于 RUNNING 状态的实例会强制关机，然后回滚快照。
`AssociateInstancesKeyPairsResponse`	`AssociateInstancesKeyPairs(AssociateInstancesKeyPairsRequest req)` 本接口（AssociateInstancesKeyPairs）用于绑定用户指定密钥对到实例。只支持 [RUNNING, STOPPED] 状态的 LINUX_UNIX 操作系统的实例。处于 RUNNING 状态的实例会强制关机，然后绑定。将密钥的公钥写入到实例的 SSH 配置当中，用户就可以通过该密钥的私钥来登录实例。如果实例原来绑定过密钥，那么原来的密钥将失效。如果实例原来是通过密码登录，绑定密钥后无法使用密码登录。支持批量操作。每次请求批量实例的上限为 100。如果批量实例存在不允许操作的实例，操作会以特定错误码返回。本接口为异步接口，请求发送成功后会返回一个 RequestId，此时操作并未立即完成。实例操作结果可以通过调用 DescribeInstances 接口查询，如果实例的最新操作状态（LatestOperationState）为“SUCCESS”，则代表操作成功。
`AttachCcnResponse`	`AttachCcn(AttachCcnRequest req)` 本接口 (AttachCcn) 用于建立与云联网的关联。
`CreateBlueprintResponse`	`CreateBlueprint(CreateBlueprintRequest req)` 本接口 (CreateBlueprint) 用于创建镜像。
`CreateFirewallRulesResponse`	`CreateFirewallRules(CreateFirewallRulesRequest req)` 本接口（CreateFirewallRules）用于在实例上添加防火墙规则。 FirewallVersion 为防火墙版本号，用户每次更新防火墙规则版本会自动加1，防止您更新的规则已过期，不填不考虑冲突。在 FirewallRules 参数中： Protocol 字段支持输入 TCP，UDP，ICMP，ALL。 Port 字段允许输入 ALL，或者一个单独的端口号，或者用逗号分隔的离散端口号，或者用减号分隔的两个端口号代表的端口范围。当 Port 为范围时，减号分隔的第一个端口号小于第二个端口号。当 Protocol 字段不是 TCP 或 UDP 时，Port 字段只能为空或 ALL。Port 字段长度不得超过 64。 CidrBlock 字段允许输入符合 cidr 格式标准的任意字符串。租户之间网络隔离规则优先于防火墙中的内网规则。 Action 字段只允许输入 ACCEPT 或 DROP。 FirewallRuleDescription 字段长度不得超过 64。
`CreateInstanceSnapshotResponse`	`CreateInstanceSnapshot(CreateInstanceSnapshotRequest req)` 本接口（CreateInstanceSnapshot）用于创建指定实例的系统盘快照。
`CreateKeyPairResponse`	`CreateKeyPair(CreateKeyPairRequest req)` 本接口（CreateKeyPair）用于创建一个密钥对。
`DeleteBlueprintsResponse`	`DeleteBlueprints(DeleteBlueprintsRequest req)` 本接口 (DeleteBlueprints) 用于删除镜像。
`DeleteFirewallRulesResponse`	`DeleteFirewallRules(DeleteFirewallRulesRequest req)` 本接口（DeleteFirewallRules）用于删除实例的防火墙规则。 FirewallVersion 用于指定要操作的防火墙的版本。传入 FirewallVersion 版本号若不等于当前防火墙的最新版本，将返回失败；若不传 FirewallVersion 则直接删除指定的规则。在 FirewallRules 参数中： Protocol 字段支持输入 TCP，UDP，ICMP，ALL。 Port 字段允许输入 ALL，或者一个单独的端口号，或者用逗号分隔的离散端口号，或者用减号分隔的两个端口号代表的端口范围。当 Port 为范围时，减号分隔的第一个端口号小于第二个端口号。当 Protocol 字段不是 TCP 或 UDP 时，Port 字段只能为空或 ALL。Port 字段长度不得超过 64。 CidrBlock 字段允许输入符合 cidr 格式标准的任意字符串。租户之间网络隔离规则优先于防火墙中的内网规则。 Action 字段只允许输入 ACCEPT 或 DROP。 FirewallRuleDescription 字段长度不得超过 64。
`DeleteKeyPairsResponse`	`DeleteKeyPairs(DeleteKeyPairsRequest req)` 本接口（DeleteKeyPairs）用于删除密钥对。
`DeleteSnapshotsResponse`	`DeleteSnapshots(DeleteSnapshotsRequest req)` 本接口（DeleteSnapshots）用于删除快照。快照必须处于 NORMAL 状态，快照状态可以通过 DescribeSnapshots 接口查询，见输出参数中 SnapshotState 字段解释。
`DescribeBlueprintInstancesResponse`	`DescribeBlueprintInstances(DescribeBlueprintInstancesRequest req)` 本接口（DescribeBlueprintInstances）用于查询镜像实例信息。
`DescribeBlueprintsResponse`	`DescribeBlueprints(DescribeBlueprintsRequest req)` 本接口（DescribeBlueprints）用于查询镜像信息。
`DescribeBundleDiscountResponse`	`DescribeBundleDiscount(DescribeBundleDiscountRequest req)` 本接口（DescribeBundleDiscount）用于查询套餐折扣信息。
`DescribeBundlesResponse`	`DescribeBundles(DescribeBundlesRequest req)` 本接口（DescribeBundles）用于查询套餐信息。
`DescribeCcnAttachedInstancesResponse`	`DescribeCcnAttachedInstances(DescribeCcnAttachedInstancesRequest req)` 本接口 (DescribeCcnAttachedInstances) 用于查询云联网关联的实例信息。
`DescribeFirewallRulesResponse`	`DescribeFirewallRules(DescribeFirewallRulesRequest req)` 本接口（DescribeFirewallRules）用于查询实例的防火墙规则。
`DescribeFirewallRulesTemplateResponse`	`DescribeFirewallRulesTemplate(DescribeFirewallRulesTemplateRequest req)` 本接口（DescribeFirewallRulesTemplate）用于查询防火墙规则模版。
`DescribeGeneralResourceQuotasResponse`	`DescribeGeneralResourceQuotas(DescribeGeneralResourceQuotasRequest req)` 本接口（DescribeGeneralResourceQuotas）用于查询通用资源配额信息。
`DescribeInstanceLoginKeyPairAttributeResponse`	`DescribeInstanceLoginKeyPairAttribute(DescribeInstanceLoginKeyPairAttributeRequest req)` 本接口用于查询实例默认登录密钥属性。
`DescribeInstancesResponse`	`DescribeInstances(DescribeInstancesRequest req)` 本接口（DescribeInstances）用于查询一个或多个实例的详细信息。可以根据实例 ID、实例名称或者实例的内网 IP 查询实例的详细信息。过滤信息详细请见过滤器 [Filters](https://cloud.tencent.com/document/product/1207/47576#Filter) 。如果参数为空，返回当前用户一定数量（Limit 所指定的数量，默认为 20）的实例。支持查询实例的最新操作（LatestOperation）以及最新操作状态（LatestOperationState）。
`DescribeInstancesDeniedActionsResponse`	`DescribeInstancesDeniedActions(DescribeInstancesDeniedActionsRequest req)` 本接口（DescribeInstancesDeniedActions）用于查询一个或多个实例的操作限制列表信息。
`DescribeInstancesReturnableResponse`	`DescribeInstancesReturnable(DescribeInstancesReturnableRequest req)` 本接口（DescribeInstancesReturnable）用于查询实例是否可退还。
`DescribeInstancesTrafficPackagesResponse`	`DescribeInstancesTrafficPackages(DescribeInstancesTrafficPackagesRequest req)` 本接口（DescribeInstancesTrafficPackages）用于查询一个或多个实例的流量包详情。
`DescribeInstanceVncUrlResponse`	`DescribeInstanceVncUrl(DescribeInstanceVncUrlRequest req)` 本接口（DescribeInstanceVncUrl）用于查询实例管理终端地址，获取的地址可用于实例的 VNC 登录。处于 RUNNING 状态的机器可使用此功能。管理终端地址的有效期为 15 秒，调用接口成功后如果 15 秒内不使用该链接进行访问，管理终端地址自动失效，您需要重新查询。管理终端地址一旦被访问，将自动失效，您需要重新查询。如果连接断开，每分钟内重新连接的次数不能超过 30 次。
`DescribeKeyPairsResponse`	`DescribeKeyPairs(DescribeKeyPairsRequest req)` 本接口 (DescribeKeyPairs) 用于查询用户密钥对信息。
`DescribeModifyInstanceBundlesResponse`	`DescribeModifyInstanceBundles(DescribeModifyInstanceBundlesRequest req)` 本接口（DescribeModifyInstanceBundles）用于查询实例可变更套餐列表。
`DescribeRegionsResponse`	`DescribeRegions(DescribeRegionsRequest req)` 本接口（DescribeRegions）用于查询地域信息。
`DescribeResetInstanceBlueprintsResponse`	`DescribeResetInstanceBlueprints(DescribeResetInstanceBlueprintsRequest req)` 本接口（DescribeResetInstanceBlueprints）查询重置实例的镜像信息。
`DescribeSnapshotsResponse`	`DescribeSnapshots(DescribeSnapshotsRequest req)` 本接口（DescribeSnapshots）用于查询快照的详细信息。
`DescribeSnapshotsDeniedActionsResponse`	`DescribeSnapshotsDeniedActions(DescribeSnapshotsDeniedActionsRequest req)` 本接口（DescribeSnapshotsDeniedActions）用于查询一个或多个快照的操作限制列表信息。
`DescribeZonesResponse`	`DescribeZones(DescribeZonesRequest req)` 查询地域下可用区
`DetachCcnResponse`	`DetachCcn(DetachCcnRequest req)` 本接口 (AttachCcn) 用于解除与云联网的关联。
`DisassociateInstancesKeyPairsResponse`	`DisassociateInstancesKeyPairs(DisassociateInstancesKeyPairsRequest req)` 本接口（DisassociateInstancesKeyPairs）用于解除实例与指定密钥对的绑定关系。只支持 [RUNNING, STOPPED] 状态的 LINUX_UNIX 操作系统的实例。处于 RUNNING 状态的实例会强制关机，然后解绑。解绑密钥后，实例可以通过原来设置的密码登录。如果原来没有设置密码，解绑后将无法使用 SSH 登录。可以调用 ResetInstancesPassword 接口来设置登录密码。支持批量操作。每次请求批量实例的上限为 100。本接口为异步接口，请求发送成功后会返回一个 RequestId，此时操作并未立即完成。实例操作结果可以通过调用 DescribeInstances 接口查询，如果实例的最新操作状态（LatestOperationState）为“SUCCESS”，则代表操作成功。
`ImportKeyPairResponse`	`ImportKeyPair(ImportKeyPairRequest req)` 本接口（ImportKeyPair）用于导入用户指定密钥对。
`InquirePriceCreateBlueprintResponse`	`InquirePriceCreateBlueprint(InquirePriceCreateBlueprintRequest req)` 本接口 (InquirePriceCreateBlueprint) 用于创建镜像询价。
`InquirePriceCreateInstancesResponse`	`InquirePriceCreateInstances(InquirePriceCreateInstancesRequest req)` 本接口（InquiryPriceCreateInstances）用于创建实例询价。
`InquirePriceRenewInstancesResponse`	`InquirePriceRenewInstances(InquirePriceRenewInstancesRequest req)` 本接口（InquirePriceCreateInstances）用于续费实例询价。
`ModifyBlueprintAttributeResponse`	`ModifyBlueprintAttribute(ModifyBlueprintAttributeRequest req)` 本接口 (ModifyBlueprintAttribute) 用于修改镜像属性。
`ModifyFirewallRuleDescriptionResponse`	`ModifyFirewallRuleDescription(ModifyFirewallRuleDescriptionRequest req)` 本接口（ModifyFirewallRuleDescription）用于修改单条防火墙规则描述。 FirewallVersion 用于指定要操作的防火墙的版本。传入 FirewallVersion 版本号若不等于当前防火墙的最新版本，将返回失败；若不传 FirewallVersion 则直接修改防火墙规则备注。在 FirewallRule 参数中： Protocol 字段支持输入 TCP，UDP，ICMP，ALL。 Port 字段允许输入 ALL，或者一个单独的端口号，或者用逗号分隔的离散端口号，或者用减号分隔的两个端口号代表的端口范围。当 Port 为范围时，减号分隔的第一个端口号小于第二个端口号。当 Protocol 字段不是 TCP 或 UDP 时，Port 字段只能为空或 ALL。Port 字段长度不得超过 64。 CidrBlock 字段允许输入符合 cidr 格式标准的任意字符串。租户之间网络隔离规则优先于防火墙中的内网规则。 Action 字段只允许输入 ACCEPT 或 DROP。 FirewallRuleDescription 字段长度不得超过 64。
`ModifyFirewallRulesResponse`	`ModifyFirewallRules(ModifyFirewallRulesRequest req)` 本接口（ModifyFirewallRules）用于重置实例防火墙规则。本接口先删除当前实例的所有防火墙规则，然后添加新的规则。 FirewallVersion 用于指定要操作的防火墙的版本。传入 FirewallVersion 版本号若不等于当前防火墙的最新版本，将返回失败；若不传 FirewallVersion 则直接重置防火墙规则。在 FirewallRules 参数中： Protocol 字段支持输入 TCP，UDP，ICMP，ALL。 Port 字段允许输入 ALL，或者一个单独的端口号，或者用逗号分隔的离散端口号，或者用减号分隔的两个端口号代表的端口范围。当 Port 为范围时，减号分隔的第一个端口号小于第二个端口号。当 Protocol 字段不是 TCP 或 UDP 时，Port 字段只能为空或 ALL。Port 字段长度不得超过 64。 CidrBlock 字段允许输入符合 cidr 格式标准的任意字符串。租户之间网络隔离规则优先于防火墙中的内网规则。 Action 字段只允许输入 ACCEPT 或 DROP。 FirewallRuleDescription 字段长度不得超过 64。
`ModifyInstancesAttributeResponse`	`ModifyInstancesAttribute(ModifyInstancesAttributeRequest req)` 本接口（ModifyInstancesAttribute）用于修改实例的属性。 “实例名称”仅为方便用户自己管理之用。支持批量操作。每次请求批量实例的上限为 100。本接口为异步接口，请求发送成功后会返回一个 RequestId，此时操作并未立即完成。实例操作结果可以通过调用 DescribeInstances 接口查询，如果实例的最新操作状态（LatestOperationState）为“SUCCESS”，则代表操作成功。
`ModifyInstancesLoginKeyPairAttributeResponse`	`ModifyInstancesLoginKeyPairAttribute(ModifyInstancesLoginKeyPairAttributeRequest req)` 本接口用于设置实例默认登录密钥对属性。
`ModifyInstancesRenewFlagResponse`	`ModifyInstancesRenewFlag(ModifyInstancesRenewFlagRequest req)` 本接口 (ModifyInstancesRenewFlag) 用于修改包年包月实例续费标识。实例被标识为自动续费后，每次在实例到期时，会自动续费一个月。支持批量操作。每次请求批量实例的上限为100。实例操作结果可以通过调用 DescribeInstances 接口查询，如果实例的最新操作状态(LatestOperationState)为“SUCCESS”，则代表操作成功。
`ModifySnapshotAttributeResponse`	`ModifySnapshotAttribute(ModifySnapshotAttributeRequest req)` 本接口（ModifySnapshotAttribute）用于修改指定快照的属性。 “快照名称”仅为方便用户自己管理之用。
`RebootInstancesResponse`	`RebootInstances(RebootInstancesRequest req)` 本接口（RebootInstances）用于重启实例。只有状态为 RUNNING 的实例才可以进行此操作。接口调用成功时，实例会进入 REBOOTING 状态；重启实例成功时，实例会进入 RUNNING 状态。支持批量操作，每次请求批量实例的上限为 100。本接口为异步接口，请求发送成功后会返回一个 RequestId，此时操作并未立即完成。实例操作结果可以通过调用 DescribeInstances 接口查询，如果实例的最新操作状态（LatestOperationState）为“SUCCESS”，则代表操作成功。
`ResetAttachCcnResponse`	`ResetAttachCcn(ResetAttachCcnRequest req)` 本接口 (ResetAttachCcn) 用于关联云联网实例申请过期时，重新申请关联操作。
`ResetInstanceResponse`	`ResetInstance(ResetInstanceRequest req)` 本接口（ResetInstance）用于重装指定实例上的镜像。如果指定了 BlueprintId 参数，则使用指定的镜像重装；否则按照当前实例使用的镜像进行重装。系统盘将会被格式化，并重置；请确保系统盘中无重要文件。目前不支持实例使用该接口实现 LINUX_UNIX 和 WINDOWS 操作系统切换。本接口为异步接口，请求发送成功后会返回一个 RequestId，此时操作并未立即完成。实例操作结果可以通过调用 DescribeInstances 接口查询，如果实例的最新操作状态（LatestOperationState）为“SUCCESS”，则代表操作成功。
`ResetInstancesPasswordResponse`	`ResetInstancesPassword(ResetInstancesPasswordRequest req)` 本接口（ResetInstancesPassword）用于将实例操作系统的密码重置为用户指定的密码。只修改管理员帐号的密码。实例的操作系统不同，管理员帐号也会不一样（Windows 为 Administrator，Ubuntu 为 ubuntu ，其它系统为 root）。支持批量操作。将多个实例操作系统的密码重置为相同的密码。每次请求批量实例的上限为 100。建议对运行中的实例先手动关机，然后再进行密码重置。如实例处于运行中状态，本接口操作过程中会对实例进行关机操作，尝试正常关机失败后进行强制关机。本接口为异步接口，请求发送成功后会返回一个 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”，则代表操作成功。
`TerminateInstancesResponse`	`TerminateInstances(TerminateInstancesRequest req)` 本接口 (TerminateInstances) 用于退还实例。处于 SHUTDOWN 状态的实例，可通过本接口销毁，且不可恢复。支持批量操作，每次请求批量实例的上限为100。本接口为异步接口，请求发送成功后会返回一个 RequestId，此时操作并未立即完成。实例操作结果可以通过调用 DescribeInstances 接口查询，如果实例的最新操作状态 (LatestOperationState) 为“SUCCESS”，则代表操作成功。

Methods inherited from class com.tencentcloudapi.common.AbstractClient
call, callOctetStream, getClientProfile, getCredential, getRegion, internalRequest, retry, 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
```
    本接口（ApplyInstanceSnapshot）用于回滚指定实例的系统盘快照。
  - 仅支持回滚到原系统盘。
  - 用于回滚的快照必须处于 NORMAL 状态。快照状态可以通 DescribeSnapshots 接口查询，见输出参数中 SnapshotState 字段解释。
  - 回滚快照时，实例的状态必须为 STOPPED 或 RUNNING，可通过 DescribeInstances 接口查询实例状态。处于 RUNNING 状态的实例会强制关机，然后回滚快照。

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

AssociateInstancesKeyPairs
```
public AssociateInstancesKeyPairsResponse AssociateInstancesKeyPairs(AssociateInstancesKeyPairsRequest req)
                                                              throws TencentCloudSDKException
```
本接口（AssociateInstancesKeyPairs）用于绑定用户指定密钥对到实例。只支持 [RUNNING, STOPPED] 状态的 LINUX_UNIX 操作系统的实例。处于 RUNNING 状态的实例会强制关机，然后绑定。将密钥的公钥写入到实例的 SSH 配置当中，用户就可以通过该密钥的私钥来登录实例。如果实例原来绑定过密钥，那么原来的密钥将失效。如果实例原来是通过密码登录，绑定密钥后无法使用密码登录。支持批量操作。每次请求批量实例的上限为 100。如果批量实例存在不允许操作的实例，操作会以特定错误码返回。本接口为异步接口，请求发送成功后会返回一个 RequestId，此时操作并未立即完成。实例操作结果可以通过调用 DescribeInstances 接口查询，如果实例的最新操作状态（LatestOperationState）为“SUCCESS”，则代表操作成功。

Parameters:

req - AssociateInstancesKeyPairsRequest

Returns:

AssociateInstancesKeyPairsResponse

Throws:

TencentCloudSDKException

AttachCcn
```
public AttachCcnResponse AttachCcn(AttachCcnRequest req)
                            throws TencentCloudSDKException
```
本接口 (AttachCcn) 用于建立与云联网的关联。

Parameters:

req - AttachCcnRequest

Returns:

AttachCcnResponse

Throws:

TencentCloudSDKException

CreateBlueprint
```
public CreateBlueprintResponse CreateBlueprint(CreateBlueprintRequest req)
                                        throws TencentCloudSDKException
```
本接口 (CreateBlueprint) 用于创建镜像。

Parameters:

req - CreateBlueprintRequest

Returns:

CreateBlueprintResponse

Throws:

TencentCloudSDKException

CreateFirewallRules
```
public CreateFirewallRulesResponse CreateFirewallRules(CreateFirewallRulesRequest req)
                                                throws TencentCloudSDKException
```
本接口（CreateFirewallRules）用于在实例上添加防火墙规则。 FirewallVersion 为防火墙版本号，用户每次更新防火墙规则版本会自动加1，防止您更新的规则已过期，不填不考虑冲突。在 FirewallRules 参数中： Protocol 字段支持输入 TCP，UDP，ICMP，ALL。 Port 字段允许输入 ALL，或者一个单独的端口号，或者用逗号分隔的离散端口号，或者用减号分隔的两个端口号代表的端口范围。当 Port 为范围时，减号分隔的第一个端口号小于第二个端口号。当 Protocol 字段不是 TCP 或 UDP 时，Port 字段只能为空或 ALL。Port 字段长度不得超过 64。 CidrBlock 字段允许输入符合 cidr 格式标准的任意字符串。租户之间网络隔离规则优先于防火墙中的内网规则。 Action 字段只允许输入 ACCEPT 或 DROP。 FirewallRuleDescription 字段长度不得超过 64。

Parameters:

req - CreateFirewallRulesRequest

Returns:

CreateFirewallRulesResponse

Throws:

TencentCloudSDKException

CreateInstanceSnapshot
```
public CreateInstanceSnapshotResponse CreateInstanceSnapshot(CreateInstanceSnapshotRequest req)
                                                      throws TencentCloudSDKException
```
本接口（CreateInstanceSnapshot）用于创建指定实例的系统盘快照。

Parameters:

req - CreateInstanceSnapshotRequest

Returns:

CreateInstanceSnapshotResponse

Throws:

TencentCloudSDKException

CreateKeyPair
```
public CreateKeyPairResponse CreateKeyPair(CreateKeyPairRequest req)
                                    throws TencentCloudSDKException
```
本接口（CreateKeyPair）用于创建一个密钥对。

Parameters:

req - CreateKeyPairRequest

Returns:

CreateKeyPairResponse

Throws:

TencentCloudSDKException

DeleteBlueprints
```
public DeleteBlueprintsResponse DeleteBlueprints(DeleteBlueprintsRequest req)
                                          throws TencentCloudSDKException
```
本接口 (DeleteBlueprints) 用于删除镜像。

Parameters:

req - DeleteBlueprintsRequest

Returns:

DeleteBlueprintsResponse

Throws:

TencentCloudSDKException

DeleteFirewallRules
```
public DeleteFirewallRulesResponse DeleteFirewallRules(DeleteFirewallRulesRequest req)
                                                throws TencentCloudSDKException
```
本接口（DeleteFirewallRules）用于删除实例的防火墙规则。 FirewallVersion 用于指定要操作的防火墙的版本。传入 FirewallVersion 版本号若不等于当前防火墙的最新版本，将返回失败；若不传 FirewallVersion 则直接删除指定的规则。在 FirewallRules 参数中： Protocol 字段支持输入 TCP，UDP，ICMP，ALL。 Port 字段允许输入 ALL，或者一个单独的端口号，或者用逗号分隔的离散端口号，或者用减号分隔的两个端口号代表的端口范围。当 Port 为范围时，减号分隔的第一个端口号小于第二个端口号。当 Protocol 字段不是 TCP 或 UDP 时，Port 字段只能为空或 ALL。Port 字段长度不得超过 64。 CidrBlock 字段允许输入符合 cidr 格式标准的任意字符串。租户之间网络隔离规则优先于防火墙中的内网规则。 Action 字段只允许输入 ACCEPT 或 DROP。 FirewallRuleDescription 字段长度不得超过 64。

Parameters:

req - DeleteFirewallRulesRequest

Returns:

DeleteFirewallRulesResponse

Throws:

TencentCloudSDKException

DeleteKeyPairs
```
public DeleteKeyPairsResponse DeleteKeyPairs(DeleteKeyPairsRequest req)
                                      throws TencentCloudSDKException
```
本接口（DeleteKeyPairs）用于删除密钥对。

Parameters:

req - DeleteKeyPairsRequest

Returns:

DeleteKeyPairsResponse

Throws:

TencentCloudSDKException

DeleteSnapshots
```
public DeleteSnapshotsResponse DeleteSnapshots(DeleteSnapshotsRequest req)
                                        throws TencentCloudSDKException
```
本接口（DeleteSnapshots）用于删除快照。快照必须处于 NORMAL 状态，快照状态可以通过 DescribeSnapshots 接口查询，见输出参数中 SnapshotState 字段解释。

Parameters:

req - DeleteSnapshotsRequest

Returns:

DeleteSnapshotsResponse

Throws:

TencentCloudSDKException

DescribeBlueprintInstances
```
public DescribeBlueprintInstancesResponse DescribeBlueprintInstances(DescribeBlueprintInstancesRequest req)
                                                              throws TencentCloudSDKException
```
本接口（DescribeBlueprintInstances）用于查询镜像实例信息。

Parameters:

req - DescribeBlueprintInstancesRequest

Returns:

DescribeBlueprintInstancesResponse

Throws:

TencentCloudSDKException

DescribeBlueprints
```
public DescribeBlueprintsResponse DescribeBlueprints(DescribeBlueprintsRequest req)
                                              throws TencentCloudSDKException
```
本接口（DescribeBlueprints）用于查询镜像信息。

Parameters:

req - DescribeBlueprintsRequest

Returns:

DescribeBlueprintsResponse

Throws:

TencentCloudSDKException

DescribeBundleDiscount
```
public DescribeBundleDiscountResponse DescribeBundleDiscount(DescribeBundleDiscountRequest req)
                                                      throws TencentCloudSDKException
```
本接口（DescribeBundleDiscount）用于查询套餐折扣信息。

Parameters:

req - DescribeBundleDiscountRequest

Returns:

DescribeBundleDiscountResponse

Throws:

TencentCloudSDKException

DescribeBundles
```
public DescribeBundlesResponse DescribeBundles(DescribeBundlesRequest req)
                                        throws TencentCloudSDKException
```
本接口（DescribeBundles）用于查询套餐信息。

Parameters:

req - DescribeBundlesRequest

Returns:

DescribeBundlesResponse

Throws:

TencentCloudSDKException

DescribeCcnAttachedInstances
```
public DescribeCcnAttachedInstancesResponse DescribeCcnAttachedInstances(DescribeCcnAttachedInstancesRequest req)
                                                                  throws TencentCloudSDKException
```
本接口 (DescribeCcnAttachedInstances) 用于查询云联网关联的实例信息。

Parameters:

req - DescribeCcnAttachedInstancesRequest

Returns:

DescribeCcnAttachedInstancesResponse

Throws:

TencentCloudSDKException

DescribeFirewallRules
```
public DescribeFirewallRulesResponse DescribeFirewallRules(DescribeFirewallRulesRequest req)
                                                    throws TencentCloudSDKException
```
本接口（DescribeFirewallRules）用于查询实例的防火墙规则。

Parameters:

req - DescribeFirewallRulesRequest

Returns:

DescribeFirewallRulesResponse

Throws:

TencentCloudSDKException

DescribeFirewallRulesTemplate
```
public DescribeFirewallRulesTemplateResponse DescribeFirewallRulesTemplate(DescribeFirewallRulesTemplateRequest req)
                                                                    throws TencentCloudSDKException
```
本接口（DescribeFirewallRulesTemplate）用于查询防火墙规则模版。

Parameters:

req - DescribeFirewallRulesTemplateRequest

Returns:

DescribeFirewallRulesTemplateResponse

Throws:

TencentCloudSDKException

DescribeGeneralResourceQuotas
```
public DescribeGeneralResourceQuotasResponse DescribeGeneralResourceQuotas(DescribeGeneralResourceQuotasRequest req)
                                                                    throws TencentCloudSDKException
```
本接口（DescribeGeneralResourceQuotas）用于查询通用资源配额信息。

Parameters:

req - DescribeGeneralResourceQuotasRequest

Returns:

DescribeGeneralResourceQuotasResponse

Throws:

TencentCloudSDKException

DescribeInstanceLoginKeyPairAttribute

public DescribeInstanceLoginKeyPairAttributeResponse DescribeInstanceLoginKeyPairAttribute(DescribeInstanceLoginKeyPairAttributeRequest req)
                                                                                    throws TencentCloudSDKException

本接口用于查询实例默认登录密钥属性。

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

DescribeInstanceVncUrl
```
public DescribeInstanceVncUrlResponse DescribeInstanceVncUrl(DescribeInstanceVncUrlRequest req)
                                                      throws TencentCloudSDKException
```
本接口（DescribeInstanceVncUrl）用于查询实例管理终端地址，获取的地址可用于实例的 VNC 登录。处于 RUNNING 状态的机器可使用此功能。管理终端地址的有效期为 15 秒，调用接口成功后如果 15 秒内不使用该链接进行访问，管理终端地址自动失效，您需要重新查询。管理终端地址一旦被访问，将自动失效，您需要重新查询。如果连接断开，每分钟内重新连接的次数不能超过 30 次。

Parameters:

req - DescribeInstanceVncUrlRequest

Returns:

DescribeInstanceVncUrlResponse

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

DescribeInstancesDeniedActions
```
public DescribeInstancesDeniedActionsResponse DescribeInstancesDeniedActions(DescribeInstancesDeniedActionsRequest req)
                                                                      throws TencentCloudSDKException
```
本接口（DescribeInstancesDeniedActions）用于查询一个或多个实例的操作限制列表信息。

Parameters:

req - DescribeInstancesDeniedActionsRequest

Returns:

DescribeInstancesDeniedActionsResponse

Throws:

TencentCloudSDKException

DescribeInstancesReturnable
```
public DescribeInstancesReturnableResponse DescribeInstancesReturnable(DescribeInstancesReturnableRequest req)
                                                                throws TencentCloudSDKException
```
本接口（DescribeInstancesReturnable）用于查询实例是否可退还。

Parameters:

req - DescribeInstancesReturnableRequest

Returns:

DescribeInstancesReturnableResponse

Throws:

TencentCloudSDKException

DescribeInstancesTrafficPackages
```
public DescribeInstancesTrafficPackagesResponse DescribeInstancesTrafficPackages(DescribeInstancesTrafficPackagesRequest req)
                                                                          throws TencentCloudSDKException
```
本接口（DescribeInstancesTrafficPackages）用于查询一个或多个实例的流量包详情。

Parameters:

req - DescribeInstancesTrafficPackagesRequest

Returns:

DescribeInstancesTrafficPackagesResponse

Throws:

TencentCloudSDKException

DescribeKeyPairs
```
public DescribeKeyPairsResponse DescribeKeyPairs(DescribeKeyPairsRequest req)
                                          throws TencentCloudSDKException
```
本接口 (DescribeKeyPairs) 用于查询用户密钥对信息。

Parameters:

req - DescribeKeyPairsRequest

Returns:

DescribeKeyPairsResponse

Throws:

TencentCloudSDKException

DescribeModifyInstanceBundles
```
public DescribeModifyInstanceBundlesResponse DescribeModifyInstanceBundles(DescribeModifyInstanceBundlesRequest req)
                                                                    throws TencentCloudSDKException
```
本接口（DescribeModifyInstanceBundles）用于查询实例可变更套餐列表。

Parameters:

req - DescribeModifyInstanceBundlesRequest

Returns:

DescribeModifyInstanceBundlesResponse

Throws:

TencentCloudSDKException

DescribeRegions
```
public DescribeRegionsResponse DescribeRegions(DescribeRegionsRequest req)
                                        throws TencentCloudSDKException
```
本接口（DescribeRegions）用于查询地域信息。

Parameters:

req - DescribeRegionsRequest

Returns:

DescribeRegionsResponse

Throws:

TencentCloudSDKException

DescribeResetInstanceBlueprints
```
public DescribeResetInstanceBlueprintsResponse DescribeResetInstanceBlueprints(DescribeResetInstanceBlueprintsRequest req)
                                                                        throws TencentCloudSDKException
```
本接口（DescribeResetInstanceBlueprints）查询重置实例的镜像信息。

Parameters:

req - DescribeResetInstanceBlueprintsRequest

Returns:

DescribeResetInstanceBlueprintsResponse

Throws:

TencentCloudSDKException

DescribeSnapshots
```
public DescribeSnapshotsResponse DescribeSnapshots(DescribeSnapshotsRequest req)
                                            throws TencentCloudSDKException
```
本接口（DescribeSnapshots）用于查询快照的详细信息。

Parameters:

req - DescribeSnapshotsRequest

Returns:

DescribeSnapshotsResponse

Throws:

TencentCloudSDKException

DescribeSnapshotsDeniedActions
```
public DescribeSnapshotsDeniedActionsResponse DescribeSnapshotsDeniedActions(DescribeSnapshotsDeniedActionsRequest req)
                                                                      throws TencentCloudSDKException
```
本接口（DescribeSnapshotsDeniedActions）用于查询一个或多个快照的操作限制列表信息。

Parameters:

req - DescribeSnapshotsDeniedActionsRequest

Returns:

DescribeSnapshotsDeniedActionsResponse

Throws:

TencentCloudSDKException

DescribeZones

public DescribeZonesResponse DescribeZones(DescribeZonesRequest req)
                                    throws TencentCloudSDKException

查询地域下可用区

Parameters:: req - DescribeZonesRequest
Returns:: DescribeZonesResponse
Throws:: TencentCloudSDKException

DetachCcn
```
public DetachCcnResponse DetachCcn(DetachCcnRequest req)
                            throws TencentCloudSDKException
```
本接口 (AttachCcn) 用于解除与云联网的关联。

Parameters:

req - DetachCcnRequest

Returns:

DetachCcnResponse

Throws:

TencentCloudSDKException

DisassociateInstancesKeyPairs
```
public DisassociateInstancesKeyPairsResponse DisassociateInstancesKeyPairs(DisassociateInstancesKeyPairsRequest req)
                                                                    throws TencentCloudSDKException
```
本接口（DisassociateInstancesKeyPairs）用于解除实例与指定密钥对的绑定关系。只支持 [RUNNING, STOPPED] 状态的 LINUX_UNIX 操作系统的实例。处于 RUNNING 状态的实例会强制关机，然后解绑。解绑密钥后，实例可以通过原来设置的密码登录。如果原来没有设置密码，解绑后将无法使用 SSH 登录。可以调用 ResetInstancesPassword 接口来设置登录密码。支持批量操作。每次请求批量实例的上限为 100。本接口为异步接口，请求发送成功后会返回一个 RequestId，此时操作并未立即完成。实例操作结果可以通过调用 DescribeInstances 接口查询，如果实例的最新操作状态（LatestOperationState）为“SUCCESS”，则代表操作成功。

Parameters:

req - DisassociateInstancesKeyPairsRequest

Returns:

DisassociateInstancesKeyPairsResponse

Throws:

TencentCloudSDKException

ImportKeyPair
```
public ImportKeyPairResponse ImportKeyPair(ImportKeyPairRequest req)
                                    throws TencentCloudSDKException
```
本接口（ImportKeyPair）用于导入用户指定密钥对。

Parameters:

req - ImportKeyPairRequest

Returns:

ImportKeyPairResponse

Throws:

TencentCloudSDKException

InquirePriceCreateBlueprint
```
public InquirePriceCreateBlueprintResponse InquirePriceCreateBlueprint(InquirePriceCreateBlueprintRequest req)
                                                                throws TencentCloudSDKException
```
本接口 (InquirePriceCreateBlueprint) 用于创建镜像询价。

Parameters:

req - InquirePriceCreateBlueprintRequest

Returns:

InquirePriceCreateBlueprintResponse

Throws:

TencentCloudSDKException

InquirePriceCreateInstances
```
public InquirePriceCreateInstancesResponse InquirePriceCreateInstances(InquirePriceCreateInstancesRequest req)
                                                                throws TencentCloudSDKException
```
本接口（InquiryPriceCreateInstances）用于创建实例询价。

Parameters:

req - InquirePriceCreateInstancesRequest

Returns:

InquirePriceCreateInstancesResponse

Throws:

TencentCloudSDKException

InquirePriceRenewInstances
```
public InquirePriceRenewInstancesResponse InquirePriceRenewInstances(InquirePriceRenewInstancesRequest req)
                                                              throws TencentCloudSDKException
```
本接口（InquirePriceCreateInstances）用于续费实例询价。

Parameters:

req - InquirePriceRenewInstancesRequest

Returns:

InquirePriceRenewInstancesResponse

Throws:

TencentCloudSDKException

ModifyBlueprintAttribute
```
public ModifyBlueprintAttributeResponse ModifyBlueprintAttribute(ModifyBlueprintAttributeRequest req)
                                                          throws TencentCloudSDKException
```
本接口 (ModifyBlueprintAttribute) 用于修改镜像属性。

Parameters:

req - ModifyBlueprintAttributeRequest

Returns:

ModifyBlueprintAttributeResponse

Throws:

TencentCloudSDKException

ModifyFirewallRuleDescription
```
public ModifyFirewallRuleDescriptionResponse ModifyFirewallRuleDescription(ModifyFirewallRuleDescriptionRequest req)
                                                                    throws TencentCloudSDKException
```
本接口（ModifyFirewallRuleDescription）用于修改单条防火墙规则描述。 FirewallVersion 用于指定要操作的防火墙的版本。传入 FirewallVersion 版本号若不等于当前防火墙的最新版本，将返回失败；若不传 FirewallVersion 则直接修改防火墙规则备注。在 FirewallRule 参数中： Protocol 字段支持输入 TCP，UDP，ICMP，ALL。 Port 字段允许输入 ALL，或者一个单独的端口号，或者用逗号分隔的离散端口号，或者用减号分隔的两个端口号代表的端口范围。当 Port 为范围时，减号分隔的第一个端口号小于第二个端口号。当 Protocol 字段不是 TCP 或 UDP 时，Port 字段只能为空或 ALL。Port 字段长度不得超过 64。 CidrBlock 字段允许输入符合 cidr 格式标准的任意字符串。租户之间网络隔离规则优先于防火墙中的内网规则。 Action 字段只允许输入 ACCEPT 或 DROP。 FirewallRuleDescription 字段长度不得超过 64。

Parameters:

req - ModifyFirewallRuleDescriptionRequest

Returns:

ModifyFirewallRuleDescriptionResponse

Throws:

TencentCloudSDKException

ModifyFirewallRules
```
public ModifyFirewallRulesResponse ModifyFirewallRules(ModifyFirewallRulesRequest req)
                                                throws TencentCloudSDKException
```
本接口（ModifyFirewallRules）用于重置实例防火墙规则。本接口先删除当前实例的所有防火墙规则，然后添加新的规则。 FirewallVersion 用于指定要操作的防火墙的版本。传入 FirewallVersion 版本号若不等于当前防火墙的最新版本，将返回失败；若不传 FirewallVersion 则直接重置防火墙规则。在 FirewallRules 参数中： Protocol 字段支持输入 TCP，UDP，ICMP，ALL。 Port 字段允许输入 ALL，或者一个单独的端口号，或者用逗号分隔的离散端口号，或者用减号分隔的两个端口号代表的端口范围。当 Port 为范围时，减号分隔的第一个端口号小于第二个端口号。当 Protocol 字段不是 TCP 或 UDP 时，Port 字段只能为空或 ALL。Port 字段长度不得超过 64。 CidrBlock 字段允许输入符合 cidr 格式标准的任意字符串。租户之间网络隔离规则优先于防火墙中的内网规则。 Action 字段只允许输入 ACCEPT 或 DROP。 FirewallRuleDescription 字段长度不得超过 64。

Parameters:

req - ModifyFirewallRulesRequest

Returns:

ModifyFirewallRulesResponse

Throws:

TencentCloudSDKException

ModifyInstancesAttribute
```
public ModifyInstancesAttributeResponse ModifyInstancesAttribute(ModifyInstancesAttributeRequest req)
                                                          throws TencentCloudSDKException
```
本接口（ModifyInstancesAttribute）用于修改实例的属性。 “实例名称”仅为方便用户自己管理之用。支持批量操作。每次请求批量实例的上限为 100。本接口为异步接口，请求发送成功后会返回一个 RequestId，此时操作并未立即完成。实例操作结果可以通过调用 DescribeInstances 接口查询，如果实例的最新操作状态（LatestOperationState）为“SUCCESS”，则代表操作成功。

Parameters:

req - ModifyInstancesAttributeRequest

Returns:

ModifyInstancesAttributeResponse

Throws:

TencentCloudSDKException

ModifyInstancesLoginKeyPairAttribute

public ModifyInstancesLoginKeyPairAttributeResponse ModifyInstancesLoginKeyPairAttribute(ModifyInstancesLoginKeyPairAttributeRequest req)
                                                                                  throws TencentCloudSDKException

本接口用于设置实例默认登录密钥对属性。

Parameters:: req - ModifyInstancesLoginKeyPairAttributeRequest
Returns:: ModifyInstancesLoginKeyPairAttributeResponse
Throws:: TencentCloudSDKException

ModifyInstancesRenewFlag
```
public ModifyInstancesRenewFlagResponse ModifyInstancesRenewFlag(ModifyInstancesRenewFlagRequest req)
                                                          throws TencentCloudSDKException
```
本接口 (ModifyInstancesRenewFlag) 用于修改包年包月实例续费标识。实例被标识为自动续费后，每次在实例到期时，会自动续费一个月。支持批量操作。每次请求批量实例的上限为100。实例操作结果可以通过调用 DescribeInstances 接口查询，如果实例的最新操作状态(LatestOperationState)为“SUCCESS”，则代表操作成功。

Parameters:

req - ModifyInstancesRenewFlagRequest

Returns:

ModifyInstancesRenewFlagResponse

Throws:

TencentCloudSDKException

ModifySnapshotAttribute

public ModifySnapshotAttributeResponse ModifySnapshotAttribute(ModifySnapshotAttributeRequest req)
                                                        throws TencentCloudSDKException

本接口（ModifySnapshotAttribute）用于修改指定快照的属性。

“快照名称”仅为方便用户自己管理之用。

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

CreateBlueprint

CreateFirewallRules

CreateInstanceSnapshot

CreateKeyPair

DeleteBlueprints

DeleteFirewallRules

DeleteKeyPairs

DeleteSnapshots

DescribeBlueprintInstances

DescribeBlueprints

DescribeBundleDiscount

DescribeBundles

DescribeCcnAttachedInstances

DescribeFirewallRules

DescribeFirewallRulesTemplate

DescribeGeneralResourceQuotas

DescribeInstanceLoginKeyPairAttribute

DescribeInstanceVncUrl

DescribeInstances

DescribeInstancesDeniedActions

DescribeInstancesReturnable

DescribeInstancesTrafficPackages

DescribeKeyPairs

DescribeModifyInstanceBundles

DescribeRegions

DescribeResetInstanceBlueprints

DescribeSnapshots

DescribeSnapshotsDeniedActions

DescribeZones

DetachCcn

DisassociateInstancesKeyPairs

ImportKeyPair

InquirePriceCreateBlueprint

InquirePriceCreateInstances

InquirePriceRenewInstances

ModifyBlueprintAttribute

ModifyFirewallRuleDescription

ModifyFirewallRules

ModifyInstancesAttribute

ModifyInstancesLoginKeyPairAttribute

ModifyInstancesRenewFlag

ModifySnapshotAttribute

RebootInstances

ResetAttachCcn

ResetInstance

ResetInstancesPassword

StartInstances

StopInstances

TerminateInstances