Package com.tencentcloudapi.apm.v20210622.models

Class DescribeGeneralMetricDataRequest

  • public class DescribeGeneralMetricDataRequest
extends AbstractModel

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Long getEndTime()
      Get 结束时间的时间戳，单位为秒，只支持查询2天内最多1小时的指标数据。
      GeneralFilter[] getFilters()
      Get 要过滤的维度信息： service_metric视图支持：service.name（服务名）、span.kind（客户端/服务端视角）为维度进行过滤，service.name（服务名）必填。 span.kind: server:服务端视角 client:客户端视角 默认为服务端视角进行查询。 runtime_metric视图支持：service.name（服务名）维度进行过滤，service.name（服务名）必填。 sql_metric视图支持：service.name（服务名）、db.instance（数据库名称）、db.ip（数据库实例ip）维度进行过滤，查询service_slow_sql_count（慢sql）指标时service.name必填，查询sql_duration_avg（耗时）指标时db.instance（数据库名称）必填。
      String[] getGroupBy()
      Get 聚合维度： service_metric视图支持：service.name（服务名）、span.kind （客户端/服务端视角）维度进行聚合，service.name（服务名）必填。 runtime_metric视图支持：service.name（服务名）维度进行聚合，service.name（服务名）必填。 sql_metric视图支持：service.name（服务名）、db.statement（sql语句）维度进行聚合，查询service_slow_sql_count（慢sql）时service.name（服务名）必填，查询sql_duration_avg（耗时）指标时service.name（服务名）、db.statement（sql语句）必填。
      String getInstanceId()
      Get 业务系统ID
      String[] getMetrics()
      Get 需要查询的指标，不可自定义输入。 service_metric视图支持：service_request_count（总请求）、service_duration（平均响应时间）、service_error_req_rate（平均错误率）、service_slow_call_count（慢调用）、service_error_request_count（异常数量）。 runtime_metric视图支持：service_gc_full_count（Full GC）。 sql_metric视图支持：service_slow_sql_count（慢sql）、sql_duration_avg（耗时）。
      OrderBy getOrderBy()
      Get 对查询指标进行排序： service_metric视图支持：service_request_count（总请求）、service_duration（平均响应时间）、service_error_req_rate（平均错误率）、service_slow_call_count（慢调用）、service_error_request_count（异常数量）。 runtime_metric视图支持：service_gc_full_count（Full GC）。 sql_metric视图支持：service_slow_sql_count（慢sql）、sql_duration_avg（耗时）。 asc:对查询指标进行升序排序 desc：对查询指标进行降序排序
      Long getPageSize()
      Get 查询指标的限制条数，目前最多展示50条数据，PageSize取值为1-50，上送PageSize则根据PageSize的值展示限制条数。
      Long getPeriod()
      Get 聚合粒度，单位为秒，最小为60s，即一分钟的聚合粒度；如果为空或0则计算开始时间到截止时间的指标数据，上报其他值会报错。
      Long getStartTime()
      Get 起始时间的时间戳，单位为秒，只支持查询2天内最多1小时的指标数据。
      String getViewName()
      Get 视图名称，不可自定义输入。支持：service_metric、runtime_metric、sql_metric。
      void setEndTime​(Long EndTime)
      Set 结束时间的时间戳，单位为秒，只支持查询2天内最多1小时的指标数据。
      void setFilters​(GeneralFilter[] Filters)
      Set 要过滤的维度信息： service_metric视图支持：service.name（服务名）、span.kind（客户端/服务端视角）为维度进行过滤，service.name（服务名）必填。 span.kind: server:服务端视角 client:客户端视角 默认为服务端视角进行查询。 runtime_metric视图支持：service.name（服务名）维度进行过滤，service.name（服务名）必填。 sql_metric视图支持：service.name（服务名）、db.instance（数据库名称）、db.ip（数据库实例ip）维度进行过滤，查询service_slow_sql_count（慢sql）指标时service.name必填，查询sql_duration_avg（耗时）指标时db.instance（数据库名称）必填。
      void setGroupBy​(String[] GroupBy)
      Set 聚合维度： service_metric视图支持：service.name（服务名）、span.kind （客户端/服务端视角）维度进行聚合，service.name（服务名）必填。 runtime_metric视图支持：service.name（服务名）维度进行聚合，service.name（服务名）必填。 sql_metric视图支持：service.name（服务名）、db.statement（sql语句）维度进行聚合，查询service_slow_sql_count（慢sql）时service.name（服务名）必填，查询sql_duration_avg（耗时）指标时service.name（服务名）、db.statement（sql语句）必填。
      void setInstanceId​(String InstanceId)
      Set 业务系统ID
      void setMetrics​(String[] Metrics)
      Set 需要查询的指标，不可自定义输入。 service_metric视图支持：service_request_count（总请求）、service_duration（平均响应时间）、service_error_req_rate（平均错误率）、service_slow_call_count（慢调用）、service_error_request_count（异常数量）。 runtime_metric视图支持：service_gc_full_count（Full GC）。 sql_metric视图支持：service_slow_sql_count（慢sql）、sql_duration_avg（耗时）。
      void setOrderBy​(OrderBy OrderBy)
      Set 对查询指标进行排序： service_metric视图支持：service_request_count（总请求）、service_duration（平均响应时间）、service_error_req_rate（平均错误率）、service_slow_call_count（慢调用）、service_error_request_count（异常数量）。 runtime_metric视图支持：service_gc_full_count（Full GC）。 sql_metric视图支持：service_slow_sql_count（慢sql）、sql_duration_avg（耗时）。 asc:对查询指标进行升序排序 desc：对查询指标进行降序排序
      void setPageSize​(Long PageSize)
      Set 查询指标的限制条数，目前最多展示50条数据，PageSize取值为1-50，上送PageSize则根据PageSize的值展示限制条数。
      void setPeriod​(Long Period)
      Set 聚合粒度，单位为秒，最小为60s，即一分钟的聚合粒度；如果为空或0则计算开始时间到截止时间的指标数据，上报其他值会报错。
      void setStartTime​(Long StartTime)
      Set 起始时间的时间戳，单位为秒，只支持查询2天内最多1小时的指标数据。
      void setViewName​(String ViewName)
      Set 视图名称，不可自定义输入。支持：service_metric、runtime_metric、sql_metric。
      void toMap​(HashMap<String,​String> map, String prefix)
      Internal implementation, normal users should not use it.

    • Constructor Detail

      • DescribeGeneralMetricDataRequest

        public DescribeGeneralMetricDataRequest()

      • DescribeGeneralMetricDataRequest

        public DescribeGeneralMetricDataRequest​(DescribeGeneralMetricDataRequest 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

      • getFilters

        public GeneralFilter[] getFilters()
        Get 要过滤的维度信息： service_metric视图支持：service.name（服务名）、span.kind（客户端/服务端视角）为维度进行过滤，service.name（服务名）必填。 span.kind: server:服务端视角 client:客户端视角 默认为服务端视角进行查询。 runtime_metric视图支持：service.name（服务名）维度进行过滤，service.name（服务名）必填。 sql_metric视图支持：service.name（服务名）、db.instance（数据库名称）、db.ip（数据库实例ip）维度进行过滤，查询service_slow_sql_count（慢sql）指标时service.name必填，查询sql_duration_avg（耗时）指标时db.instance（数据库名称）必填。
        Returns:
        Filters 要过滤的维度信息： service_metric视图支持：service.name（服务名）、span.kind（客户端/服务端视角）为维度进行过滤，service.name（服务名）必填。 span.kind: server:服务端视角 client:客户端视角 默认为服务端视角进行查询。 runtime_metric视图支持：service.name（服务名）维度进行过滤，service.name（服务名）必填。 sql_metric视图支持：service.name（服务名）、db.instance（数据库名称）、db.ip（数据库实例ip）维度进行过滤，查询service_slow_sql_count（慢sql）指标时service.name必填，查询sql_duration_avg（耗时）指标时db.instance（数据库名称）必填。

      • setFilters

        public void setFilters​(GeneralFilter[] Filters)
        Set 要过滤的维度信息： service_metric视图支持：service.name（服务名）、span.kind（客户端/服务端视角）为维度进行过滤，service.name（服务名）必填。 span.kind: server:服务端视角 client:客户端视角 默认为服务端视角进行查询。 runtime_metric视图支持：service.name（服务名）维度进行过滤，service.name（服务名）必填。 sql_metric视图支持：service.name（服务名）、db.instance（数据库名称）、db.ip（数据库实例ip）维度进行过滤，查询service_slow_sql_count（慢sql）指标时service.name必填，查询sql_duration_avg（耗时）指标时db.instance（数据库名称）必填。
        Parameters:
        Filters - 要过滤的维度信息： service_metric视图支持：service.name（服务名）、span.kind（客户端/服务端视角）为维度进行过滤，service.name（服务名）必填。 span.kind: server:服务端视角 client:客户端视角 默认为服务端视角进行查询。 runtime_metric视图支持：service.name（服务名）维度进行过滤，service.name（服务名）必填。 sql_metric视图支持：service.name（服务名）、db.instance（数据库名称）、db.ip（数据库实例ip）维度进行过滤，查询service_slow_sql_count（慢sql）指标时service.name必填，查询sql_duration_avg（耗时）指标时db.instance（数据库名称）必填。

      • getMetrics

        public String[] getMetrics()
        Get 需要查询的指标，不可自定义输入。 service_metric视图支持：service_request_count（总请求）、service_duration（平均响应时间）、service_error_req_rate（平均错误率）、service_slow_call_count（慢调用）、service_error_request_count（异常数量）。 runtime_metric视图支持：service_gc_full_count（Full GC）。 sql_metric视图支持：service_slow_sql_count（慢sql）、sql_duration_avg（耗时）。
        Returns:
        Metrics 需要查询的指标，不可自定义输入。 service_metric视图支持：service_request_count（总请求）、service_duration（平均响应时间）、service_error_req_rate（平均错误率）、service_slow_call_count（慢调用）、service_error_request_count（异常数量）。 runtime_metric视图支持：service_gc_full_count（Full GC）。 sql_metric视图支持：service_slow_sql_count（慢sql）、sql_duration_avg（耗时）。

      • setMetrics

        public void setMetrics​(String[] Metrics)
        Set 需要查询的指标，不可自定义输入。 service_metric视图支持：service_request_count（总请求）、service_duration（平均响应时间）、service_error_req_rate（平均错误率）、service_slow_call_count（慢调用）、service_error_request_count（异常数量）。 runtime_metric视图支持：service_gc_full_count（Full GC）。 sql_metric视图支持：service_slow_sql_count（慢sql）、sql_duration_avg（耗时）。
        Parameters:
        Metrics - 需要查询的指标，不可自定义输入。 service_metric视图支持：service_request_count（总请求）、service_duration（平均响应时间）、service_error_req_rate（平均错误率）、service_slow_call_count（慢调用）、service_error_request_count（异常数量）。 runtime_metric视图支持：service_gc_full_count（Full GC）。 sql_metric视图支持：service_slow_sql_count（慢sql）、sql_duration_avg（耗时）。

      • getInstanceId

        public String getInstanceId()
        Get 业务系统ID
        Returns:
        InstanceId 业务系统ID

      • setInstanceId

        public void setInstanceId​(String InstanceId)
        Set 业务系统ID
        Parameters:
        InstanceId - 业务系统ID

      • getViewName

        public String getViewName()
        Get 视图名称，不可自定义输入。支持：service_metric、runtime_metric、sql_metric。
        Returns:
        ViewName 视图名称，不可自定义输入。支持：service_metric、runtime_metric、sql_metric。

      • setViewName

        public void setViewName​(String ViewName)
        Set 视图名称，不可自定义输入。支持：service_metric、runtime_metric、sql_metric。
        Parameters:
        ViewName - 视图名称，不可自定义输入。支持：service_metric、runtime_metric、sql_metric。

      • getGroupBy

        public String[] getGroupBy()
        Get 聚合维度： service_metric视图支持：service.name（服务名）、span.kind （客户端/服务端视角）维度进行聚合，service.name（服务名）必填。 runtime_metric视图支持：service.name（服务名）维度进行聚合，service.name（服务名）必填。 sql_metric视图支持：service.name（服务名）、db.statement（sql语句）维度进行聚合，查询service_slow_sql_count（慢sql）时service.name（服务名）必填，查询sql_duration_avg（耗时）指标时service.name（服务名）、db.statement（sql语句）必填。
        Returns:
        GroupBy 聚合维度： service_metric视图支持：service.name（服务名）、span.kind （客户端/服务端视角）维度进行聚合，service.name（服务名）必填。 runtime_metric视图支持：service.name（服务名）维度进行聚合，service.name（服务名）必填。 sql_metric视图支持：service.name（服务名）、db.statement（sql语句）维度进行聚合，查询service_slow_sql_count（慢sql）时service.name（服务名）必填，查询sql_duration_avg（耗时）指标时service.name（服务名）、db.statement（sql语句）必填。

      • setGroupBy

        public void setGroupBy​(String[] GroupBy)
        Set 聚合维度： service_metric视图支持：service.name（服务名）、span.kind （客户端/服务端视角）维度进行聚合，service.name（服务名）必填。 runtime_metric视图支持：service.name（服务名）维度进行聚合，service.name（服务名）必填。 sql_metric视图支持：service.name（服务名）、db.statement（sql语句）维度进行聚合，查询service_slow_sql_count（慢sql）时service.name（服务名）必填，查询sql_duration_avg（耗时）指标时service.name（服务名）、db.statement（sql语句）必填。
        Parameters:
        GroupBy - 聚合维度： service_metric视图支持：service.name（服务名）、span.kind （客户端/服务端视角）维度进行聚合，service.name（服务名）必填。 runtime_metric视图支持：service.name（服务名）维度进行聚合，service.name（服务名）必填。 sql_metric视图支持：service.name（服务名）、db.statement（sql语句）维度进行聚合，查询service_slow_sql_count（慢sql）时service.name（服务名）必填，查询sql_duration_avg（耗时）指标时service.name（服务名）、db.statement（sql语句）必填。

      • getStartTime

        public Long getStartTime()
        Get 起始时间的时间戳，单位为秒，只支持查询2天内最多1小时的指标数据。
        Returns:
        StartTime 起始时间的时间戳，单位为秒，只支持查询2天内最多1小时的指标数据。

      • setStartTime

        public void setStartTime​(Long StartTime)
        Set 起始时间的时间戳，单位为秒，只支持查询2天内最多1小时的指标数据。
        Parameters:
        StartTime - 起始时间的时间戳，单位为秒，只支持查询2天内最多1小时的指标数据。

      • getEndTime

        public Long getEndTime()
        Get 结束时间的时间戳，单位为秒，只支持查询2天内最多1小时的指标数据。
        Returns:
        EndTime 结束时间的时间戳，单位为秒，只支持查询2天内最多1小时的指标数据。

      • setEndTime

        public void setEndTime​(Long EndTime)
        Set 结束时间的时间戳，单位为秒，只支持查询2天内最多1小时的指标数据。
        Parameters:
        EndTime - 结束时间的时间戳，单位为秒，只支持查询2天内最多1小时的指标数据。

      • getPeriod

        public Long getPeriod()
        Get 聚合粒度，单位为秒，最小为60s，即一分钟的聚合粒度；如果为空或0则计算开始时间到截止时间的指标数据，上报其他值会报错。
        Returns:
        Period 聚合粒度，单位为秒，最小为60s，即一分钟的聚合粒度；如果为空或0则计算开始时间到截止时间的指标数据，上报其他值会报错。

      • setPeriod

        public void setPeriod​(Long Period)
        Set 聚合粒度，单位为秒，最小为60s，即一分钟的聚合粒度；如果为空或0则计算开始时间到截止时间的指标数据，上报其他值会报错。
        Parameters:
        Period - 聚合粒度，单位为秒，最小为60s，即一分钟的聚合粒度；如果为空或0则计算开始时间到截止时间的指标数据，上报其他值会报错。

      • getOrderBy

        public OrderBy getOrderBy()
        Get 对查询指标进行排序： service_metric视图支持：service_request_count（总请求）、service_duration（平均响应时间）、service_error_req_rate（平均错误率）、service_slow_call_count（慢调用）、service_error_request_count（异常数量）。 runtime_metric视图支持：service_gc_full_count（Full GC）。 sql_metric视图支持：service_slow_sql_count（慢sql）、sql_duration_avg（耗时）。 asc:对查询指标进行升序排序 desc：对查询指标进行降序排序
        Returns:
        OrderBy 对查询指标进行排序： service_metric视图支持：service_request_count（总请求）、service_duration（平均响应时间）、service_error_req_rate（平均错误率）、service_slow_call_count（慢调用）、service_error_request_count（异常数量）。 runtime_metric视图支持：service_gc_full_count（Full GC）。 sql_metric视图支持：service_slow_sql_count（慢sql）、sql_duration_avg（耗时）。 asc:对查询指标进行升序排序 desc：对查询指标进行降序排序

      • setOrderBy

        public void setOrderBy​(OrderBy OrderBy)
        Set 对查询指标进行排序： service_metric视图支持：service_request_count（总请求）、service_duration（平均响应时间）、service_error_req_rate（平均错误率）、service_slow_call_count（慢调用）、service_error_request_count（异常数量）。 runtime_metric视图支持：service_gc_full_count（Full GC）。 sql_metric视图支持：service_slow_sql_count（慢sql）、sql_duration_avg（耗时）。 asc:对查询指标进行升序排序 desc：对查询指标进行降序排序
        Parameters:
        OrderBy - 对查询指标进行排序： service_metric视图支持：service_request_count（总请求）、service_duration（平均响应时间）、service_error_req_rate（平均错误率）、service_slow_call_count（慢调用）、service_error_request_count（异常数量）。 runtime_metric视图支持：service_gc_full_count（Full GC）。 sql_metric视图支持：service_slow_sql_count（慢sql）、sql_duration_avg（耗时）。 asc:对查询指标进行升序排序 desc：对查询指标进行降序排序

      • getPageSize

        public Long getPageSize()
        Get 查询指标的限制条数，目前最多展示50条数据，PageSize取值为1-50，上送PageSize则根据PageSize的值展示限制条数。
        Returns:
        PageSize 查询指标的限制条数，目前最多展示50条数据，PageSize取值为1-50，上送PageSize则根据PageSize的值展示限制条数。

      • setPageSize

        public void setPageSize​(Long PageSize)
        Set 查询指标的限制条数，目前最多展示50条数据，PageSize取值为1-50，上送PageSize则根据PageSize的值展示限制条数。
        Parameters:
        PageSize - 查询指标的限制条数，目前最多展示50条数据，PageSize取值为1-50，上送PageSize则根据PageSize的值展示限制条数。