DescribeMetricTopRequest (cms20190101 9.0.8 API)

java.lang.Object
- com.aliyun.tea.TeaModel
- - com.aliyun.cms20190101.models.DescribeMetricTopRequest

public class DescribeMetricTopRequest
extends com.aliyun.tea.TeaModel

字段概要

字段
限定符和类型	字段和说明
`String`	`dimensions` The monitoring dimensions of the specified resource.
`String`	`endTime` The end of the time range to query monitoring data.
`String`	`express` The expression that is used to compute the query results in real time.
`String`	`length` The number of entries per page.
`String`	`metricName` The metric that is used to monitor the cloud service.
`String`	`namespace` The namespace of the cloud service.
`String`	`orderby` The field based on which data is sorted.
`String`	`orderDesc` The order in which data is sorted.
`String`	`period` The statistical period of the monitoring data.
`String`	`regionId`
`String`	`startTime` The start of the time range to query monitoring data.

构造器概要

构造器
构造器和说明

DescribeMetricTopRequest()

构造器
构造器和说明
`DescribeMetricTopRequest()`

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`static DescribeMetricTopRequest`	`build(Map<String,?> map)`
`String`	`getDimensions()`
`String`	`getEndTime()`
`String`	`getExpress()`
`String`	`getLength()`
`String`	`getMetricName()`
`String`	`getNamespace()`
`String`	`getOrderby()`
`String`	`getOrderDesc()`
`String`	`getPeriod()`
`String`	`getRegionId()`
`String`	`getStartTime()`
`DescribeMetricTopRequest`	`setDimensions(String dimensions)`
`DescribeMetricTopRequest`	`setEndTime(String endTime)`
`DescribeMetricTopRequest`	`setExpress(String express)`
`DescribeMetricTopRequest`	`setLength(String length)`
`DescribeMetricTopRequest`	`setMetricName(String metricName)`
`DescribeMetricTopRequest`	`setNamespace(String namespace)`
`DescribeMetricTopRequest`	`setOrderby(String orderby)`
`DescribeMetricTopRequest`	`setOrderDesc(String orderDesc)`
`DescribeMetricTopRequest`	`setPeriod(String period)`
`DescribeMetricTopRequest`	`setRegionId(String regionId)`
`DescribeMetricTopRequest`	`setStartTime(String startTime)`

从类继承的方法 com.aliyun.tea.TeaModel
build, buildMap, confirmType, confirmType, parseObject, toMap, toMap, toModel, validate, validateParams

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - dimensions
```
@NameInMap(value="Dimensions")
public String dimensions
```
    The monitoring dimensions of the specified resource.
    
    Set the value to a collection of key:value pairs. Example: {"userId":"120886317861****"} or {"instanceId":"i-2ze2d6j5uhg20x47****"}.
    
    You can query a maximum of 50 instances in each request.
    
    example:
    [{"instanceId": "i-abcdefgh12****"}]
  - endTime
```
@NameInMap(value="EndTime")
public String endTime
```
    The end of the time range to query monitoring data.
    - If the StartTime and EndTime parameters are not specified, the monitoring data of the last statistical period is queried.``
    - If the StartTime and EndTime parameters are specified, the monitoring data of the last statistical period in the specified time range is queried.````
      
      If you set the Period parameter to 15, the specified time range must be less than or equal to 20 minutes. For example, if you set the StartTime parameter to 2021-05-08 08:10:00 and the EndTime parameter to 2021-05-08 08:30:00, the monitoring data of the last 15 seconds in the time range is queried.
      
      If you set the Period parameter to 60 or 900, the specified time range must be less than or equal to 2 hours. For example, if you set the Period parameter to 60, the StartTime parameter to 2021-05-08 08:00:00, and the EndTime parameter to 2021-05-08 10:00:00, the monitoring data of the last 60 seconds in the time range is queried.
      
      If you set the Period parameter to 3600, the specified time range must be less than or equal to two days. For example, if you set the StartTime parameter to 2021-05-08 08:00:00 and the EndTime parameter to 2021-05-10 08:00:00, the monitoring data of the last 3,600 seconds in the time range is queried.
    The following formats are supported:
    - UNIX timestamp: the number of milliseconds that have elapsed since 00:00:00 Thursday, January 1, 1970
    - Time format: YYYY-MM-DDThh:mm:ssZ
    We recommend that you use UNIX timestamps to prevent time zone-related issues.
    
    example:
    2021-05-08 10:00:00
  - express
```
@NameInMap(value="Express")
public String express
```
    The expression that is used to compute the query results in real time.
    
    Only the groupby expression is supported. This expression is similar to the GROUP BY statement used in databases.
    
    example:
    {"groupby":["userId","instanceId"]}
  - length
```
@NameInMap(value="Length")
public String length
```
    The number of entries per page.
    
    Default value: 10.
    
    The maximum value of the Length parameter in a request is 1440.
    
    example:
    10
  - metricName
```
@NameInMap(value="MetricName")
public String metricName
```
    The metric that is used to monitor the cloud service.
    
    For more information about metric names, see Appendix 1: Metrics.
    
    This parameter is required.
    example:
    cpu_idle
  - namespace
```
@NameInMap(value="Namespace")
public String namespace
```
    The namespace of the cloud service.
    
    For more information about the namespaces of cloud services, see Appendix 1: Metrics.
    
    This parameter is required.
    example:
    acs_ecs_dashboard
  - orderDesc
```
@NameInMap(value="OrderDesc")
public String orderDesc
```
    The order in which data is sorted. Valid values:
    - True: sorts data in ascending order.
    - False (default): sorts data in descending order.
    example:
    False
  - orderby
```
@NameInMap(value="Orderby")
public String orderby
```
    The field based on which data is sorted. Valid values:
    - Average
    - Minimum
    - Maximum
    This parameter is required.
    example:
    Average
  - period
```
@NameInMap(value="Period")
public String period
```
    The statistical period of the monitoring data.
    
    Valid values: 15, 60, 900, and 3600.
    
    Unit: seconds.
    - If this parameter is not specified, monitoring data is queried based on the period in which metric values are reported.
    - Statistical periods vary based on the metrics that are specified by MetricName. For more information, see Appendix 1: Metrics.
    example:
    60
  - regionId
```
@NameInMap(value="RegionId")
public String regionId
```
  - startTime
```
@NameInMap(value="StartTime")
public String startTime
```
    The start of the time range to query monitoring data.
    - If the StartTime and EndTime parameters are not specified, the monitoring data of the last statistical period is queried.``
    - If the StartTime and EndTime parameters are specified, the monitoring data of the last statistical period in the specified time range is queried.````
      
      If you set the Period parameter to 15, the specified time range must be less than or equal to 20 minutes. For example, if you set the StartTime parameter to 2021-05-08 08:10:00 and the EndTime parameter to 2021-05-08 08:30:00, the monitoring data of the last 15 seconds in the time range is queried.
      
      If you set the Period parameter to 60 or 900, the specified time range must be less than or equal to 2 hours. For example, if you set the Period parameter to 60, the StartTime parameter to 2021-05-08 08:00:00, and the EndTime parameter to 2021-05-08 10:00:00, the monitoring data of the last 60 seconds in the time range is queried.
      
      If you set the Period parameter to 3600, the specified time range must be less than or equal to two days. For example, if you set the StartTime parameter to 2021-05-08 08:00:00 and the EndTime parameter to 2021-05-10 08:00:00, the monitoring data of the last 3,600 seconds in the time range is queried.
    The following formats are supported:
    - UNIX timestamp: the number of milliseconds that have elapsed since 00:00:00 Thursday, January 1, 1970
    - Time format: YYYY-MM-DDThh:mm:ssZ
    - You must set the StartTime parameter to a point in time that is later than 00:00:00 Thursday, January 1, 1970. Otherwise, this parameter is invalid.
    - We recommend that you use UNIX timestamps to prevent time zone-related issues.
    example:
    2021-05-08 08:00:00
- 构造器详细资料
  - DescribeMetricTopRequest
```
public DescribeMetricTopRequest()
```
- 方法详细资料
  - build
```
public static DescribeMetricTopRequest build(Map<String,?> map)
                                      throws Exception
```
    抛出:
    
    Exception
  - setDimensions
```
public DescribeMetricTopRequest setDimensions(String dimensions)
```
  - getDimensions
```
public String getDimensions()
```
  - setEndTime
```
public DescribeMetricTopRequest setEndTime(String endTime)
```
  - getEndTime
```
public String getEndTime()
```
  - setExpress
```
public DescribeMetricTopRequest setExpress(String express)
```
  - getExpress
```
public String getExpress()
```
  - setLength
```
public DescribeMetricTopRequest setLength(String length)
```
  - getLength
```
public String getLength()
```
  - setMetricName
```
public DescribeMetricTopRequest setMetricName(String metricName)
```
  - getMetricName
```
public String getMetricName()
```
  - setNamespace
```
public DescribeMetricTopRequest setNamespace(String namespace)
```
  - getNamespace
```
public String getNamespace()
```
  - setOrderDesc
```
public DescribeMetricTopRequest setOrderDesc(String orderDesc)
```
  - getOrderDesc
```
public String getOrderDesc()
```
  - setOrderby
```
public DescribeMetricTopRequest setOrderby(String orderby)
```
  - getOrderby
```
public String getOrderby()
```
  - setPeriod
```
public DescribeMetricTopRequest setPeriod(String period)
```
  - getPeriod
```
public String getPeriod()
```
  - setRegionId
```
public DescribeMetricTopRequest setRegionId(String regionId)
```
  - getRegionId
```
public String getRegionId()
```
  - setStartTime
```
public DescribeMetricTopRequest setStartTime(String startTime)
```
  - getStartTime
```
public String getStartTime()
```

类 DescribeMetricTopRequest

字段概要

构造器概要

方法概要

从类继承的方法 com.aliyun.tea.TeaModel

从类继承的方法 java.lang.Object

字段详细资料

dimensions

endTime

express

length

metricName

namespace

orderDesc

orderby

period

regionId

startTime

构造器详细资料

DescribeMetricTopRequest

方法详细资料

build

setDimensions

getDimensions

setEndTime

getEndTime

setExpress

getExpress

setLength

getLength

setMetricName

getMetricName

setNamespace

getNamespace

setOrderDesc

getOrderDesc

setOrderby

getOrderby

setPeriod

getPeriod

setRegionId

getRegionId

setStartTime

getStartTime