com.tencentcloudapi.cdn.v20180606.models

Class ListTopDataRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.cdn.v20180606.models.ListTopDataRequest

public class ListTopDataRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
ListTopDataRequest()
ListTopDataRequest(ListTopDataRequest 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
String	getArea() Get Specifies the service region.
String	getAreaType() Get Specifies a region type for the query.
String	getCode() Get When Filter is `statusCode` or `OriginStatusCode`, enter a code to query and sort results.
Boolean	getDetail() Get The sorted results of all domain names are returned by default (false) during a multi-domain-name query If `Metric` is `url`, `path`, `district`, or `isp` and `Filter` is `flux` or `request`, it can be set to `true` to return the sorted results of each domain.
String[]	getDomains() Get Specifies the list of domain names to be queried; up to 30 domain names can be queried at a time.
String	getEndTime() Get Query end time in the format of `yyyy-MM-dd HH:mm:ss` Only data queries at the granularity of days are supported.
String	getFilter() Get Metric name used for sorting: flux: If Metric is `host`, it indicates the access traffic; if Metric is `originHost`, it indicates the origin-pull traffic.
Long	getLimit() Get Returns the first N data entries.
String	getMetric() Get Objects to be sorted.
String	getProduct() Get Specifies the product to query, either `cdn` (default) or `ecdn`.
Long	getProject() Get Specifies the project ID to be queried, which can be viewed [here](https://console.cloud.tencent.com/project) Please note that if domain names are specified, this parameter will be ignored.
String	getStartTime() Get Query start time in the format of `yyyy-MM-dd HH:mm:ss` Only data queries at the granularity of minutes are supported.
void	setArea(String Area) Set Specifies the service region.
void	setAreaType(String AreaType) Set Specifies a region type for the query.
void	setCode(String Code) Set When Filter is `statusCode` or `OriginStatusCode`, enter a code to query and sort results.
void	setDetail(Boolean Detail) Set The sorted results of all domain names are returned by default (false) during a multi-domain-name query If `Metric` is `url`, `path`, `district`, or `isp` and `Filter` is `flux` or `request`, it can be set to `true` to return the sorted results of each domain.
void	setDomains(String[] Domains) Set Specifies the list of domain names to be queried; up to 30 domain names can be queried at a time.
void	setEndTime(String EndTime) Set Query end time in the format of `yyyy-MM-dd HH:mm:ss` Only data queries at the granularity of days are supported.
void	setFilter(String Filter) Set Metric name used for sorting: flux: If Metric is `host`, it indicates the access traffic; if Metric is `originHost`, it indicates the origin-pull traffic.
void	setLimit(Long Limit) Set Returns the first N data entries.
void	setMetric(String Metric) Set Objects to be sorted.
void	setProduct(String Product) Set Specifies the product to query, either `cdn` (default) or `ecdn`.
void	setProject(Long Project) Set Specifies the project ID to be queried, which can be viewed [here](https://console.cloud.tencent.com/project) Please note that if domain names are specified, this parameter will be ignored.
void	setStartTime(String StartTime) Set Query start time in the format of `yyyy-MM-dd HH:mm:ss` Only data queries at the granularity of minutes are supported.
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, 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

ListTopDataRequest

public ListTopDataRequest()

ListTopDataRequest

public ListTopDataRequest(ListTopDataRequest 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

getStartTime

public String getStartTime()

Get Query start time in the format of `yyyy-MM-dd HH:mm:ss` Only data queries at the granularity of minutes are supported. The start time is truncated to minutes. For example, if the value of `StartTime` is 2018-09-04 10:40:23, the start time of the data returned is 2018-09-04 10:40:00. Only data for the last 90 days can be queried.

Returns:

StartTime Query start time in the format of `yyyy-MM-dd HH:mm:ss` Only data queries at the granularity of minutes are supported. The start time is truncated to minutes. For example, if the value of `StartTime` is 2018-09-04 10:40:23, the start time of the data returned is 2018-09-04 10:40:00. Only data for the last 90 days can be queried.

setStartTime

public void setStartTime(String StartTime)

Set Query start time in the format of `yyyy-MM-dd HH:mm:ss` Only data queries at the granularity of minutes are supported. The start time is truncated to minutes. For example, if the value of `StartTime` is 2018-09-04 10:40:23, the start time of the data returned is 2018-09-04 10:40:00. Only data for the last 90 days can be queried.

Parameters:

StartTime - Query start time in the format of `yyyy-MM-dd HH:mm:ss` Only data queries at the granularity of minutes are supported. The start time is truncated to minutes. For example, if the value of `StartTime` is 2018-09-04 10:40:23, the start time of the data returned is 2018-09-04 10:40:00. Only data for the last 90 days can be queried.

getEndTime

public String getEndTime()

Get Query end time in the format of `yyyy-MM-dd HH:mm:ss` Only data queries at the granularity of days are supported. Take the day in the input parameter as the end date, and the data generated on or before 23:59:59 on the end date is returned. For example, if the value of `EndTime` is 2018-09-05 22:40:00, the end time of the data returned is 2018-09-05 23:59:59. `EndTime` must be later than or equal to `StartTime`.

Returns:

EndTime Query end time in the format of `yyyy-MM-dd HH:mm:ss` Only data queries at the granularity of days are supported. Take the day in the input parameter as the end date, and the data generated on or before 23:59:59 on the end date is returned. For example, if the value of `EndTime` is 2018-09-05 22:40:00, the end time of the data returned is 2018-09-05 23:59:59. `EndTime` must be later than or equal to `StartTime`.

setEndTime

public void setEndTime(String EndTime)

Set Query end time in the format of `yyyy-MM-dd HH:mm:ss` Only data queries at the granularity of days are supported. Take the day in the input parameter as the end date, and the data generated on or before 23:59:59 on the end date is returned. For example, if the value of `EndTime` is 2018-09-05 22:40:00, the end time of the data returned is 2018-09-05 23:59:59. `EndTime` must be later than or equal to `StartTime`.

Parameters:

EndTime - Query end time in the format of `yyyy-MM-dd HH:mm:ss` Only data queries at the granularity of days are supported. Take the day in the input parameter as the end date, and the data generated on or before 23:59:59 on the end date is returned. For example, if the value of `EndTime` is 2018-09-05 22:40:00, the end time of the data returned is 2018-09-05 23:59:59. `EndTime` must be later than or equal to `StartTime`.

getMetric

public String getMetric()

Get Objects to be sorted. Valid values: `url`: Sort by access URL (URLs carrying no parameters). Supported filters are `flux` and `request`. `district`: sorts provinces or countries/regions. Supported filters are `flux` and `request`. `isp`: sorts ISPs. Supported filters are `flux` and `request`. `host`: Sort by domain name access data. Supported filters are `flux`, `request`, `bandwidth`, `fluxHitRate`, and `statusCode` (2XX, 3XX, 4XX, 5XX). `originHost`: Sort by domain name origin-pull data. Supported filters are `flux`, `request`, `bandwidth`, and `OriginStatusCode` (origin_2XX, origin_3XX, origin_4XX, origin_5XX).

Returns:

Metric Objects to be sorted. Valid values: `url`: Sort by access URL (URLs carrying no parameters). Supported filters are `flux` and `request`. `district`: sorts provinces or countries/regions. Supported filters are `flux` and `request`. `isp`: sorts ISPs. Supported filters are `flux` and `request`. `host`: Sort by domain name access data. Supported filters are `flux`, `request`, `bandwidth`, `fluxHitRate`, and `statusCode` (2XX, 3XX, 4XX, 5XX). `originHost`: Sort by domain name origin-pull data. Supported filters are `flux`, `request`, `bandwidth`, and `OriginStatusCode` (origin_2XX, origin_3XX, origin_4XX, origin_5XX).

setMetric

public void setMetric(String Metric)

Set Objects to be sorted. Valid values: `url`: Sort by access URL (URLs carrying no parameters). Supported filters are `flux` and `request`. `district`: sorts provinces or countries/regions. Supported filters are `flux` and `request`. `isp`: sorts ISPs. Supported filters are `flux` and `request`. `host`: Sort by domain name access data. Supported filters are `flux`, `request`, `bandwidth`, `fluxHitRate`, and `statusCode` (2XX, 3XX, 4XX, 5XX). `originHost`: Sort by domain name origin-pull data. Supported filters are `flux`, `request`, `bandwidth`, and `OriginStatusCode` (origin_2XX, origin_3XX, origin_4XX, origin_5XX).

Parameters:

Metric - Objects to be sorted. Valid values: `url`: Sort by access URL (URLs carrying no parameters). Supported filters are `flux` and `request`. `district`: sorts provinces or countries/regions. Supported filters are `flux` and `request`. `isp`: sorts ISPs. Supported filters are `flux` and `request`. `host`: Sort by domain name access data. Supported filters are `flux`, `request`, `bandwidth`, `fluxHitRate`, and `statusCode` (2XX, 3XX, 4XX, 5XX). `originHost`: Sort by domain name origin-pull data. Supported filters are `flux`, `request`, `bandwidth`, and `OriginStatusCode` (origin_2XX, origin_3XX, origin_4XX, origin_5XX).

getFilter

public String getFilter()

Get Metric name used for sorting: flux: If Metric is `host`, it indicates the access traffic; if Metric is `originHost`, it indicates the origin-pull traffic. bandwidth: If Metric is `host`, it indicates the access bandwidth; if Metric is `originHost`, it indicates the origin-pull bandwidth. request: If Metric is `host`, it indicates the number of access requests; if Metric is `originHost`, it indicates the number of origin-pull requests. fluxHitRate: Average traffic hit rate 2XX: access 2XX status code 3XX: access 3XX status code 4XX: access 4XX status code 5XX: access 5XX status code origin_2XX: origin-pull 2XX status code origin_3XX: origin-pull 3XX status code origin_4XX: origin-pull 4XX status code origin_5XX: origin-pull 5XX status code statusCode: statistics of a specific access status code which is specified in the `Code` parameter. OriginStatusCode: statistics of a specific origin-pull status code which is specified in the `Code` parameter.

Returns:

Filter Metric name used for sorting: flux: If Metric is `host`, it indicates the access traffic; if Metric is `originHost`, it indicates the origin-pull traffic. bandwidth: If Metric is `host`, it indicates the access bandwidth; if Metric is `originHost`, it indicates the origin-pull bandwidth. request: If Metric is `host`, it indicates the number of access requests; if Metric is `originHost`, it indicates the number of origin-pull requests. fluxHitRate: Average traffic hit rate 2XX: access 2XX status code 3XX: access 3XX status code 4XX: access 4XX status code 5XX: access 5XX status code origin_2XX: origin-pull 2XX status code origin_3XX: origin-pull 3XX status code origin_4XX: origin-pull 4XX status code origin_5XX: origin-pull 5XX status code statusCode: statistics of a specific access status code which is specified in the `Code` parameter. OriginStatusCode: statistics of a specific origin-pull status code which is specified in the `Code` parameter.

setFilter

public void setFilter(String Filter)

Set Metric name used for sorting: flux: If Metric is `host`, it indicates the access traffic; if Metric is `originHost`, it indicates the origin-pull traffic. bandwidth: If Metric is `host`, it indicates the access bandwidth; if Metric is `originHost`, it indicates the origin-pull bandwidth. request: If Metric is `host`, it indicates the number of access requests; if Metric is `originHost`, it indicates the number of origin-pull requests. fluxHitRate: Average traffic hit rate 2XX: access 2XX status code 3XX: access 3XX status code 4XX: access 4XX status code 5XX: access 5XX status code origin_2XX: origin-pull 2XX status code origin_3XX: origin-pull 3XX status code origin_4XX: origin-pull 4XX status code origin_5XX: origin-pull 5XX status code statusCode: statistics of a specific access status code which is specified in the `Code` parameter. OriginStatusCode: statistics of a specific origin-pull status code which is specified in the `Code` parameter.

Parameters:

Filter - Metric name used for sorting: flux: If Metric is `host`, it indicates the access traffic; if Metric is `originHost`, it indicates the origin-pull traffic. bandwidth: If Metric is `host`, it indicates the access bandwidth; if Metric is `originHost`, it indicates the origin-pull bandwidth. request: If Metric is `host`, it indicates the number of access requests; if Metric is `originHost`, it indicates the number of origin-pull requests. fluxHitRate: Average traffic hit rate 2XX: access 2XX status code 3XX: access 3XX status code 4XX: access 4XX status code 5XX: access 5XX status code origin_2XX: origin-pull 2XX status code origin_3XX: origin-pull 3XX status code origin_4XX: origin-pull 4XX status code origin_5XX: origin-pull 5XX status code statusCode: statistics of a specific access status code which is specified in the `Code` parameter. OriginStatusCode: statistics of a specific origin-pull status code which is specified in the `Code` parameter.

getDomains

public String[] getDomains()

Get Specifies the list of domain names to be queried; up to 30 domain names can be queried at a time.

Returns:

Domains Specifies the list of domain names to be queried; up to 30 domain names can be queried at a time.

setDomains

public void setDomains(String[] Domains)

Set Specifies the list of domain names to be queried; up to 30 domain names can be queried at a time.

Parameters:

Domains - Specifies the list of domain names to be queried; up to 30 domain names can be queried at a time.

getProject

public Long getProject()

Get Specifies the project ID to be queried, which can be viewed [here](https://console.cloud.tencent.com/project) Please note that if domain names are specified, this parameter will be ignored.

Returns:

Project Specifies the project ID to be queried, which can be viewed [here](https://console.cloud.tencent.com/project) Please note that if domain names are specified, this parameter will be ignored.

setProject

public void setProject(Long Project)

Set Specifies the project ID to be queried, which can be viewed [here](https://console.cloud.tencent.com/project) Please note that if domain names are specified, this parameter will be ignored.

Parameters:

Project - Specifies the project ID to be queried, which can be viewed [here](https://console.cloud.tencent.com/project) Please note that if domain names are specified, this parameter will be ignored.

getDetail

public Boolean getDetail()

Get The sorted results of all domain names are returned by default (false) during a multi-domain-name query If `Metric` is `url`, `path`, `district`, or `isp` and `Filter` is `flux` or `request`, it can be set to `true` to return the sorted results of each domain.

Returns:

Detail The sorted results of all domain names are returned by default (false) during a multi-domain-name query If `Metric` is `url`, `path`, `district`, or `isp` and `Filter` is `flux` or `request`, it can be set to `true` to return the sorted results of each domain.

setDetail

public void setDetail(Boolean Detail)

Set The sorted results of all domain names are returned by default (false) during a multi-domain-name query If `Metric` is `url`, `path`, `district`, or `isp` and `Filter` is `flux` or `request`, it can be set to `true` to return the sorted results of each domain.

Parameters:

Detail - The sorted results of all domain names are returned by default (false) during a multi-domain-name query If `Metric` is `url`, `path`, `district`, or `isp` and `Filter` is `flux` or `request`, it can be set to `true` to return the sorted results of each domain.

getCode

public String getCode()

Get When Filter is `statusCode` or `OriginStatusCode`, enter a code to query and sort results.

Returns:

Code When Filter is `statusCode` or `OriginStatusCode`, enter a code to query and sort results.

setCode

public void setCode(String Code)

Set When Filter is `statusCode` or `OriginStatusCode`, enter a code to query and sort results.

Parameters:

Code - When Filter is `statusCode` or `OriginStatusCode`, enter a code to query and sort results.

getArea

public String getArea()

Get Specifies the service region. If this value is left blank, it means to query CDN data within the Chinese mainland. `mainland`: Query CDN data in the Chinese mainland. `overseas`: Query CDN data outside the Chinese mainland. Supported metrics are `url`, `district`, `host`, and `originHost`. If `Metric` is `originHost`, supported filters are `flux`, `request`, and `bandwidth`.

Returns:

Area Specifies the service region. If this value is left blank, it means to query CDN data within the Chinese mainland. `mainland`: Query CDN data in the Chinese mainland. `overseas`: Query CDN data outside the Chinese mainland. Supported metrics are `url`, `district`, `host`, and `originHost`. If `Metric` is `originHost`, supported filters are `flux`, `request`, and `bandwidth`.

setArea

public void setArea(String Area)

Set Specifies the service region. If this value is left blank, it means to query CDN data within the Chinese mainland. `mainland`: Query CDN data in the Chinese mainland. `overseas`: Query CDN data outside the Chinese mainland. Supported metrics are `url`, `district`, `host`, and `originHost`. If `Metric` is `originHost`, supported filters are `flux`, `request`, and `bandwidth`.

Parameters:

Area - Specifies the service region. If this value is left blank, it means to query CDN data within the Chinese mainland. `mainland`: Query CDN data in the Chinese mainland. `overseas`: Query CDN data outside the Chinese mainland. Supported metrics are `url`, `district`, `host`, and `originHost`. If `Metric` is `originHost`, supported filters are `flux`, `request`, and `bandwidth`.

getAreaType

public String getAreaType()

Get Specifies a region type for the query. If it is left blank, data of the service region will be queried. This parameter is only valid when `Area` is `overseas` and `Metric` is `district` or `host`. `server`: Query by the location of server (Tencent Cloud CDN nodes). `client`: Query data of the client region where the request devices are located; if `Metric` is `host`, supported filters are `flux`, `request`, and `bandwidth`.

Returns:

AreaType Specifies a region type for the query. If it is left blank, data of the service region will be queried. This parameter is only valid when `Area` is `overseas` and `Metric` is `district` or `host`. `server`: Query by the location of server (Tencent Cloud CDN nodes). `client`: Query data of the client region where the request devices are located; if `Metric` is `host`, supported filters are `flux`, `request`, and `bandwidth`.

setAreaType

public void setAreaType(String AreaType)

Set Specifies a region type for the query. If it is left blank, data of the service region will be queried. This parameter is only valid when `Area` is `overseas` and `Metric` is `district` or `host`. `server`: Query by the location of server (Tencent Cloud CDN nodes). `client`: Query data of the client region where the request devices are located; if `Metric` is `host`, supported filters are `flux`, `request`, and `bandwidth`.

Parameters:

AreaType - Specifies a region type for the query. If it is left blank, data of the service region will be queried. This parameter is only valid when `Area` is `overseas` and `Metric` is `district` or `host`. `server`: Query by the location of server (Tencent Cloud CDN nodes). `client`: Query data of the client region where the request devices are located; if `Metric` is `host`, supported filters are `flux`, `request`, and `bandwidth`.

getProduct

public String getProduct()

Get Specifies the product to query, either `cdn` (default) or `ecdn`.

Returns:

Product Specifies the product to query, either `cdn` (default) or `ecdn`.

setProduct

public void setProduct(String Product)

Set Specifies the product to query, either `cdn` (default) or `ecdn`.

Parameters:

Product - Specifies the product to query, either `cdn` (default) or `ecdn`.

getLimit

public Long getLimit()

Get Returns the first N data entries. The default value is 100 if this parameter is not specified, whereas 1000 if `Metric` is `url`.

Returns:

Limit Returns the first N data entries. The default value is 100 if this parameter is not specified, whereas 1000 if `Metric` is `url`.

setLimit

public void setLimit(Long Limit)

Set Returns the first N data entries. The default value is 100 if this parameter is not specified, whereas 1000 if `Metric` is `url`.

Parameters:

Limit - Returns the first N data entries. The default value is 100 if this parameter is not specified, whereas 1000 if `Metric` is `url`.

toMap

public void toMap(HashMap<String,String> map,
                  String prefix)

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel