public class DescribeCdnDataRequest extends AbstractModel
header, skipSign
Constructor and Description |
---|
DescribeCdnDataRequest() |
DescribeCdnDataRequest(DescribeCdnDataRequest 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.
|
Modifier and Type | Method and Description |
---|---|
String |
getArea()
Get Specifies the service area.
|
String |
getAreaType()
Get Specify whether to query by the region of the server or client.
|
String |
getDataSource()
Get Specifies the data source to be queried.
|
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 the Chinese mainland.
|
String[] |
getDomains()
Get Specifies the list of domain names to be queried
You can specify one or more domain names.
|
String |
getEndTime()
Get End time of the query, e.g.
|
String |
getInterval()
Get Sampling interval.
|
String |
getIpProtocol()
Get Specifies the IP protocol to be queried.
|
Long |
getIsp()
Get Specifies an ISP when you query the CDN data within the Chinese mainland.
|
String |
getMetric()
Get Specifies the metric to query, which can be:
`flux`: Traffic (in bytes)
`fluxIn`: Upstream traffic (in bytes), only used for the `ecdn` product
`fluxOut`: Downstream traffic (in bytes), only used for the `ecdn` product
`bandwidth`: Bandwidth (in bps)
`bandwidthIn`: Upstream bandwidth (in bps), only used for the `ecdn` product
`bandwidthOut`: Downstream bandwidth (in bps), only used for the `ecdn` product
`request`: Number of requests
`hitRequest`: Number of hit requests
`requestHitRate`: Request hit rate (in % with two decimal digits)
`hitFlux`: Hit traffic (in bytes)
`fluxHitRate`: Traffic hit rate (in % with two decimal digits)
`statusCode`: Status code.
|
String |
getProduct()
Get Specifies the product to query, either `cdn` (default) or `ecdn`.
|
Long |
getProject()
Get Specifies the project ID to be queried.
|
String |
getProtocol()
Get Specifies the protocol to be queried; if you leave it blank, all protocols will be queried.
|
String |
getStartTime()
Get Start time of the query, e.g., 2018-09-04 10:40:00.
|
String |
getTimeZone()
Get Specifies a time zone to query.
|
void |
setArea(String Area)
Set Specifies the service area.
|
void |
setAreaType(String AreaType)
Set Specify whether to query by the region of the server or client.
|
void |
setDataSource(String DataSource)
Set Specifies the data source to be queried.
|
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 the Chinese mainland.
|
void |
setDomains(String[] Domains)
Set Specifies the list of domain names to be queried
You can specify one or more domain names.
|
void |
setEndTime(String EndTime)
Set End time of the query, e.g.
|
void |
setInterval(String Interval)
Set Sampling interval.
|
void |
setIpProtocol(String IpProtocol)
Set Specifies the IP protocol to be queried.
|
void |
setIsp(Long Isp)
Set Specifies an ISP when you query the CDN data within the Chinese mainland.
|
void |
setMetric(String Metric)
Set Specifies the metric to query, which can be:
`flux`: Traffic (in bytes)
`fluxIn`: Upstream traffic (in bytes), only used for the `ecdn` product
`fluxOut`: Downstream traffic (in bytes), only used for the `ecdn` product
`bandwidth`: Bandwidth (in bps)
`bandwidthIn`: Upstream bandwidth (in bps), only used for the `ecdn` product
`bandwidthOut`: Downstream bandwidth (in bps), only used for the `ecdn` product
`request`: Number of requests
`hitRequest`: Number of hit requests
`requestHitRate`: Request hit rate (in % with two decimal digits)
`hitFlux`: Hit traffic (in bytes)
`fluxHitRate`: Traffic hit rate (in % with two decimal digits)
`statusCode`: Status code.
|
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.
|
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 Start time of the query, e.g., 2018-09-04 10:40:00.
|
void |
setTimeZone(String TimeZone)
Set Specifies a time zone to query.
|
void |
toMap(HashMap<String,String> map,
String prefix)
Internal implementation, normal users should not use it.
|
any, fromJsonString, getBinaryParams, GetHeader, getMultipartRequestParams, getSkipSign, set, SetHeader, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, setSkipSign, toJsonString
public DescribeCdnDataRequest()
public DescribeCdnDataRequest(DescribeCdnDataRequest source)
public String getStartTime()
public void setStartTime(String StartTime)
StartTime
- Start time of the query, e.g., 2018-09-04 10:40:00.
The specified start time will be rounded down based on the granularity parameter `Interval`. For example, if you set the start time to 2018-09-04 10:40:00 with 1-hour granularity, the time will be rounded down to 2018-09-04 10:00:00.
The period between the start time and end time can be up to 90 days.public String getEndTime()
public void setEndTime(String EndTime)
EndTime
- End time of the query, e.g. 2018-09-04 10:40:00.
The specified end time will be rounded down based on the granularity parameter `Interval`. For example, if you set the end time to 2018-09-04 10:40:00 with 1-hour granularity, the time will be rounded down to 2018-09-04 10:00:00.
The period between the start time and end time can be up to 90 days.public String getMetric()
public void setMetric(String Metric)
Metric
- Specifies the metric to query, which can be:
`flux`: Traffic (in bytes)
`fluxIn`: Upstream traffic (in bytes), only used for the `ecdn` product
`fluxOut`: Downstream traffic (in bytes), only used for the `ecdn` product
`bandwidth`: Bandwidth (in bps)
`bandwidthIn`: Upstream bandwidth (in bps), only used for the `ecdn` product
`bandwidthOut`: Downstream bandwidth (in bps), only used for the `ecdn` product
`request`: Number of requests
`hitRequest`: Number of hit requests
`requestHitRate`: Request hit rate (in % with two decimal digits)
`hitFlux`: Hit traffic (in bytes)
`fluxHitRate`: Traffic hit rate (in % with two decimal digits)
`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)
Specifies the status code to query. The return will be empty if the status code has never been generated.public String[] getDomains()
public void setDomains(String[] Domains)
Domains
- Specifies the list of domain names to be queried
You can specify one or more domain names.
Up to 30 domain names can be queried in one request.
If this parameter is not specified, it means to query all domain names under the current account.public Long getProject()
public void setProject(Long Project)
Project
- Specifies the project ID to be queried. [Check project ID in the console](https://console.cloud.tencent.com/project)
Note that `Project` will be ignored if `Domains` is specified.public String getInterval()
public void setInterval(String Interval)
Interval
- Sampling interval. The available options vary for different query period. See below:
`min`: Return data with 1-minute granularity. It’s available when the query period is within 24 hours and `Area` is `mainland`.
`5min`: Return data with 5-minute granularity. It’s available when the query period is within 31 days.
`hour`: Return data with 1-hour granularity. It’s available when the query period is within 31 days.
`day`: Return data with 1-day granularity. It’s available when the query period is longer than 31 days.public Boolean getDetail()
public void setDetail(Boolean Detail)
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).public Long getIsp()
public void setIsp(Long Isp)
Isp
- Specifies an ISP when you query the CDN data within the Chinese mainland. 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)
Note that only one of `District`, `Isp` and `IpProtocol` can be specified.public Long getDistrict()
public void setDistrict(Long District)
District
- Specifies a province when you query the CDN data within the Chinese mainland. If this is left blank, all provinces will be queried.
Specifies a country/region when you query the CDN data outside the Chinese mainland. 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).
When `Area` is `mainland`, you can query by the province. Note that only one of `District`, `Isp` and `IpProtocol` can be specified.public String getProtocol()
public void setProtocol(String Protocol)
Protocol
- Specifies the protocol to be queried; if you leave it blank, all protocols will be queried.
`all`: All protocols
`http`: Query HTTP data
`https`: Query HTTPS datapublic String getDataSource()
public void setDataSource(String DataSource)
DataSource
- Specifies the data source to be queried. It’s only open to beta users now.public String getIpProtocol()
public void setIpProtocol(String IpProtocol)
IpProtocol
- Specifies the IP protocol to be queried. If it’s not specified, data of all IP protocols are returned.
`all`: All protocols
`ipv4`: Query IPv4 data
`ipv6`: Query IPv6 data
If `IpProtocol` is specified, `District` parameter can not be specified at the same time.
Note: `ipv4` and `ipv6` are only available to beta users.public String getArea()
public void setArea(String Area)
Area
- Specifies the service area. If it’s not specified, CDN data of the Chinese mainland are returned.
`mainland`: Query CDN data in the Chinese mainland.
`overseas`: Query CDN data outside the Chinese mainland.public String getAreaType()
public void setAreaType(String AreaType)
AreaType
- Specify whether to query by the region of the server or client. This parameter is valid only when `Area` is `overseas`.
`server`: Query by the location of server (Tencent Cloud CDN nodes)
`client`: Query by the location of the client (where the request devices are located)public String getProduct()
public void setProduct(String Product)
Product
- Specifies the product to query, either `cdn` (default) or `ecdn`.public String getTimeZone()
public void setTimeZone(String TimeZone)
TimeZone
- Specifies a time zone to query. The default time zone is UTC+08:00.Copyright © 2024. All rights reserved.