BmClient (tencentcloud-sdk-java 3.0.45 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractClient
- - com.tencentcloudapi.bm.v20180423.BmClient

public class BmClient
extends AbstractClient

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

Constructor Summary

Constructors
Constructor and Description
`BmClient(Credential credential, String region)` 构造client
`BmClient(Credential credential, String region, ClientProfile profile)` 构造client

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BindPsaTagResponse`	`BindPsaTag(BindPsaTagRequest req)` 为预授权规则绑定标签
`CreatePsaRegulationResponse`	`CreatePsaRegulation(CreatePsaRegulationRequest req)` 创建预授权规则
`CreateSpotDeviceResponse`	`CreateSpotDevice(CreateSpotDeviceRequest req)` 创建黑石竞价实例
`CreateUserCmdResponse`	`CreateUserCmd(CreateUserCmdRequest req)` 创建自定义脚本
`DeletePsaRegulationResponse`	`DeletePsaRegulation(DeletePsaRegulationRequest req)` 删除预授权规则
`DeleteUserCmdsResponse`	`DeleteUserCmds(DeleteUserCmdsRequest req)` 删除自定义脚本
`DescribeDeviceClassResponse`	`DescribeDeviceClass(DescribeDeviceClassRequest req)` 获取获取设备类型
`DescribeDeviceInventoryResponse`	`DescribeDeviceInventory(DescribeDeviceInventoryRequest req)` 查询设备库存
`DescribeDeviceOperationLogResponse`	`DescribeDeviceOperationLog(DescribeDeviceOperationLogRequest req)` 查询设备操作日志，如设备重启，重装，设置密码等操作
`DescribeDevicePositionResponse`	`DescribeDevicePosition(DescribeDevicePositionRequest req)` 查询服务器所在的位置，如机架，上联交换机等信息
`DescribeDevicePriceInfoResponse`	`DescribeDevicePriceInfo(DescribeDevicePriceInfoRequest req)` 查询服务器价格信息，支持设备的批量查找，支持标准机型和弹性机型的混合查找
`DescribeDevicesResponse`	`DescribeDevices(DescribeDevicesRequest req)` 查询物理服务器，可以按照实例，业务IP等过滤
`DescribeOsInfoResponse`	`DescribeOsInfo(DescribeOsInfoRequest req)` 查询指定机型所支持的操作系统
`DescribePsaRegulationsResponse`	`DescribePsaRegulations(DescribePsaRegulationsRequest req)` 获取预授权规则列表
`DescribeRepairTaskConstantResponse`	`DescribeRepairTaskConstant(DescribeRepairTaskConstantRequest req)` 维修任务配置获取
`DescribeTaskInfoResponse`	`DescribeTaskInfo(DescribeTaskInfoRequest req)` 获取用户维修任务列表及详细信息 TaskStatus（任务状态ID）与状态中文名的对应关系如下： 1：未授权 2：处理中 3：待确认 4：未授权-暂不处理 5：已恢复 6：待确认-未恢复
`DescribeTaskOperationLogResponse`	`DescribeTaskOperationLog(DescribeTaskOperationLogRequest req)` 获取维修任务操作日志
`DescribeUserCmdsResponse`	`DescribeUserCmds(DescribeUserCmdsRequest req)` 获取自定义脚本信息列表
`DescribeUserCmdTaskInfoResponse`	`DescribeUserCmdTaskInfo(DescribeUserCmdTaskInfoRequest req)` 获取自定义脚本任务详细信息
`DescribeUserCmdTasksResponse`	`DescribeUserCmdTasks(DescribeUserCmdTasksRequest req)` 获取自定义脚本任务列表
`ModifyDeviceAliasesResponse`	`ModifyDeviceAliases(ModifyDeviceAliasesRequest req)` 修改服务器名称
`ModifyDeviceAutoRenewFlagResponse`	`ModifyDeviceAutoRenewFlag(ModifyDeviceAutoRenewFlagRequest req)` 修改物理机服务器自动续费标志
`ModifyPayModePre2PostResponse`	`ModifyPayModePre2Post(ModifyPayModePre2PostRequest req)` 将设备的预付费模式修改为后付费计费模式，支持批量转换。（前提是客户要加入黑石物理机后付费计费的白名单，申请黑石物理机后付费可以联系腾讯云客服）
`ModifyPsaRegulationResponse`	`ModifyPsaRegulation(ModifyPsaRegulationRequest req)` 允许修改规则信息及关联故障类型
`ModifyUserCmdResponse`	`ModifyUserCmd(ModifyUserCmdRequest req)` 修改自定义脚本
`OfflineDevicesResponse`	`OfflineDevices(OfflineDevicesRequest req)` 用于销毁可退还的服务器
`RebootDevicesResponse`	`RebootDevices(RebootDevicesRequest req)` 重启机器
`RepairTaskControlResponse`	`RepairTaskControl(RepairTaskControlRequest req)` 此接口用于操作维修任务入参TaskId为维修任务ID 入参Operate表示对维修任务的操作，支持如下取值： AuthorizeRepair（授权维修） Ignore（暂不提醒） ConfirmRecovered（维修完成后，确认故障恢复） ConfirmUnRecovered（维修完成后，确认故障未恢复）操作约束（当前任务状态(TaskStatus)->对应可执行的操作）：未授权(1)->授权维修；暂不处理暂不处理(4)->授权维修待确认(3)->确认故障恢复；确认故障未恢复未恢复(6)->确认故障恢复对于Ping不可达故障的任务，还允许：未授权->确认故障恢复暂不处理->确认故障恢复处理中与已恢复状态的任务不允许进行操作。详细信息请访问：https://cloud.tencent.com/document/product/386/18190
`ResetDevicePasswordResponse`	`ResetDevicePassword(ResetDevicePasswordRequest req)` 重置服务器密码
`RunUserCmdResponse`	`RunUserCmd(RunUserCmdRequest req)` 运行自定义脚本
`SetOutBandVpnAuthPasswordResponse`	`SetOutBandVpnAuthPassword(SetOutBandVpnAuthPasswordRequest req)` 设置带外VPN认证用户密码
`UnbindPsaTagResponse`	`UnbindPsaTag(UnbindPsaTagRequest req)` 解除标签与预授权规则的绑定

Methods inherited from class com.tencentcloudapi.common.AbstractClient
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
  - BmClient
```
public BmClient(Credential credential,
                String region)
```
    构造client
    
    Parameters:
    
    credential - 认证信息实例
    
    region - 产品地域
  - BmClient
```
public BmClient(Credential credential,
                String region,
                ClientProfile profile)
```
    构造client
    
    Parameters:
    
    credential - 认证信息实例
    
    region - 产品地域
    
    profile - 配置实例
- Method Detail
  - BindPsaTag
```
public BindPsaTagResponse BindPsaTag(BindPsaTagRequest req)
                              throws TencentCloudSDKException
```
    为预授权规则绑定标签
    
    Parameters:
    
    req - BindPsaTagRequest
    
    Returns:
    
    BindPsaTagResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreatePsaRegulation
```
public CreatePsaRegulationResponse CreatePsaRegulation(CreatePsaRegulationRequest req)
                                                throws TencentCloudSDKException
```
    创建预授权规则
    
    Parameters:
    
    req - CreatePsaRegulationRequest
    
    Returns:
    
    CreatePsaRegulationResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateSpotDevice
```
public CreateSpotDeviceResponse CreateSpotDevice(CreateSpotDeviceRequest req)
                                          throws TencentCloudSDKException
```
    创建黑石竞价实例
    
    Parameters:
    
    req - CreateSpotDeviceRequest
    
    Returns:
    
    CreateSpotDeviceResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateUserCmd
```
public CreateUserCmdResponse CreateUserCmd(CreateUserCmdRequest req)
                                    throws TencentCloudSDKException
```
    创建自定义脚本
    
    Parameters:
    
    req - CreateUserCmdRequest
    
    Returns:
    
    CreateUserCmdResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeletePsaRegulation
```
public DeletePsaRegulationResponse DeletePsaRegulation(DeletePsaRegulationRequest req)
                                                throws TencentCloudSDKException
```
    删除预授权规则
    
    Parameters:
    
    req - DeletePsaRegulationRequest
    
    Returns:
    
    DeletePsaRegulationResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteUserCmds
```
public DeleteUserCmdsResponse DeleteUserCmds(DeleteUserCmdsRequest req)
                                      throws TencentCloudSDKException
```
    删除自定义脚本
    
    Parameters:
    
    req - DeleteUserCmdsRequest
    
    Returns:
    
    DeleteUserCmdsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeDeviceClass
```
public DescribeDeviceClassResponse DescribeDeviceClass(DescribeDeviceClassRequest req)
                                                throws TencentCloudSDKException
```
    获取获取设备类型
    
    Parameters:
    
    req - DescribeDeviceClassRequest
    
    Returns:
    
    DescribeDeviceClassResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeDeviceInventory
```
public DescribeDeviceInventoryResponse DescribeDeviceInventory(DescribeDeviceInventoryRequest req)
                                                        throws TencentCloudSDKException
```
    查询设备库存
    
    Parameters:
    
    req - DescribeDeviceInventoryRequest
    
    Returns:
    
    DescribeDeviceInventoryResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeDeviceOperationLog
```
public DescribeDeviceOperationLogResponse DescribeDeviceOperationLog(DescribeDeviceOperationLogRequest req)
                                                              throws TencentCloudSDKException
```
    查询设备操作日志，如设备重启，重装，设置密码等操作
    
    Parameters:
    
    req - DescribeDeviceOperationLogRequest
    
    Returns:
    
    DescribeDeviceOperationLogResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeDevicePosition
```
public DescribeDevicePositionResponse DescribeDevicePosition(DescribeDevicePositionRequest req)
                                                      throws TencentCloudSDKException
```
    查询服务器所在的位置，如机架，上联交换机等信息
    
    Parameters:
    
    req - DescribeDevicePositionRequest
    
    Returns:
    
    DescribeDevicePositionResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeDevicePriceInfo
```
public DescribeDevicePriceInfoResponse DescribeDevicePriceInfo(DescribeDevicePriceInfoRequest req)
                                                        throws TencentCloudSDKException
```
    查询服务器价格信息，支持设备的批量查找，支持标准机型和弹性机型的混合查找
    
    Parameters:
    
    req - DescribeDevicePriceInfoRequest
    
    Returns:
    
    DescribeDevicePriceInfoResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeDevices
```
public DescribeDevicesResponse DescribeDevices(DescribeDevicesRequest req)
                                        throws TencentCloudSDKException
```
    查询物理服务器，可以按照实例，业务IP等过滤
    
    Parameters:
    
    req - DescribeDevicesRequest
    
    Returns:
    
    DescribeDevicesResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeOsInfo
```
public DescribeOsInfoResponse DescribeOsInfo(DescribeOsInfoRequest req)
                                      throws TencentCloudSDKException
```
    查询指定机型所支持的操作系统
    
    Parameters:
    
    req - DescribeOsInfoRequest
    
    Returns:
    
    DescribeOsInfoResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribePsaRegulations
```
public DescribePsaRegulationsResponse DescribePsaRegulations(DescribePsaRegulationsRequest req)
                                                      throws TencentCloudSDKException
```
    获取预授权规则列表
    
    Parameters:
    
    req - DescribePsaRegulationsRequest
    
    Returns:
    
    DescribePsaRegulationsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeRepairTaskConstant
```
public DescribeRepairTaskConstantResponse DescribeRepairTaskConstant(DescribeRepairTaskConstantRequest req)
                                                              throws TencentCloudSDKException
```
    维修任务配置获取
    
    Parameters:
    
    req - DescribeRepairTaskConstantRequest
    
    Returns:
    
    DescribeRepairTaskConstantResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeTaskInfo
```
public DescribeTaskInfoResponse DescribeTaskInfo(DescribeTaskInfoRequest req)
                                          throws TencentCloudSDKException
```
    获取用户维修任务列表及详细信息
    
    TaskStatus（任务状态ID）与状态中文名的对应关系如下：
    1：未授权
    2：处理中
    3：待确认
    4：未授权-暂不处理
    5：已恢复
    6：待确认-未恢复
    
    Parameters:
    
    req - DescribeTaskInfoRequest
    
    Returns:
    
    DescribeTaskInfoResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeTaskOperationLog
```
public DescribeTaskOperationLogResponse DescribeTaskOperationLog(DescribeTaskOperationLogRequest req)
                                                          throws TencentCloudSDKException
```
    获取维修任务操作日志
    
    Parameters:
    
    req - DescribeTaskOperationLogRequest
    
    Returns:
    
    DescribeTaskOperationLogResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeUserCmdTaskInfo
```
public DescribeUserCmdTaskInfoResponse DescribeUserCmdTaskInfo(DescribeUserCmdTaskInfoRequest req)
                                                        throws TencentCloudSDKException
```
    获取自定义脚本任务详细信息
    
    Parameters:
    
    req - DescribeUserCmdTaskInfoRequest
    
    Returns:
    
    DescribeUserCmdTaskInfoResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeUserCmdTasks
```
public DescribeUserCmdTasksResponse DescribeUserCmdTasks(DescribeUserCmdTasksRequest req)
                                                  throws TencentCloudSDKException
```
    获取自定义脚本任务列表
    
    Parameters:
    
    req - DescribeUserCmdTasksRequest
    
    Returns:
    
    DescribeUserCmdTasksResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeUserCmds
```
public DescribeUserCmdsResponse DescribeUserCmds(DescribeUserCmdsRequest req)
                                          throws TencentCloudSDKException
```
    获取自定义脚本信息列表
    
    Parameters:
    
    req - DescribeUserCmdsRequest
    
    Returns:
    
    DescribeUserCmdsResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyDeviceAliases
```
public ModifyDeviceAliasesResponse ModifyDeviceAliases(ModifyDeviceAliasesRequest req)
                                                throws TencentCloudSDKException
```
    修改服务器名称
    
    Parameters:
    
    req - ModifyDeviceAliasesRequest
    
    Returns:
    
    ModifyDeviceAliasesResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyDeviceAutoRenewFlag
```
public ModifyDeviceAutoRenewFlagResponse ModifyDeviceAutoRenewFlag(ModifyDeviceAutoRenewFlagRequest req)
                                                            throws TencentCloudSDKException
```
    修改物理机服务器自动续费标志
    
    Parameters:
    
    req - ModifyDeviceAutoRenewFlagRequest
    
    Returns:
    
    ModifyDeviceAutoRenewFlagResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyPayModePre2Post
```
public ModifyPayModePre2PostResponse ModifyPayModePre2Post(ModifyPayModePre2PostRequest req)
                                                    throws TencentCloudSDKException
```
    将设备的预付费模式修改为后付费计费模式，支持批量转换。（前提是客户要加入黑石物理机后付费计费的白名单，申请黑石物理机后付费可以联系腾讯云客服）
    
    Parameters:
    
    req - ModifyPayModePre2PostRequest
    
    Returns:
    
    ModifyPayModePre2PostResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyPsaRegulation
```
public ModifyPsaRegulationResponse ModifyPsaRegulation(ModifyPsaRegulationRequest req)
                                                throws TencentCloudSDKException
```
    允许修改规则信息及关联故障类型
    
    Parameters:
    
    req - ModifyPsaRegulationRequest
    
    Returns:
    
    ModifyPsaRegulationResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyUserCmd
```
public ModifyUserCmdResponse ModifyUserCmd(ModifyUserCmdRequest req)
                                    throws TencentCloudSDKException
```
    修改自定义脚本
    
    Parameters:
    
    req - ModifyUserCmdRequest
    
    Returns:
    
    ModifyUserCmdResponse
    
    Throws:
    
    TencentCloudSDKException
  - OfflineDevices
```
public OfflineDevicesResponse OfflineDevices(OfflineDevicesRequest req)
                                      throws TencentCloudSDKException
```
    用于销毁可退还的服务器
    
    Parameters:
    
    req - OfflineDevicesRequest
    
    Returns:
    
    OfflineDevicesResponse
    
    Throws:
    
    TencentCloudSDKException
  - RebootDevices
```
public RebootDevicesResponse RebootDevices(RebootDevicesRequest req)
                                    throws TencentCloudSDKException
```
    重启机器
    
    Parameters:
    
    req - RebootDevicesRequest
    
    Returns:
    
    RebootDevicesResponse
    
    Throws:
    
    TencentCloudSDKException
  - RepairTaskControl
```
public RepairTaskControlResponse RepairTaskControl(RepairTaskControlRequest req)
                                            throws TencentCloudSDKException
```
    此接口用于操作维修任务
    入参TaskId为维修任务ID
    入参Operate表示对维修任务的操作，支持如下取值：
    AuthorizeRepair（授权维修）
    Ignore（暂不提醒）
    ConfirmRecovered（维修完成后，确认故障恢复）
    ConfirmUnRecovered（维修完成后，确认故障未恢复）
    
    操作约束（当前任务状态(TaskStatus)->对应可执行的操作）：
    未授权(1)->授权维修；暂不处理
    暂不处理(4)->授权维修
    待确认(3)->确认故障恢复；确认故障未恢复
    未恢复(6)->确认故障恢复
    
    对于Ping不可达故障的任务，还允许：
    未授权->确认故障恢复
    暂不处理->确认故障恢复
    
    处理中与已恢复状态的任务不允许进行操作。
    
    详细信息请访问：https://cloud.tencent.com/document/product/386/18190
    
    Parameters:
    
    req - RepairTaskControlRequest
    
    Returns:
    
    RepairTaskControlResponse
    
    Throws:
    
    TencentCloudSDKException
  - ResetDevicePassword
```
public ResetDevicePasswordResponse ResetDevicePassword(ResetDevicePasswordRequest req)
                                                throws TencentCloudSDKException
```
    重置服务器密码
    
    Parameters:
    
    req - ResetDevicePasswordRequest
    
    Returns:
    
    ResetDevicePasswordResponse
    
    Throws:
    
    TencentCloudSDKException
  - RunUserCmd
```
public RunUserCmdResponse RunUserCmd(RunUserCmdRequest req)
                              throws TencentCloudSDKException
```
    运行自定义脚本
    
    Parameters:
    
    req - RunUserCmdRequest
    
    Returns:
    
    RunUserCmdResponse
    
    Throws:
    
    TencentCloudSDKException
  - SetOutBandVpnAuthPassword
```
public SetOutBandVpnAuthPasswordResponse SetOutBandVpnAuthPassword(SetOutBandVpnAuthPasswordRequest req)
                                                            throws TencentCloudSDKException
```
    设置带外VPN认证用户密码
    
    Parameters:
    
    req - SetOutBandVpnAuthPasswordRequest
    
    Returns:
    
    SetOutBandVpnAuthPasswordResponse
    
    Throws:
    
    TencentCloudSDKException
  - UnbindPsaTag
```
public UnbindPsaTagResponse UnbindPsaTag(UnbindPsaTagRequest req)
                                  throws TencentCloudSDKException
```
    解除标签与预授权规则的绑定
    
    Parameters:
    
    req - UnbindPsaTagRequest
    
    Returns:
    
    UnbindPsaTagResponse
    
    Throws:
    
    TencentCloudSDKException

Class BmClient

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

BmClient

BmClient

Method Detail

BindPsaTag

CreatePsaRegulation

CreateSpotDevice

CreateUserCmd

DeletePsaRegulation

DeleteUserCmds

DescribeDeviceClass

DescribeDeviceInventory

DescribeDeviceOperationLog

DescribeDevicePosition

DescribeDevicePriceInfo

DescribeDevices

DescribeOsInfo

DescribePsaRegulations

DescribeRepairTaskConstant

DescribeTaskInfo

DescribeTaskOperationLog

DescribeUserCmdTaskInfo

DescribeUserCmdTasks

DescribeUserCmds

ModifyDeviceAliases

ModifyDeviceAutoRenewFlag

ModifyPayModePre2Post

ModifyPsaRegulation

ModifyUserCmd

OfflineDevices

RebootDevices

RepairTaskControl

ResetDevicePassword

RunUserCmd

SetOutBandVpnAuthPassword

UnbindPsaTag