public class ListTopDataRequest extends AbstractModel
Constructor and Description |
---|
ListTopDataRequest() |
Modifier and Type | Method and Description |
---|---|
String |
getArea()
Get Specifies a service region for the query.
|
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 Default value: `false`, indicating that results for all domain names are returned together when you query multiple 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 date.
|
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 Objects to be sorted.
|
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 date.
|
void |
setArea(String Area)
Set Specifies a service region for the query.
|
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 Default value: `false`, indicating that results for all domain names are returned together when you query multiple 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 date.
|
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 Objects to be sorted.
|
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 date.
|
void |
toMap(HashMap<String,String> map,
String prefix)
Internal implementation, normal users should not use it.
|
any, fromJsonString, getBinaryParams, getMultipartRequestParams, set, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, toJsonString
public String getStartTime()
public void setStartTime(String StartTime)
StartTime
- Query start date. Example: 2018-09-09.
Only supports data query at daily granularity. The date in the input parameter is used as the start date.
Data generated at or after 00:00:00 on the start date will be returned.
Only data from the last 90 days will be queried.public String getEndTime()
public void setEndTime(String EndTime)
EndTime
- Query end date. Example: 2018-09-10
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 greater than or equal to StartTimepublic String getMetric()
public void setMetric(String Metric)
Metric
- Objects to be sorted. Valid values:
`url`: sorts access URLs with query string parameters included. Supported filters are `flux` and `request`.
`path`: sorts access URLs with query string parameters excluded. Supported filters are `flux` and `request`. You need to be whitelisted before using this feature.
`district`: sorts provinces or countries/regions. Supported filters are `flux` and `request`.
`isp`: sorts ISPs. Supported filters are `flux` and `request`.
`host`: sorts 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`, `oringin_4XX`, `origin_5XX` and `OriginStatusCode`public String getFilter()
public void setFilter(String Filter)
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.public String[] getDomains()
public void setDomains(String[] Domains)
Domains
- Specifies the list of domain names to be queried; up to 30 domain names can be queried at a time.public Long getProject()
public void setProject(Long Project)
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.public Boolean getDetail()
public void setDetail(Boolean Detail)
Detail
- Default value: `false`, indicating that results for all domain names are returned together when you query multiple domain names.
If `Metric` is `Url`, `Path`, `District`, or `Isp` and `Filter` is `flux` or `request`, you can set this parameter to `true`, indicating that results for each domain name are returned.public String getCode()
public void setCode(String Code)
Code
- When Filter is `statusCode` or `OriginStatusCode`, enter a code to query and sort results.public String getArea()
public void setArea(String Area)
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`.public String getAreaType()
public void setAreaType(String AreaType)
AreaType
- Specifies a region type for the query. If it is left blank, data on the service region will be queried. This parameter is only valid when `Area` is `overseas` and `Metric` is `District` or `Host`.
`server`: specifies to query data on the service region where Tencent Cloud CDN nodes are located;
`client`: specifies to query data on the client region where the request devices are located; if `Metric` is `Host`, supported filters are `flux`, `request`, and `bandwidth`.Copyright © 2020. All rights reserved.