IotexplorerClient (tencentcloud-sdk-java 3.1.314 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractClient
- - com.tencentcloudapi.iotexplorer.v20190423.IotexplorerClient

public class IotexplorerClient
extends AbstractClient

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

Constructor Summary

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CallDeviceActionAsyncResponse`	`CallDeviceActionAsync(CallDeviceActionAsyncRequest req)` 提供给用户异步调用设备行为的能力
`CallDeviceActionSyncResponse`	`CallDeviceActionSync(CallDeviceActionSyncRequest req)` 为用户提供同步调用设备行为的能力。
`ControlDeviceDataResponse`	`ControlDeviceData(ControlDeviceDataRequest req)` 根据设备产品ID、设备名称，设置控制设备的属性数据。
`CreateDeviceResponse`	`CreateDevice(CreateDeviceRequest req)` 创建设备
`CreateLoRaFrequencyResponse`	`CreateLoRaFrequency(CreateLoRaFrequencyRequest req)` 创建 LoRa 自定义频点
`CreateLoRaGatewayResponse`	`CreateLoRaGateway(CreateLoRaGatewayRequest req)` 创建新 LoRa 网关设备接口
`CreateProjectResponse`	`CreateProject(CreateProjectRequest req)` 为用户提供新建项目的能力，用于集中管理产品和应用。
`CreateStudioProductResponse`	`CreateStudioProduct(CreateStudioProductRequest req)` 为用户提供新建产品的能力，用于管理用户的设备
`CreateTopicRuleResponse`	`CreateTopicRule(CreateTopicRuleRequest req)` 创建规则
`DeleteDeviceResponse`	`DeleteDevice(DeleteDeviceRequest req)` 删除设备
`DeleteLoRaFrequencyResponse`	`DeleteLoRaFrequency(DeleteLoRaFrequencyRequest req)` 提供删除LoRa自定义频点的能力
`DeleteLoRaGatewayResponse`	`DeleteLoRaGateway(DeleteLoRaGatewayRequest req)` 删除 LoRa 网关的接口
`DeleteProjectResponse`	`DeleteProject(DeleteProjectRequest req)` 提供删除某个项目的能力
`DeleteStudioProductResponse`	`DeleteStudioProduct(DeleteStudioProductRequest req)` 提供删除某个项目下产品的能力
`DeleteTopicRuleResponse`	`DeleteTopicRule(DeleteTopicRuleRequest req)` 删除规则
`DescribeDeviceResponse`	`DescribeDevice(DescribeDeviceRequest req)` 用于查看某个设备的详细信息
`DescribeDeviceDataResponse`	`DescribeDeviceData(DescribeDeviceDataRequest req)` 根据设备产品ID、设备名称，获取设备上报的属性数据。
`DescribeDeviceDataHistoryResponse`	`DescribeDeviceDataHistory(DescribeDeviceDataHistoryRequest req)` 获取设备在指定时间范围内上报的历史数据。
`DescribeFirmwareTaskResponse`	`DescribeFirmwareTask(DescribeFirmwareTaskRequest req)` 查询固件升级任务列表
`DescribeLoRaFrequencyResponse`	`DescribeLoRaFrequency(DescribeLoRaFrequencyRequest req)` 提供查询LoRa自定义频点详情的能力
`DescribeModelDefinitionResponse`	`DescribeModelDefinition(DescribeModelDefinitionRequest req)` 查询产品配置的数据模板信息
`DescribeProjectResponse`	`DescribeProject(DescribeProjectRequest req)` 查询项目详情
`DescribeStudioProductResponse`	`DescribeStudioProduct(DescribeStudioProductRequest req)` 提供查看产品详细信息的能力，包括产品的ID、数据协议、认证类型等重要参数
`DescribeTopicRuleResponse`	`DescribeTopicRule(DescribeTopicRuleRequest req)` 获取规则信息
`DisableTopicRuleResponse`	`DisableTopicRule(DisableTopicRuleRequest req)` 禁用规则
`EnableTopicRuleResponse`	`EnableTopicRule(EnableTopicRuleRequest req)` 启用规则
`GetCOSURLResponse`	`GetCOSURL(GetCOSURLRequest req)` 本接口（GetCOSURL）用于获取固件存储在COS的URL
`GetDeviceListResponse`	`GetDeviceList(GetDeviceListRequest req)` 用于查询某个产品下的设备列表
`GetLoRaGatewayListResponse`	`GetLoRaGatewayList(GetLoRaGatewayListRequest req)` 获取 LoRa 网关列表接口
`GetProjectListResponse`	`GetProjectList(GetProjectListRequest req)` 提供查询用户所创建的项目列表查询功能。
`GetStudioProductListResponse`	`GetStudioProductList(GetStudioProductListRequest req)` 提供查询某个项目下所有产品信息的能力。
`GetTopicRuleListResponse`	`GetTopicRuleList(GetTopicRuleListRequest req)` 获取规则列表
`ListEventHistoryResponse`	`ListEventHistory(ListEventHistoryRequest req)` 获取设备的历史事件
`ListFirmwaresResponse`	`ListFirmwares(ListFirmwaresRequest req)` 本接口（ListFirmwares）用于获取固件列表
`ModifyLoRaFrequencyResponse`	`ModifyLoRaFrequency(ModifyLoRaFrequencyRequest req)` 修改LoRa自定义频点
`ModifyLoRaGatewayResponse`	`ModifyLoRaGateway(ModifyLoRaGatewayRequest req)` 修改 LoRa 网关信息
`ModifyModelDefinitionResponse`	`ModifyModelDefinition(ModifyModelDefinitionRequest req)` 提供修改产品的数据模板的能力
`ModifyProjectResponse`	`ModifyProject(ModifyProjectRequest req)` 修改项目
`ModifyStudioProductResponse`	`ModifyStudioProduct(ModifyStudioProductRequest req)` 提供修改产品的名称和描述等信息的能力，对于已发布产品不允许进行修改。
`ModifyTopicRuleResponse`	`ModifyTopicRule(ModifyTopicRuleRequest req)` 修改规则
`PublishMessageResponse`	`PublishMessage(PublishMessageRequest req)` 本接口（PublishMessage）用于使用自定义透传协议进行设备远控
`ReleaseStudioProductResponse`	`ReleaseStudioProduct(ReleaseStudioProductRequest req)` 产品开发完成并测试通过后，通过发布产品将产品设置为发布状态
`SearchStudioProductResponse`	`SearchStudioProduct(SearchStudioProductRequest req)` 提供根据产品名称查找产品的能力
`SearchTopicRuleResponse`	`SearchTopicRule(SearchTopicRuleRequest req)` 搜索规则
`UpdateFirmwareResponse`	`UpdateFirmware(UpdateFirmwareRequest req)` 本接口（UpdateFirmware）用于对指定设备发起固件升级请求
`UploadFirmwareResponse`	`UploadFirmware(UploadFirmwareRequest req)` 本接口（UploadFirmware）用于上传设备固件至平台

Methods inherited from class com.tencentcloudapi.common.AbstractClient
call, 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

IotexplorerClient

public IotexplorerClient(Credential credential,
                         String region)

IotexplorerClient

public IotexplorerClient(Credential credential,
                         String region,
                         ClientProfile profile)

Method Detail

CallDeviceActionAsync

public CallDeviceActionAsyncResponse CallDeviceActionAsync(CallDeviceActionAsyncRequest req)
                                                    throws TencentCloudSDKException

提供给用户异步调用设备行为的能力

Parameters:: req - CallDeviceActionAsyncRequest
Returns:: CallDeviceActionAsyncResponse
Throws:: TencentCloudSDKException

CallDeviceActionSync

public CallDeviceActionSyncResponse CallDeviceActionSync(CallDeviceActionSyncRequest req)
                                                  throws TencentCloudSDKException

为用户提供同步调用设备行为的能力。

Parameters:: req - CallDeviceActionSyncRequest
Returns:: CallDeviceActionSyncResponse
Throws:: TencentCloudSDKException

ControlDeviceData
```
public ControlDeviceDataResponse ControlDeviceData(ControlDeviceDataRequest req)
                                            throws TencentCloudSDKException
```
根据设备产品ID、设备名称，设置控制设备的属性数据。

Parameters:

req - ControlDeviceDataRequest

Returns:

ControlDeviceDataResponse

Throws:

TencentCloudSDKException

CreateDevice

public CreateDeviceResponse CreateDevice(CreateDeviceRequest req)
                                  throws TencentCloudSDKException

创建设备

Parameters:: req - CreateDeviceRequest
Returns:: CreateDeviceResponse
Throws:: TencentCloudSDKException

CreateLoRaFrequency

public CreateLoRaFrequencyResponse CreateLoRaFrequency(CreateLoRaFrequencyRequest req)
                                                throws TencentCloudSDKException

创建 LoRa 自定义频点

Parameters:: req - CreateLoRaFrequencyRequest
Returns:: CreateLoRaFrequencyResponse
Throws:: TencentCloudSDKException

CreateLoRaGateway

public CreateLoRaGatewayResponse CreateLoRaGateway(CreateLoRaGatewayRequest req)
                                            throws TencentCloudSDKException

创建新 LoRa 网关设备接口

Parameters:: req - CreateLoRaGatewayRequest
Returns:: CreateLoRaGatewayResponse
Throws:: TencentCloudSDKException

CreateProject
```
public CreateProjectResponse CreateProject(CreateProjectRequest req)
                                    throws TencentCloudSDKException
```
为用户提供新建项目的能力，用于集中管理产品和应用。

Parameters:

req - CreateProjectRequest

Returns:

CreateProjectResponse

Throws:

TencentCloudSDKException

CreateStudioProduct
```
public CreateStudioProductResponse CreateStudioProduct(CreateStudioProductRequest req)
                                                throws TencentCloudSDKException
```
为用户提供新建产品的能力，用于管理用户的设备

Parameters:

req - CreateStudioProductRequest

Returns:

CreateStudioProductResponse

Throws:

TencentCloudSDKException

CreateTopicRule

public CreateTopicRuleResponse CreateTopicRule(CreateTopicRuleRequest req)
                                        throws TencentCloudSDKException

创建规则

Parameters:: req - CreateTopicRuleRequest
Returns:: CreateTopicRuleResponse
Throws:: TencentCloudSDKException

DeleteDevice

public DeleteDeviceResponse DeleteDevice(DeleteDeviceRequest req)
                                  throws TencentCloudSDKException

删除设备

Parameters:: req - DeleteDeviceRequest
Returns:: DeleteDeviceResponse
Throws:: TencentCloudSDKException

DeleteLoRaFrequency

public DeleteLoRaFrequencyResponse DeleteLoRaFrequency(DeleteLoRaFrequencyRequest req)
                                                throws TencentCloudSDKException

提供删除LoRa自定义频点的能力

Parameters:: req - DeleteLoRaFrequencyRequest
Returns:: DeleteLoRaFrequencyResponse
Throws:: TencentCloudSDKException

DeleteLoRaGateway

public DeleteLoRaGatewayResponse DeleteLoRaGateway(DeleteLoRaGatewayRequest req)
                                            throws TencentCloudSDKException

删除 LoRa 网关的接口

Parameters:: req - DeleteLoRaGatewayRequest
Returns:: DeleteLoRaGatewayResponse
Throws:: TencentCloudSDKException

DeleteProject

public DeleteProjectResponse DeleteProject(DeleteProjectRequest req)
                                    throws TencentCloudSDKException

提供删除某个项目的能力

Parameters:: req - DeleteProjectRequest
Returns:: DeleteProjectResponse
Throws:: TencentCloudSDKException

DeleteStudioProduct

public DeleteStudioProductResponse DeleteStudioProduct(DeleteStudioProductRequest req)
                                                throws TencentCloudSDKException

提供删除某个项目下产品的能力

Parameters:: req - DeleteStudioProductRequest
Returns:: DeleteStudioProductResponse
Throws:: TencentCloudSDKException

DeleteTopicRule

public DeleteTopicRuleResponse DeleteTopicRule(DeleteTopicRuleRequest req)
                                        throws TencentCloudSDKException

删除规则

Parameters:: req - DeleteTopicRuleRequest
Returns:: DeleteTopicRuleResponse
Throws:: TencentCloudSDKException

DescribeDevice

public DescribeDeviceResponse DescribeDevice(DescribeDeviceRequest req)
                                      throws TencentCloudSDKException

用于查看某个设备的详细信息

Parameters:: req - DescribeDeviceRequest
Returns:: DescribeDeviceResponse
Throws:: TencentCloudSDKException

DescribeDeviceData
```
public DescribeDeviceDataResponse DescribeDeviceData(DescribeDeviceDataRequest req)
                                              throws TencentCloudSDKException
```
根据设备产品ID、设备名称，获取设备上报的属性数据。

Parameters:

req - DescribeDeviceDataRequest

Returns:

DescribeDeviceDataResponse

Throws:

TencentCloudSDKException

DescribeDeviceDataHistory

public DescribeDeviceDataHistoryResponse DescribeDeviceDataHistory(DescribeDeviceDataHistoryRequest req)
                                                            throws TencentCloudSDKException

获取设备在指定时间范围内上报的历史数据。

Parameters:: req - DescribeDeviceDataHistoryRequest
Returns:: DescribeDeviceDataHistoryResponse
Throws:: TencentCloudSDKException

DescribeFirmwareTask

public DescribeFirmwareTaskResponse DescribeFirmwareTask(DescribeFirmwareTaskRequest req)
                                                  throws TencentCloudSDKException

查询固件升级任务列表

Parameters:: req - DescribeFirmwareTaskRequest
Returns:: DescribeFirmwareTaskResponse
Throws:: TencentCloudSDKException

DescribeLoRaFrequency

public DescribeLoRaFrequencyResponse DescribeLoRaFrequency(DescribeLoRaFrequencyRequest req)
                                                    throws TencentCloudSDKException

提供查询LoRa自定义频点详情的能力

Parameters:: req - DescribeLoRaFrequencyRequest
Returns:: DescribeLoRaFrequencyResponse
Throws:: TencentCloudSDKException

DescribeModelDefinition

public DescribeModelDefinitionResponse DescribeModelDefinition(DescribeModelDefinitionRequest req)
                                                        throws TencentCloudSDKException

查询产品配置的数据模板信息

Parameters:: req - DescribeModelDefinitionRequest
Returns:: DescribeModelDefinitionResponse
Throws:: TencentCloudSDKException

DescribeProject

public DescribeProjectResponse DescribeProject(DescribeProjectRequest req)
                                        throws TencentCloudSDKException

查询项目详情

Parameters:: req - DescribeProjectRequest
Returns:: DescribeProjectResponse
Throws:: TencentCloudSDKException

DescribeStudioProduct
```
public DescribeStudioProductResponse DescribeStudioProduct(DescribeStudioProductRequest req)
                                                    throws TencentCloudSDKException
```
提供查看产品详细信息的能力，包括产品的ID、数据协议、认证类型等重要参数

Parameters:

req - DescribeStudioProductRequest

Returns:

DescribeStudioProductResponse

Throws:

TencentCloudSDKException

DescribeTopicRule

public DescribeTopicRuleResponse DescribeTopicRule(DescribeTopicRuleRequest req)
                                            throws TencentCloudSDKException

获取规则信息

Parameters:: req - DescribeTopicRuleRequest
Returns:: DescribeTopicRuleResponse
Throws:: TencentCloudSDKException

DisableTopicRule

public DisableTopicRuleResponse DisableTopicRule(DisableTopicRuleRequest req)
                                          throws TencentCloudSDKException

禁用规则

Parameters:: req - DisableTopicRuleRequest
Returns:: DisableTopicRuleResponse
Throws:: TencentCloudSDKException

EnableTopicRule

public EnableTopicRuleResponse EnableTopicRule(EnableTopicRuleRequest req)
                                        throws TencentCloudSDKException

启用规则

Parameters:: req - EnableTopicRuleRequest
Returns:: EnableTopicRuleResponse
Throws:: TencentCloudSDKException

GetCOSURL
```
public GetCOSURLResponse GetCOSURL(GetCOSURLRequest req)
                            throws TencentCloudSDKException
```
本接口（GetCOSURL）用于获取固件存储在COS的URL

Parameters:

req - GetCOSURLRequest

Returns:

GetCOSURLResponse

Throws:

TencentCloudSDKException

GetDeviceList
```
public GetDeviceListResponse GetDeviceList(GetDeviceListRequest req)
                                    throws TencentCloudSDKException
```
用于查询某个产品下的设备列表

Parameters:

req - GetDeviceListRequest

Returns:

GetDeviceListResponse

Throws:

TencentCloudSDKException

GetLoRaGatewayList

public GetLoRaGatewayListResponse GetLoRaGatewayList(GetLoRaGatewayListRequest req)
                                              throws TencentCloudSDKException

获取 LoRa 网关列表接口

Parameters:: req - GetLoRaGatewayListRequest
Returns:: GetLoRaGatewayListResponse
Throws:: TencentCloudSDKException

GetProjectList
```
public GetProjectListResponse GetProjectList(GetProjectListRequest req)
                                      throws TencentCloudSDKException
```
提供查询用户所创建的项目列表查询功能。

Parameters:

req - GetProjectListRequest

Returns:

GetProjectListResponse

Throws:

TencentCloudSDKException

GetStudioProductList
```
public GetStudioProductListResponse GetStudioProductList(GetStudioProductListRequest req)
                                                  throws TencentCloudSDKException
```
提供查询某个项目下所有产品信息的能力。

Parameters:

req - GetStudioProductListRequest

Returns:

GetStudioProductListResponse

Throws:

TencentCloudSDKException

GetTopicRuleList

public GetTopicRuleListResponse GetTopicRuleList(GetTopicRuleListRequest req)
                                          throws TencentCloudSDKException

获取规则列表

Parameters:: req - GetTopicRuleListRequest
Returns:: GetTopicRuleListResponse
Throws:: TencentCloudSDKException

ListEventHistory

public ListEventHistoryResponse ListEventHistory(ListEventHistoryRequest req)
                                          throws TencentCloudSDKException

获取设备的历史事件

Parameters:: req - ListEventHistoryRequest
Returns:: ListEventHistoryResponse
Throws:: TencentCloudSDKException

ListFirmwares
```
public ListFirmwaresResponse ListFirmwares(ListFirmwaresRequest req)
                                    throws TencentCloudSDKException
```
本接口（ListFirmwares）用于获取固件列表

Parameters:

req - ListFirmwaresRequest

Returns:

ListFirmwaresResponse

Throws:

TencentCloudSDKException

ModifyLoRaFrequency

public ModifyLoRaFrequencyResponse ModifyLoRaFrequency(ModifyLoRaFrequencyRequest req)
                                                throws TencentCloudSDKException

修改LoRa自定义频点

Parameters:: req - ModifyLoRaFrequencyRequest
Returns:: ModifyLoRaFrequencyResponse
Throws:: TencentCloudSDKException

ModifyLoRaGateway

public ModifyLoRaGatewayResponse ModifyLoRaGateway(ModifyLoRaGatewayRequest req)
                                            throws TencentCloudSDKException

修改 LoRa 网关信息

Parameters:: req - ModifyLoRaGatewayRequest
Returns:: ModifyLoRaGatewayResponse
Throws:: TencentCloudSDKException

ModifyModelDefinition

public ModifyModelDefinitionResponse ModifyModelDefinition(ModifyModelDefinitionRequest req)
                                                    throws TencentCloudSDKException

提供修改产品的数据模板的能力

Parameters:: req - ModifyModelDefinitionRequest
Returns:: ModifyModelDefinitionResponse
Throws:: TencentCloudSDKException

ModifyProject

public ModifyProjectResponse ModifyProject(ModifyProjectRequest req)
                                    throws TencentCloudSDKException

修改项目

Parameters:: req - ModifyProjectRequest
Returns:: ModifyProjectResponse
Throws:: TencentCloudSDKException

ModifyStudioProduct
```
public ModifyStudioProductResponse ModifyStudioProduct(ModifyStudioProductRequest req)
                                                throws TencentCloudSDKException
```
提供修改产品的名称和描述等信息的能力，对于已发布产品不允许进行修改。

Parameters:

req - ModifyStudioProductRequest

Returns:

ModifyStudioProductResponse

Throws:

TencentCloudSDKException

ModifyTopicRule

public ModifyTopicRuleResponse ModifyTopicRule(ModifyTopicRuleRequest req)
                                        throws TencentCloudSDKException

修改规则

Parameters:: req - ModifyTopicRuleRequest
Returns:: ModifyTopicRuleResponse
Throws:: TencentCloudSDKException

PublishMessage
```
public PublishMessageResponse PublishMessage(PublishMessageRequest req)
                                      throws TencentCloudSDKException
```
本接口（PublishMessage）用于使用自定义透传协议进行设备远控

Parameters:

req - PublishMessageRequest

Returns:

PublishMessageResponse

Throws:

TencentCloudSDKException

ReleaseStudioProduct
```
public ReleaseStudioProductResponse ReleaseStudioProduct(ReleaseStudioProductRequest req)
                                                  throws TencentCloudSDKException
```
产品开发完成并测试通过后，通过发布产品将产品设置为发布状态

Parameters:

req - ReleaseStudioProductRequest

Returns:

ReleaseStudioProductResponse

Throws:

TencentCloudSDKException

SearchStudioProduct

public SearchStudioProductResponse SearchStudioProduct(SearchStudioProductRequest req)
                                                throws TencentCloudSDKException

提供根据产品名称查找产品的能力

Parameters:: req - SearchStudioProductRequest
Returns:: SearchStudioProductResponse
Throws:: TencentCloudSDKException

SearchTopicRule

public SearchTopicRuleResponse SearchTopicRule(SearchTopicRuleRequest req)
                                        throws TencentCloudSDKException

搜索规则

Parameters:: req - SearchTopicRuleRequest
Returns:: SearchTopicRuleResponse
Throws:: TencentCloudSDKException

UpdateFirmware
```
public UpdateFirmwareResponse UpdateFirmware(UpdateFirmwareRequest req)
                                      throws TencentCloudSDKException
```
本接口（UpdateFirmware）用于对指定设备发起固件升级请求

Parameters:

req - UpdateFirmwareRequest

Returns:

UpdateFirmwareResponse

Throws:

TencentCloudSDKException

UploadFirmware
```
public UploadFirmwareResponse UploadFirmware(UploadFirmwareRequest req)
                                      throws TencentCloudSDKException
```
本接口（UploadFirmware）用于上传设备固件至平台

Parameters:

req - UploadFirmwareRequest

Returns:

UploadFirmwareResponse

Throws:

TencentCloudSDKException

Class IotexplorerClient

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

IotexplorerClient

IotexplorerClient

Method Detail

CallDeviceActionAsync

CallDeviceActionSync

ControlDeviceData

CreateDevice

CreateLoRaFrequency

CreateLoRaGateway

CreateProject

CreateStudioProduct

CreateTopicRule

DeleteDevice

DeleteLoRaFrequency

DeleteLoRaGateway

DeleteProject

DeleteStudioProduct

DeleteTopicRule

DescribeDevice

DescribeDeviceData

DescribeDeviceDataHistory

DescribeFirmwareTask

DescribeLoRaFrequency

DescribeModelDefinition

DescribeProject

DescribeStudioProduct

DescribeTopicRule

DisableTopicRule

EnableTopicRule

GetCOSURL

GetDeviceList

GetLoRaGatewayList

GetProjectList

GetStudioProductList

GetTopicRuleList

ListEventHistory

ListFirmwares

ModifyLoRaFrequency

ModifyLoRaGateway

ModifyModelDefinition

ModifyProject

ModifyStudioProduct

ModifyTopicRule

PublishMessage

ReleaseStudioProduct

SearchStudioProduct

SearchTopicRule

UpdateFirmware

UploadFirmware