com.tencentcloudapi.cdn.v20180606.models

Class DescribeCdnDataRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.cdn.v20180606.models.DescribeCdnDataRequest

public class DescribeCdnDataRequest
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
DescribeCdnDataRequest()

Method Summary

Modifier and Type	Method and Description
String	getArea() Get Specifies a service region.
String	getAreaType() Get Specifies a region type for your query on CDN data outside Mainland China.
String	getDataSource() Get Specifies the data source to be queried, which can be seen as the allowlist function.
Boolean	getDetail() Get The aggregate data for multiple domain names is returned by default (false) during a multi-domain-name query.
Long	getDistrict() Get Specifies a province when you query the CDN data within Mainland China.
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 Queries end time, such as 2018-09-04 10:40:00; the returned result is earlier than or equal to the specified time.
String	getInterval() Get Time granularity; valid values: `min`: data with 1-minute granularity is returned when the queried period is no longer than 24 hours.
String	getIpProtocol() Get Specified IP protocol to be queried.
Long	getIsp() Get Specifies an ISP when you query the CDN data within Mainland China.
String	getMetric() Get Specifies the query metric, which can be: flux: traffic (in bytes) bandwidth: bandwidth (in bps) request: number of requests fluxHitRate: traffic hit rate (in %) statusCode: status code.
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	getProtocol() Get Specifies the protocol to be queried; if you leave it blank, all protocols will be queried.
String	getStartTime() Get Queries start time, such as 2018-09-04 10:40:00; the returned result is later than or equal to the specified time.
void	setArea(String Area) Set Specifies a service region.
void	setAreaType(String AreaType) Set Specifies a region type for your query on CDN data outside Mainland China.
void	setDataSource(String DataSource) Set Specifies the data source to be queried, which can be seen as the allowlist function.
void	setDetail(Boolean Detail) Set The aggregate data for multiple domain names is returned by default (false) during a multi-domain-name query.
void	setDistrict(Long District) Set Specifies a province when you query the CDN data within Mainland China.
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 Queries end time, such as 2018-09-04 10:40:00; the returned result is earlier than or equal to the specified time.
void	setInterval(String Interval) Set Time granularity; valid values: `min`: data with 1-minute granularity is returned when the queried period is no longer than 24 hours.
void	setIpProtocol(String IpProtocol) Set Specified IP protocol to be queried.
void	setIsp(Long Isp) Set Specifies an ISP when you query the CDN data within Mainland China.
void	setMetric(String Metric) Set Specifies the query metric, which can be: flux: traffic (in bytes) bandwidth: bandwidth (in bps) request: number of requests fluxHitRate: traffic hit rate (in %) statusCode: status code.
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	setProtocol(String Protocol) Set Specifies the protocol to be queried; if you leave it blank, all protocols will be queried.
void	setStartTime(String StartTime) Set Queries start time, such as 2018-09-04 10:40:00; the returned result is later than or equal to the specified time.
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

DescribeCdnDataRequest

public DescribeCdnDataRequest()

Method Detail

getStartTime

public String getStartTime()

Get Queries start time, such as 2018-09-04 10:40:00; the returned result is later than or equal to the specified time. According to the specified time granularity, forward rounding is applied; for example, if the query end time is 2018-09-04 10:40:00 and the query time granularity is 1 hour, the time for the first returned entry will be 2018-09-04 10:00:00. The gap between the start time and end time should be less than or equal to 90 days.

Returns:

StartTime Queries start time, such as 2018-09-04 10:40:00; the returned result is later than or equal to the specified time. According to the specified time granularity, forward rounding is applied; for example, if the query end time is 2018-09-04 10:40:00 and the query time granularity is 1 hour, the time for the first returned entry will be 2018-09-04 10:00:00. The gap between the start time and end time should be less than or equal to 90 days.

setStartTime

public void setStartTime(String StartTime)

Set Queries start time, such as 2018-09-04 10:40:00; the returned result is later than or equal to the specified time. According to the specified time granularity, forward rounding is applied; for example, if the query end time is 2018-09-04 10:40:00 and the query time granularity is 1 hour, the time for the first returned entry will be 2018-09-04 10:00:00. The gap between the start time and end time should be less than or equal to 90 days.

Parameters:

StartTime - Queries start time, such as 2018-09-04 10:40:00; the returned result is later than or equal to the specified time. According to the specified time granularity, forward rounding is applied; for example, if the query end time is 2018-09-04 10:40:00 and the query time granularity is 1 hour, the time for the first returned entry will be 2018-09-04 10:00:00. The gap between the start time and end time should be less than or equal to 90 days.

getEndTime

public String getEndTime()

Get Queries end time, such as 2018-09-04 10:40:00; the returned result is earlier than or equal to the specified time. According to the specified time granularity, forward rounding is applied; for example, if the query start time is 2018-09-04 10:40:00 and the query time granularity is 1 hour, the time for the last returned entry will be 2018-09-04 10:00:00. The gap between the start time and end time should be less than or equal to 90 days.

Returns:

EndTime Queries end time, such as 2018-09-04 10:40:00; the returned result is earlier than or equal to the specified time. According to the specified time granularity, forward rounding is applied; for example, if the query start time is 2018-09-04 10:40:00 and the query time granularity is 1 hour, the time for the last returned entry will be 2018-09-04 10:00:00. The gap between the start time and end time should be less than or equal to 90 days.

setEndTime

public void setEndTime(String EndTime)

Set Queries end time, such as 2018-09-04 10:40:00; the returned result is earlier than or equal to the specified time. According to the specified time granularity, forward rounding is applied; for example, if the query start time is 2018-09-04 10:40:00 and the query time granularity is 1 hour, the time for the last returned entry will be 2018-09-04 10:00:00. The gap between the start time and end time should be less than or equal to 90 days.

Parameters:

EndTime - Queries end time, such as 2018-09-04 10:40:00; the returned result is earlier than or equal to the specified time. According to the specified time granularity, forward rounding is applied; for example, if the query start time is 2018-09-04 10:40:00 and the query time granularity is 1 hour, the time for the last returned entry will be 2018-09-04 10:00:00. The gap between the start time and end time should be less than or equal to 90 days.

getMetric

public String getMetric()

Get Specifies the query metric, which can be: flux: traffic (in bytes) bandwidth: bandwidth (in bps) request: number of requests fluxHitRate: traffic hit rate (in %) statusCode: status code. The aggregate data for 2xx, 3xx, 4xx, and 5xx status codes will be returned (in entries) 2xx: Returns the aggregate list of 2xx status codes and the data for status codes starting with 2 (in entries) 3xx: Returns the aggregate list of 3xx status codes and the data for status codes starting with 3 (in entries) 4xx: Returns the aggregate list of 4xx status codes and the data for status codes starting with 4 (in entries) 5xx: Returns the aggregate list of 5xx status codes and the data for status codes starting with 5 (in entries) It is supported to specify a status code for query. The return will be empty if the status code has never been generated.

Returns:

Metric Specifies the query metric, which can be: flux: traffic (in bytes) bandwidth: bandwidth (in bps) request: number of requests fluxHitRate: traffic hit rate (in %) statusCode: status code. The aggregate data for 2xx, 3xx, 4xx, and 5xx status codes will be returned (in entries) 2xx: Returns the aggregate list of 2xx status codes and the data for status codes starting with 2 (in entries) 3xx: Returns the aggregate list of 3xx status codes and the data for status codes starting with 3 (in entries) 4xx: Returns the aggregate list of 4xx status codes and the data for status codes starting with 4 (in entries) 5xx: Returns the aggregate list of 5xx status codes and the data for status codes starting with 5 (in entries) It is supported to specify a status code for query. The return will be empty if the status code has never been generated.

setMetric

public void setMetric(String Metric)

Set Specifies the query metric, which can be: flux: traffic (in bytes) bandwidth: bandwidth (in bps) request: number of requests fluxHitRate: traffic hit rate (in %) statusCode: status code. The aggregate data for 2xx, 3xx, 4xx, and 5xx status codes will be returned (in entries) 2xx: Returns the aggregate list of 2xx status codes and the data for status codes starting with 2 (in entries) 3xx: Returns the aggregate list of 3xx status codes and the data for status codes starting with 3 (in entries) 4xx: Returns the aggregate list of 4xx status codes and the data for status codes starting with 4 (in entries) 5xx: Returns the aggregate list of 5xx status codes and the data for status codes starting with 5 (in entries) It is supported to specify a status code for query. The return will be empty if the status code has never been generated.

Parameters:

Metric - Specifies the query metric, which can be: flux: traffic (in bytes) bandwidth: bandwidth (in bps) request: number of requests fluxHitRate: traffic hit rate (in %) statusCode: status code. The aggregate data for 2xx, 3xx, 4xx, and 5xx status codes will be returned (in entries) 2xx: Returns the aggregate list of 2xx status codes and the data for status codes starting with 2 (in entries) 3xx: Returns the aggregate list of 3xx status codes and the data for status codes starting with 3 (in entries) 4xx: Returns the aggregate list of 4xx status codes and the data for status codes starting with 4 (in entries) 5xx: Returns the aggregate list of 5xx status codes and the data for status codes starting with 5 (in entries) It is supported to specify a status code for query. The return will be empty if the status code has never been generated.

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.

getInterval

public String getInterval()

Get Time granularity; valid values: `min`: data with 1-minute granularity is returned when the queried period is no longer than 24 hours. This value is not supported if the service region you want to query is outside Mainland China; `5min`: data with 5-minute granularity is returned when the queried period is no longer than 31 days; `hour`: data with 1-hour granularity is returned when the queried period is no longer than 31 days; `day`: data with 1-day granularity is returned when the queried period is longer than 31 days.

Returns:

Interval Time granularity; valid values: `min`: data with 1-minute granularity is returned when the queried period is no longer than 24 hours. This value is not supported if the service region you want to query is outside Mainland China; `5min`: data with 5-minute granularity is returned when the queried period is no longer than 31 days; `hour`: data with 1-hour granularity is returned when the queried period is no longer than 31 days; `day`: data with 1-day granularity is returned when the queried period is longer than 31 days.

setInterval

public void setInterval(String Interval)

Set Time granularity; valid values: `min`: data with 1-minute granularity is returned when the queried period is no longer than 24 hours. This value is not supported if the service region you want to query is outside Mainland China; `5min`: data with 5-minute granularity is returned when the queried period is no longer than 31 days; `hour`: data with 1-hour granularity is returned when the queried period is no longer than 31 days; `day`: data with 1-day granularity is returned when the queried period is longer than 31 days.

Parameters:

Interval - Time granularity; valid values: `min`: data with 1-minute granularity is returned when the queried period is no longer than 24 hours. This value is not supported if the service region you want to query is outside Mainland China; `5min`: data with 5-minute granularity is returned when the queried period is no longer than 31 days; `hour`: data with 1-hour granularity is returned when the queried period is no longer than 31 days; `day`: data with 1-day granularity is returned when the queried period is longer than 31 days.

getDetail

public Boolean getDetail()

Get The aggregate data for multiple domain names is returned by default (false) during a multi-domain-name query. You can set it to true to return the details for each Domain (the statusCode metric is currently not supported)

Returns:

Detail The aggregate data for multiple domain names is returned by default (false) during a multi-domain-name query. You can set it to true to return the details for each Domain (the statusCode metric is currently not supported)

setDetail

public void setDetail(Boolean Detail)

Set The aggregate data for multiple domain names is returned by default (false) during a multi-domain-name query. You can set it to true to return the details for each Domain (the statusCode metric is currently not supported)

Parameters:

Detail - The aggregate data for multiple domain names is returned by default (false) during a multi-domain-name query. You can set it to true to return the details for each Domain (the statusCode metric is currently not supported)

getIsp

public Long getIsp()

Get Specifies an ISP when you query the CDN data within Mainland China. If this is left blank, all ISPs will be queried. To view ISP codes, see [ISP Code Mappings](https://intl.cloud.tencent.com/document/product/228/6316?from_cn_redirect=1#.E5.8C.BA.E5.9F.9F-.2F-.E8.BF.90.E8.90.A5.E5.95.86.E6.98.A0.E5.B0.84.E8.A1.A8) If you have specified an ISP, you cannot specify a province or an IP protocol for the same query.

Returns:

Isp Specifies an ISP when you query the CDN data within Mainland China. If this is left blank, all ISPs will be queried. To view ISP codes, see [ISP Code Mappings](https://intl.cloud.tencent.com/document/product/228/6316?from_cn_redirect=1#.E5.8C.BA.E5.9F.9F-.2F-.E8.BF.90.E8.90.A5.E5.95.86.E6.98.A0.E5.B0.84.E8.A1.A8) If you have specified an ISP, you cannot specify a province or an IP protocol for the same query.

setIsp

public void setIsp(Long Isp)

Set Specifies an ISP when you query the CDN data within Mainland China. If this is left blank, all ISPs will be queried. To view ISP codes, see [ISP Code Mappings](https://intl.cloud.tencent.com/document/product/228/6316?from_cn_redirect=1#.E5.8C.BA.E5.9F.9F-.2F-.E8.BF.90.E8.90.A5.E5.95.86.E6.98.A0.E5.B0.84.E8.A1.A8) If you have specified an ISP, you cannot specify a province or an IP protocol for the same query.

Parameters:

Isp - Specifies an ISP when you query the CDN data within Mainland China. If this is left blank, all ISPs will be queried. To view ISP codes, see [ISP Code Mappings](https://intl.cloud.tencent.com/document/product/228/6316?from_cn_redirect=1#.E5.8C.BA.E5.9F.9F-.2F-.E8.BF.90.E8.90.A5.E5.95.86.E6.98.A0.E5.B0.84.E8.A1.A8) If you have specified an ISP, you cannot specify a province or an IP protocol for the same query.

getDistrict

public Long getDistrict()

Get Specifies a province when you query the CDN data within Mainland China. If this is left blank, all provinces will be queried. Specifies a country/region when you query the CDN data outside Mainland China. If this is left blank, all countries/regions will be queried. To view codes of provinces or countries/regions, see [Province Code Mappings](https://intl.cloud.tencent.com/document/product/228/6316?from_cn_redirect=1#.E5.8C.BA.E5.9F.9F-.2F-.E8.BF.90.E8.90.A5.E5.95.86.E6.98.A0.E5.B0.84.E8.A1.A8) If you have specified a province for your query on CDN data within mainland China, you cannot specify an ISP or an IP protocol for the same query.

Returns:

District Specifies a province when you query the CDN data within Mainland China. If this is left blank, all provinces will be queried. Specifies a country/region when you query the CDN data outside Mainland China. If this is left blank, all countries/regions will be queried. To view codes of provinces or countries/regions, see [Province Code Mappings](https://intl.cloud.tencent.com/document/product/228/6316?from_cn_redirect=1#.E5.8C.BA.E5.9F.9F-.2F-.E8.BF.90.E8.90.A5.E5.95.86.E6.98.A0.E5.B0.84.E8.A1.A8) If you have specified a province for your query on CDN data within mainland China, you cannot specify an ISP or an IP protocol for the same query.

setDistrict

public void setDistrict(Long District)

Set Specifies a province when you query the CDN data within Mainland China. If this is left blank, all provinces will be queried. Specifies a country/region when you query the CDN data outside Mainland China. If this is left blank, all countries/regions will be queried. To view codes of provinces or countries/regions, see [Province Code Mappings](https://intl.cloud.tencent.com/document/product/228/6316?from_cn_redirect=1#.E5.8C.BA.E5.9F.9F-.2F-.E8.BF.90.E8.90.A5.E5.95.86.E6.98.A0.E5.B0.84.E8.A1.A8) If you have specified a province for your query on CDN data within mainland China, you cannot specify an ISP or an IP protocol for the same query.

Parameters:

District - Specifies a province when you query the CDN data within Mainland China. If this is left blank, all provinces will be queried. Specifies a country/region when you query the CDN data outside Mainland China. If this is left blank, all countries/regions will be queried. To view codes of provinces or countries/regions, see [Province Code Mappings](https://intl.cloud.tencent.com/document/product/228/6316?from_cn_redirect=1#.E5.8C.BA.E5.9F.9F-.2F-.E8.BF.90.E8.90.A5.E5.95.86.E6.98.A0.E5.B0.84.E8.A1.A8) If you have specified a province for your query on CDN data within mainland China, you cannot specify an ISP or an IP protocol for the same query.

getProtocol

public String getProtocol()

Get Specifies the protocol to be queried; if you leave it blank, all protocols will be queried. all: All protocols http: specifies the HTTP metric to be queried https: specifies the HTTPS metric to be queried

Returns:

Protocol Specifies the protocol to be queried; if you leave it blank, all protocols will be queried. all: All protocols http: specifies the HTTP metric to be queried https: specifies the HTTPS metric to be queried

setProtocol

public void setProtocol(String Protocol)

Set Specifies the protocol to be queried; if you leave it blank, all protocols will be queried. all: All protocols http: specifies the HTTP metric to be queried https: specifies the HTTPS metric to be queried

Parameters:

Protocol - Specifies the protocol to be queried; if you leave it blank, all protocols will be queried. all: All protocols http: specifies the HTTP metric to be queried https: specifies the HTTPS metric to be queried

getDataSource

public String getDataSource()

Get Specifies the data source to be queried, which can be seen as the allowlist function.

Returns:

DataSource Specifies the data source to be queried, which can be seen as the allowlist function.

setDataSource

public void setDataSource(String DataSource)

Set Specifies the data source to be queried, which can be seen as the allowlist function.

Parameters:

DataSource - Specifies the data source to be queried, which can be seen as the allowlist function.

getIpProtocol

public String getIpProtocol()

Get Specified IP protocol to be queried. If this parameter is left empty, all protocols will be queried all: all protocols ipv4: specifies to query IPv4 metrics ipv6: specifies to query IPv6 metrics If the IP protocol to be queried is specified, the district and ISP cannot be specified at the same time Note: non-IPv6 allowlisted users cannot specify `ipv4` and `ipv6` for query

Returns:

IpProtocol Specified IP protocol to be queried. If this parameter is left empty, all protocols will be queried all: all protocols ipv4: specifies to query IPv4 metrics ipv6: specifies to query IPv6 metrics If the IP protocol to be queried is specified, the district and ISP cannot be specified at the same time Note: non-IPv6 allowlisted users cannot specify `ipv4` and `ipv6` for query

setIpProtocol

public void setIpProtocol(String IpProtocol)

Set Specified IP protocol to be queried. If this parameter is left empty, all protocols will be queried all: all protocols ipv4: specifies to query IPv4 metrics ipv6: specifies to query IPv6 metrics If the IP protocol to be queried is specified, the district and ISP cannot be specified at the same time Note: non-IPv6 allowlisted users cannot specify `ipv4` and `ipv6` for query

Parameters:

IpProtocol - Specified IP protocol to be queried. If this parameter is left empty, all protocols will be queried all: all protocols ipv4: specifies to query IPv4 metrics ipv6: specifies to query IPv6 metrics If the IP protocol to be queried is specified, the district and ISP cannot be specified at the same time Note: non-IPv6 allowlisted users cannot specify `ipv4` and `ipv6` for query

getArea

public String getArea()

Get Specifies a service region. If this value 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.

Returns:

Area Specifies a service region. If this value 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.

setArea

public void setArea(String Area)

Set Specifies a service region. If this value 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.

Parameters:

Area - Specifies a service region. If this value 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.

getAreaType

public String getAreaType()

Get Specifies a region type for your query on CDN data outside Mainland China. If this parameter is left blank, data on the service region will be queried. This parameter is valid only when `Area` is `overseas`. `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.

Returns:

AreaType Specifies a region type for your query on CDN data outside Mainland China. If this parameter is left blank, data on the service region will be queried. This parameter is valid only when `Area` is `overseas`. `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.

setAreaType

public void setAreaType(String AreaType)

Set Specifies a region type for your query on CDN data outside Mainland China. If this parameter is left blank, data on the service region will be queried. This parameter is valid only when `Area` is `overseas`. `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.

Parameters:

AreaType - Specifies a region type for your query on CDN data outside Mainland China. If this parameter is left blank, data on the service region will be queried. This parameter is valid only when `Area` is `overseas`. `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.

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel