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

Constructor Summary

Constructors

Constructor and Description
ListTopDataRequest()

Method Summary

Modifier and Type	Method and Description
String	getArea() Get Specifies a service region for the query.
String	getAreaType() Get The region type can be specified only when you query CDN data outside Mainland China and `Metric` is `district` or `host`; if you leave it empty, data of the service region will be queried (only applicable when `Area` is `overseas` and `Metric` is `district` or `host`) server: specifies to query data of service region (where a CDN node is located) client: specifies to query data of the client region (where a user request device is located).
String	getCode() Get When Filter is `statusCode` or `OriginStatusCode`, enter a code to query and sort results.
Boolean	getDetail() Get Default is `false` for multi-domain name queries, which returns sorted results of all domain names.
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 supports data query at daily granularity.
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.
String	getMetric() Get Object representing the sort criteria.
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 supports data query at daily granularity.
void	setArea(String Area) Set Specifies a service region for the query.
void	setAreaType(String AreaType) Set The region type can be specified only when you query CDN data outside Mainland China and `Metric` is `district` or `host`; if you leave it empty, data of the service region will be queried (only applicable when `Area` is `overseas` and `Metric` is `district` or `host`) server: specifies to query data of service region (where a CDN node is located) client: specifies to query data of the client region (where a user request device is located).
void	setCode(String Code) Set When Filter is `statusCode` or `OriginStatusCode`, enter a code to query and sort results.
void	setDetail(Boolean Detail) Set Default is `false` for multi-domain name queries, which returns sorted results of all domain names.
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 supports data query at daily granularity.
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	setMetric(String Metric) Set Object representing the sort criteria.
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 supports data query at daily granularity.
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, getMultipartRequestParams, set, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, toJsonString

Methods inherited from class java.lang.Object

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

Constructor Detail

ListTopDataRequest

public ListTopDataRequest()

Method Detail

getStartTime

public String getStartTime()

Get Query start time in the format of `yyyy-MM-dd HH:mm:ss` Only supports data query at daily granularity. The date in the input parameter is used as the start date. Data generated after or at 00:00:00 on the start date will be returned 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 supports data query at daily granularity. The date in the input parameter is used as the start date. Data generated after or at 00:00:00 on the start date will be returned 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 supports data query at daily granularity. The date in the input parameter is used as the start date. Data generated after or at 00:00:00 on the start date will be returned 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 supports data query at daily granularity. The date in the input parameter is used as the start date. Data generated after or at 00:00:00 on the start date will be returned 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 supports data query at daily granularity. The date in the input parameter is used as the end date. Data generated before or at 23:59:59 on the end date will be returned `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 supports data query at daily granularity. The date in the input parameter is used as the end date. Data generated before or at 23:59:59 on the end date will be returned `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 supports data query at daily granularity. The date in the input parameter is used as the end date. Data generated before or at 23:59:59 on the end date will be returned `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 supports data query at daily granularity. The date in the input parameter is used as the end date. Data generated before or at 23:59:59 on the end date will be returned `EndTime` must be later than or equal to `StartTime`

getMetric

public String getMetric()

Get Object representing the sort criteria. The following objects are supported: url: sorts by access URL (including the query string). Supported filters are `flux` and `request` path: sorts by access URL (excluding the query string). Supported filters are `flux` and `request` (allowlist-based feature) district: sorts by district. Supported filters are `flux` and `request` isp: sorts by ISP. Supported filters are `flux` and `request` host: sorts by domain name access data. Supported filters are `flux`, `request`, `bandwidth`, `fluxHitRate`, 2XX, 3XX, 4XX, 5XX, and `statusCode` originHost: sorts by domain name origin-pull data. Supported filters are `flux`, `request`, `bandwidth`, `origin_2XX`, `origin_3XX`, `origin_4XX`, `origin_5XX`, and `OriginStatusCode`

Returns:

Metric Object representing the sort criteria. The following objects are supported: url: sorts by access URL (including the query string). Supported filters are `flux` and `request` path: sorts by access URL (excluding the query string). Supported filters are `flux` and `request` (allowlist-based feature) district: sorts by district. Supported filters are `flux` and `request` isp: sorts by ISP. Supported filters are `flux` and `request` host: sorts by domain name access data. Supported filters are `flux`, `request`, `bandwidth`, `fluxHitRate`, 2XX, 3XX, 4XX, 5XX, and `statusCode` originHost: sorts by domain name origin-pull data. Supported filters are `flux`, `request`, `bandwidth`, `origin_2XX`, `origin_3XX`, `origin_4XX`, `origin_5XX`, and `OriginStatusCode`

setMetric

public void setMetric(String Metric)

Set Object representing the sort criteria. The following objects are supported: url: sorts by access URL (including the query string). Supported filters are `flux` and `request` path: sorts by access URL (excluding the query string). Supported filters are `flux` and `request` (allowlist-based feature) district: sorts by district. Supported filters are `flux` and `request` isp: sorts by ISP. Supported filters are `flux` and `request` host: sorts by domain name access data. Supported filters are `flux`, `request`, `bandwidth`, `fluxHitRate`, 2XX, 3XX, 4XX, 5XX, and `statusCode` originHost: sorts by domain name origin-pull data. Supported filters are `flux`, `request`, `bandwidth`, `origin_2XX`, `origin_3XX`, `origin_4XX`, `origin_5XX`, and `OriginStatusCode`

Parameters:

Metric - Object representing the sort criteria. The following objects are supported: url: sorts by access URL (including the query string). Supported filters are `flux` and `request` path: sorts by access URL (excluding the query string). Supported filters are `flux` and `request` (allowlist-based feature) district: sorts by district. Supported filters are `flux` and `request` isp: sorts by ISP. Supported filters are `flux` and `request` host: sorts by domain name access data. Supported filters are `flux`, `request`, `bandwidth`, `fluxHitRate`, 2XX, 3XX, 4XX, 5XX, and `statusCode` originHost: sorts by domain name origin-pull data. Supported filters are `flux`, `request`, `bandwidth`, `origin_2XX`, `origin_3XX`, `origin_4XX`, `origin_5XX`, and `OriginStatusCode`

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 Default is `false` for multi-domain name queries, which returns sorted results of all domain names. 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 Default is `false` for multi-domain name queries, which returns sorted results of all domain names. 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 Default is `false` for multi-domain name queries, which returns sorted results of all domain names. 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 - Default is `false` for multi-domain name queries, which returns sorted results of all domain names. 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 a service region for the query. If it is left blank, CDN data within Mainland China will be queried. `mainland`: specifies to query CDN data within Mainland China; `overseas`: specifies to query CDN data outside Mainland China. Supported metrics are `url`, `district`, `host`, and `originHost`. If `Metric` is `originHost`, supported filters are `flux`, `request`, and `bandwidth`.

Returns:

Area Specifies a service region for the query. If it is left blank, CDN data within Mainland China will be queried. `mainland`: specifies to query CDN data within Mainland China; `overseas`: specifies to query CDN data outside Mainland China. 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 a service region for the query. If it is left blank, CDN data within Mainland China will be queried. `mainland`: specifies to query CDN data within Mainland China; `overseas`: specifies to query CDN data outside Mainland China. Supported metrics are `url`, `district`, `host`, and `originHost`. If `Metric` is `originHost`, supported filters are `flux`, `request`, and `bandwidth`.

Parameters:

Area - Specifies a service region for the query. If it is left blank, CDN data within Mainland China will be queried. `mainland`: specifies to query CDN data within Mainland China; `overseas`: specifies to query CDN data outside Mainland China. Supported metrics are `url`, `district`, `host`, and `originHost`. If `Metric` is `originHost`, supported filters are `flux`, `request`, and `bandwidth`.

getAreaType

public String getAreaType()

Get The region type can be specified only when you query CDN data outside Mainland China and `Metric` is `district` or `host`; if you leave it empty, data of the service region will be queried (only applicable when `Area` is `overseas` and `Metric` is `district` or `host`) server: specifies to query data of service region (where a CDN node is located) client: specifies to query data of the client region (where a user request device is located). If `Metric` is `host`, `Filter` can only be `flux`, `request`, or `bandwidth`

Returns:

AreaType The region type can be specified only when you query CDN data outside Mainland China and `Metric` is `district` or `host`; if you leave it empty, data of the service region will be queried (only applicable when `Area` is `overseas` and `Metric` is `district` or `host`) server: specifies to query data of service region (where a CDN node is located) client: specifies to query data of the client region (where a user request device is located). If `Metric` is `host`, `Filter` can only be `flux`, `request`, or `bandwidth`

setAreaType

public void setAreaType(String AreaType)

Set The region type can be specified only when you query CDN data outside Mainland China and `Metric` is `district` or `host`; if you leave it empty, data of the service region will be queried (only applicable when `Area` is `overseas` and `Metric` is `district` or `host`) server: specifies to query data of service region (where a CDN node is located) client: specifies to query data of the client region (where a user request device is located). If `Metric` is `host`, `Filter` can only be `flux`, `request`, or `bandwidth`

Parameters:

AreaType - The region type can be specified only when you query CDN data outside Mainland China and `Metric` is `district` or `host`; if you leave it empty, data of the service region will be queried (only applicable when `Area` is `overseas` and `Metric` is `district` or `host`) server: specifies to query data of service region (where a CDN node is located) client: specifies to query data of the client region (where a user request device is located). If `Metric` is `host`, `Filter` can only be `flux`, `request`, or `bandwidth`

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel