com.tencentcloudapi.cwp.v20180228.models

Class DescribeMachinesRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.cwp.v20180228.models.DescribeMachinesRequest

public class DescribeMachinesRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
DescribeMachinesRequest()
DescribeMachinesRequest(DescribeMachinesRequest source) NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

Method Summary

Modifier and Type	Method and Description
Filter[]	getFilters() Get Filter criteria Ips - String - required: no - query by IP Names - String - required: no - query by instance name InstanceIds - String - required: no - instance ID for query Status - String - required: no - client online status (OFFLINE: offline/shut down | ONLINE: online | UNINSTALLED: not installed | AGENT_OFFLINE: agent offline | AGENT_SHUTDOWN: agent shut down) Version - String required: no - current edition ( PRO_VERSION: Pro Edition | BASIC_VERSION: Basic Edition | Flagship: Ultimate Edition | ProtectedMachines: Pro + Ultimate Editions) Risk - String - required: no - risky host (yes) Os - String - required: no - operating system (value of DescribeMachineOsList) Each filter criterion supports only one value.
Long	getLimit() Get Number of returns.
String	getMachineRegion() Get Machine region.
String	getMachineType() Get Type of the machine's zone CVM: Cloud Virtual Machine BM: BMECM: Edge Computing Machine LH: Lighthouse Other: Hybrid Cloud Zone
Long	getOffset() Get Offset.
Long[]	getProjectIds() Get ID List of Businesses to which machines belong
void	setFilters(Filter[] Filters) Set Filter criteria Ips - String - required: no - query by IP Names - String - required: no - query by instance name InstanceIds - String - required: no - instance ID for query Status - String - required: no - client online status (OFFLINE: offline/shut down | ONLINE: online | UNINSTALLED: not installed | AGENT_OFFLINE: agent offline | AGENT_SHUTDOWN: agent shut down) Version - String required: no - current edition ( PRO_VERSION: Pro Edition | BASIC_VERSION: Basic Edition | Flagship: Ultimate Edition | ProtectedMachines: Pro + Ultimate Editions) Risk - String - required: no - risky host (yes) Os - String - required: no - operating system (value of DescribeMachineOsList) Each filter criterion supports only one value.
void	setLimit(Long Limit) Set Number of returns.
void	setMachineRegion(String MachineRegion) Set Machine region.
void	setMachineType(String MachineType) Set Type of the machine's zone CVM: Cloud Virtual Machine BM: BMECM: Edge Computing Machine LH: Lighthouse Other: Hybrid Cloud Zone
void	setOffset(Long Offset) Set Offset.
void	setProjectIds(Long[] ProjectIds) Set ID List of Businesses to which machines belong
void	toMap(HashMap<String,String> map, String prefix) Internal implementation, normal users should not use it.

Methods inherited from class com.tencentcloudapi.common.AbstractModel

any, fromJsonString, getBinaryParams, GetHeader, getMultipartRequestParams, getSkipSign, isStream, set, SetHeader, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, setSkipSign, toJsonString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DescribeMachinesRequest

public DescribeMachinesRequest()

DescribeMachinesRequest

public DescribeMachinesRequest(DescribeMachinesRequest source)

NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

Method Detail

getMachineType

public String getMachineType()

Get Type of the machine's zone CVM: Cloud Virtual Machine BM: BMECM: Edge Computing Machine LH: Lighthouse Other: Hybrid Cloud Zone

Returns:

MachineType Type of the machine's zone CVM: Cloud Virtual Machine BM: BMECM: Edge Computing Machine LH: Lighthouse Other: Hybrid Cloud Zone

setMachineType

public void setMachineType(String MachineType)

Set Type of the machine's zone CVM: Cloud Virtual Machine BM: BMECM: Edge Computing Machine LH: Lighthouse Other: Hybrid Cloud Zone

Parameters:

MachineType - Type of the machine's zone CVM: Cloud Virtual Machine BM: BMECM: Edge Computing Machine LH: Lighthouse Other: Hybrid Cloud Zone

getMachineRegion

public String getMachineRegion()

Get Machine region. For example, ap-guangzhou and ap-shanghai.

Returns:

MachineRegion Machine region. For example, ap-guangzhou and ap-shanghai.

setMachineRegion

public void setMachineRegion(String MachineRegion)

Set Machine region. For example, ap-guangzhou and ap-shanghai.

Parameters:

MachineRegion - Machine region. For example, ap-guangzhou and ap-shanghai.

getLimit

public Long getLimit()

Get Number of returns. It is 10 by default, and the maximum value is 100.

Returns:

Limit Number of returns. It is 10 by default, and the maximum value is 100.

setLimit

public void setLimit(Long Limit)

Set Number of returns. It is 10 by default, and the maximum value is 100.

Parameters:

Limit - Number of returns. It is 10 by default, and the maximum value is 100.

getOffset

public Long getOffset()

Get Offset. Default value: 0.

Returns:

Offset Offset. Default value: 0.

setOffset

public void setOffset(Long Offset)

Set Offset. Default value: 0.

Parameters:

Offset - Offset. Default value: 0.

getFilters

public Filter[] getFilters()

Get Filter criteria

Ips - String - required: no - query by IP Names - String - required: no - query by instance name InstanceIds - String - required: no - instance ID for query Status - String - required: no - client online status (OFFLINE: offline/shut down | ONLINE: online | UNINSTALLED: not installed | AGENT_OFFLINE: agent offline | AGENT_SHUTDOWN: agent shut down) Version - String required: no - current edition ( PRO_VERSION: Pro Edition | BASIC_VERSION: Basic Edition | Flagship: Ultimate Edition | ProtectedMachines: Pro + Ultimate Editions) Risk - String - required: no - risky host (yes) Os - String - required: no - operating system (value of DescribeMachineOsList) Each filter criterion supports only one value. Quuid - String - required: no - CVM instance UUID. Maximum value: 100. AddedOnTheFifteen - String required: no - whether to query only hosts added within the last 15 days (1: yes) TagId - String required: no - query the list of hosts associated with the specified tag

Returns:

Filters Filter criteria

Ips - String - required: no - query by IP

Names - String - required: no - query by instance name

InstanceIds - String - required: no - instance ID for query

Status - String - required: no - client online status (OFFLINE: offline/shut down | ONLINE: online | UNINSTALLED: not installed | AGENT_OFFLINE: agent offline | AGENT_SHUTDOWN: agent shut down)

Version - String required: no - current edition ( PRO_VERSION: Pro Edition | BASIC_VERSION: Basic Edition | Flagship: Ultimate Edition | ProtectedMachines: Pro + Ultimate Editions)

Risk - String - required: no - risky host (yes)

Os - String - required: no - operating system (value of DescribeMachineOsList)

Each filter criterion supports only one value.

Quuid - String - required: no - CVM instance UUID. Maximum value: 100.

AddedOnTheFifteen - String required: no - whether to query only hosts added within the last 15 days (1: yes)

TagId - String required: no - query the list of hosts associated with the specified tag

setFilters

public void setFilters(Filter[] Filters)

Set Filter criteria

Ips - String - required: no - query by IP Names - String - required: no - query by instance name InstanceIds - String - required: no - instance ID for query Status - String - required: no - client online status (OFFLINE: offline/shut down | ONLINE: online | UNINSTALLED: not installed | AGENT_OFFLINE: agent offline | AGENT_SHUTDOWN: agent shut down) Version - String required: no - current edition ( PRO_VERSION: Pro Edition | BASIC_VERSION: Basic Edition | Flagship: Ultimate Edition | ProtectedMachines: Pro + Ultimate Editions) Risk - String - required: no - risky host (yes) Os - String - required: no - operating system (value of DescribeMachineOsList) Each filter criterion supports only one value. Quuid - String - required: no - CVM instance UUID. Maximum value: 100. AddedOnTheFifteen - String required: no - whether to query only hosts added within the last 15 days (1: yes) TagId - String required: no - query the list of hosts associated with the specified tag