CdnClient (tencentcloud-sdk-java 3.0.93 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractClient
- - com.tencentcloudapi.cdn.v20180606.CdnClient

public class CdnClient
extends AbstractClient

Field Summary
- Fields inherited from class com.tencentcloudapi.common.AbstractClient
  gson, HTTP_RSP_OK, SDK_VERSION

Constructor Summary

Constructors
Constructor and Description
`CdnClient(Credential credential, String region)` 构造client
`CdnClient(Credential credential, String region, ClientProfile profile)` 构造client

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DescribeCdnDataResponse`	`DescribeCdnData(DescribeCdnDataRequest req)` DescribeCdnData 用于查询 CDN 实时访问监控数据，支持以下指标查询： + 流量（单位为 byte） + 带宽（单位为 bps） + 请求数（单位为次） + 流量命中率（单位为 %，小数点后保留两位） + 状态码 2xx 汇总及各 2 开头状态码明细（单位为个） + 状态码 3xx 汇总及各 3 开头状态码明细（单位为个） + 状态码 4xx 汇总及各 4 开头状态码明细（单位为个） + 状态码 5xx 汇总及各 5 开头状态码明细（单位为个）
`DescribeCdnIpResponse`	`DescribeCdnIp(DescribeCdnIpRequest req)` DescribeCdnIp 用于查询 CDN IP 归属。
`DescribeIpVisitResponse`	`DescribeIpVisit(DescribeIpVisitRequest req)` DescribeIpVisit 用于查询 5 分钟活跃用户数，及日活跃用户数明细 + 5 分钟活跃用户数：根据日志中客户端 IP，5 分钟粒度去重统计 + 日活跃用户数：根据日志中客户端 IP，按天粒度去重统计
`DescribeMapInfoResponse`	`DescribeMapInfo(DescribeMapInfoRequest req)` DescribeMapInfo 用于查询省份对应的 ID，运营商对应的 ID 信息。
`DescribeOriginDataResponse`	`DescribeOriginData(DescribeOriginDataRequest req)` DescribeOriginData 用于查询 CDN 实时回源监控数据，支持以下指标查询： + 回源流量（单位为 byte） + 回源带宽（单位为 bps） + 回源请求数（单位为次） + 回源失败请求数（单位为次） + 回源失败率（单位为 %，小数点后保留两位） + 回源状态码 2xx 汇总及各 2 开头回源状态码明细（单位为个） + 回源状态码 3xx 汇总及各 3 开头回源状态码明细（单位为个） + 回源状态码 4xx 汇总及各 4 开头回源状态码明细（单位为个） + 回源状态码 5xx 汇总及各 5 开头回源状态码明细（单位为个）
`DescribePayTypeResponse`	`DescribePayType(DescribePayTypeRequest req)` DescribePayType 用于查询用户的计费类型，计费周期等信息。
`DescribePurgeTasksResponse`	`DescribePurgeTasks(DescribePurgeTasksRequest req)` DescribePurgeTasks 用于查询刷新任务提交历史记录及执行进度。
`DescribePushTasksResponse`	`DescribePushTasks(DescribePushTasksRequest req)` DescribePushTasks 用于查询预热任务提交历史记录及执行进度。（接口尚在批量公测中，暂未全量开放使用）
`DisableCachesResponse`	`DisableCaches(DisableCachesRequest req)` DisableCaches 用于禁用 CDN 上指定 URL 的访问，禁用完成后，全网访问会直接返回 403。（接口尚在内测中，暂未全量开放使用）
`EnableCachesResponse`	`EnableCaches(EnableCachesRequest req)` EnableCaches 用于解禁手工封禁的 URL，解禁成功后，全网生效时间约 5~10 分钟。（接口尚在内测中，暂未全量开放使用）
`GetDisableRecordsResponse`	`GetDisableRecords(GetDisableRecordsRequest req)` GetDisableRecords 用户查询资源禁用历史，及 URL 当前状态。（接口尚在内测中，暂未全量开放使用）
`ListTopDataResponse`	`ListTopData(ListTopDataRequest req)` ListTopData 通过入参 Metric 和 Filter 组合不同，可以查询以下排序数据： + 依据总流量、总请求数对访问 URL 排序，从大至小返回 TOP 1000 URL + 依据总流量、总请求数对客户端省份排序，从大至小返回省份列表 + 依据总流量、总请求数对客户端运营商排序，从大至小返回运营商列表 + 依据总流量、峰值带宽、总请求数、平均命中率、2XX/3XX/4XX/5XX 状态码对域名排序，从大至小返回域名列表 + 依据总回源流量、回源峰值带宽、总回源请求数、平均回源失败率、2XX/3XX/4XX/5XX 回源状态码对域名排序，从大至小返回域名列表
`PurgePathCacheResponse`	`PurgePathCache(PurgePathCacheRequest req)` PurgeUrlsCache 用于批量刷新目录缓存，一次提交将返回一个刷新任务id。
`PurgeUrlsCacheResponse`	`PurgeUrlsCache(PurgeUrlsCacheRequest req)` PurgeUrlsCache 用于批量刷新Url，一次提交将返回一个刷新任务id。
`PushUrlsCacheResponse`	`PushUrlsCache(PushUrlsCacheRequest req)` PushUrlsCache 用于将指定 URL 资源列表加载至 CDN 节点，默认情况下每次调用可提交 20 条 URL，每日一共可提交 1000 条。

Methods inherited from class com.tencentcloudapi.common.AbstractClient
call, getClientProfile, getCredential, getRegion, internalRequest, setClientProfile, setCredential, setRegion

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CdnClient
```
public CdnClient(Credential credential,
                 String region)
```
    构造client
    
    Parameters:
    
    credential - 认证信息实例
    
    region - 产品地域
  - CdnClient
```
public CdnClient(Credential credential,
                 String region,
                 ClientProfile profile)
```
    构造client
    
    Parameters:
    
    credential - 认证信息实例
    
    region - 产品地域
    
    profile - 配置实例
- Method Detail
  - DescribeCdnData
```
public DescribeCdnDataResponse DescribeCdnData(DescribeCdnDataRequest req)
                                        throws TencentCloudSDKException
```
    DescribeCdnData 用于查询 CDN 实时访问监控数据，支持以下指标查询： + 流量（单位为 byte） + 带宽（单位为 bps） + 请求数（单位为次） + 流量命中率（单位为 %，小数点后保留两位） + 状态码 2xx 汇总及各 2 开头状态码明细（单位为个） + 状态码 3xx 汇总及各 3 开头状态码明细（单位为个） + 状态码 4xx 汇总及各 4 开头状态码明细（单位为个） + 状态码 5xx 汇总及各 5 开头状态码明细（单位为个）
    
    Parameters:
    
    req - DescribeCdnDataRequest
    
    Returns:
    
    DescribeCdnDataResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeCdnIp
```
public DescribeCdnIpResponse DescribeCdnIp(DescribeCdnIpRequest req)
                                    throws TencentCloudSDKException
```
    DescribeCdnIp 用于查询 CDN IP 归属。
    
    Parameters:
    
    req - DescribeCdnIpRequest
    
    Returns:
    
    DescribeCdnIpResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeIpVisit
```
public DescribeIpVisitResponse DescribeIpVisit(DescribeIpVisitRequest req)
                                        throws TencentCloudSDKException
```
    DescribeIpVisit 用于查询 5 分钟活跃用户数，及日活跃用户数明细 + 5 分钟活跃用户数：根据日志中客户端 IP，5 分钟粒度去重统计 + 日活跃用户数：根据日志中客户端 IP，按天粒度去重统计
    
    Parameters:
    
    req - DescribeIpVisitRequest
    
    Returns:
    
    DescribeIpVisitResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeMapInfo
```
public DescribeMapInfoResponse DescribeMapInfo(DescribeMapInfoRequest req)
                                        throws TencentCloudSDKException
```
    DescribeMapInfo 用于查询省份对应的 ID，运营商对应的 ID 信息。
    
    Parameters:
    
    req - DescribeMapInfoRequest
    
    Returns:
    
    DescribeMapInfoResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeOriginData
```
public DescribeOriginDataResponse DescribeOriginData(DescribeOriginDataRequest req)
                                              throws TencentCloudSDKException
```
    DescribeOriginData 用于查询 CDN 实时回源监控数据，支持以下指标查询： + 回源流量（单位为 byte） + 回源带宽（单位为 bps） + 回源请求数（单位为次） + 回源失败请求数（单位为次） + 回源失败率（单位为 %，小数点后保留两位） + 回源状态码 2xx 汇总及各 2 开头回源状态码明细（单位为个） + 回源状态码 3xx 汇总及各 3 开头回源状态码明细（单位为个） + 回源状态码 4xx 汇总及各 4 开头回源状态码明细（单位为个） + 回源状态码 5xx 汇总及各 5 开头回源状态码明细（单位为个）
    
    Parameters:
    
    req - DescribeOriginDataRequest
    
    Returns:
    
    DescribeOriginDataResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribePayType
```
public DescribePayTypeResponse DescribePayType(DescribePayTypeRequest req)
                                        throws TencentCloudSDKException
```
    DescribePayType 用于查询用户的计费类型，计费周期等信息。
    
    Parameters:
    
    req - DescribePayTypeRequest
    
    Returns:
    
    DescribePayTypeResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribePurgeTasks
```
public DescribePurgeTasksResponse DescribePurgeTasks(DescribePurgeTasksRequest req)
                                              throws TencentCloudSDKException
```
    DescribePurgeTasks 用于查询刷新任务提交历史记录及执行进度。
    
    Parameters:
    
    req - DescribePurgeTasksRequest
    
    Returns:
    
    DescribePurgeTasksResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribePushTasks
```
public DescribePushTasksResponse DescribePushTasks(DescribePushTasksRequest req)
                                            throws TencentCloudSDKException
```
    DescribePushTasks 用于查询预热任务提交历史记录及执行进度。（接口尚在批量公测中，暂未全量开放使用）
    
    Parameters:
    
    req - DescribePushTasksRequest
    
    Returns:
    
    DescribePushTasksResponse
    
    Throws:
    
    TencentCloudSDKException
  - DisableCaches
```
public DisableCachesResponse DisableCaches(DisableCachesRequest req)
                                    throws TencentCloudSDKException
```
    DisableCaches 用于禁用 CDN 上指定 URL 的访问，禁用完成后，全网访问会直接返回 403。（接口尚在内测中，暂未全量开放使用）
    
    Parameters:
    
    req - DisableCachesRequest
    
    Returns:
    
    DisableCachesResponse
    
    Throws:
    
    TencentCloudSDKException
  - EnableCaches
```
public EnableCachesResponse EnableCaches(EnableCachesRequest req)
                                  throws TencentCloudSDKException
```
    EnableCaches 用于解禁手工封禁的 URL，解禁成功后，全网生效时间约 5~10 分钟。（接口尚在内测中，暂未全量开放使用）
    
    Parameters:
    
    req - EnableCachesRequest
    
    Returns:
    
    EnableCachesResponse
    
    Throws:
    
    TencentCloudSDKException
  - GetDisableRecords
```
public GetDisableRecordsResponse GetDisableRecords(GetDisableRecordsRequest req)
                                            throws TencentCloudSDKException
```
    GetDisableRecords 用户查询资源禁用历史，及 URL 当前状态。（接口尚在内测中，暂未全量开放使用）
    
    Parameters:
    
    req - GetDisableRecordsRequest
    
    Returns:
    
    GetDisableRecordsResponse
    
    Throws:
    
    TencentCloudSDKException
  - ListTopData
```
public ListTopDataResponse ListTopData(ListTopDataRequest req)
                                throws TencentCloudSDKException
```
    ListTopData 通过入参 Metric 和 Filter 组合不同，可以查询以下排序数据： + 依据总流量、总请求数对访问 URL 排序，从大至小返回 TOP 1000 URL + 依据总流量、总请求数对客户端省份排序，从大至小返回省份列表 + 依据总流量、总请求数对客户端运营商排序，从大至小返回运营商列表 + 依据总流量、峰值带宽、总请求数、平均命中率、2XX/3XX/4XX/5XX 状态码对域名排序，从大至小返回域名列表 + 依据总回源流量、回源峰值带宽、总回源请求数、平均回源失败率、2XX/3XX/4XX/5XX 回源状态码对域名排序，从大至小返回域名列表
    
    Parameters:
    
    req - ListTopDataRequest
    
    Returns:
    
    ListTopDataResponse
    
    Throws:
    
    TencentCloudSDKException
  - PurgePathCache
```
public PurgePathCacheResponse PurgePathCache(PurgePathCacheRequest req)
                                      throws TencentCloudSDKException
```
    PurgeUrlsCache 用于批量刷新目录缓存，一次提交将返回一个刷新任务id。
    
    Parameters:
    
    req - PurgePathCacheRequest
    
    Returns:
    
    PurgePathCacheResponse
    
    Throws:
    
    TencentCloudSDKException
  - PurgeUrlsCache
```
public PurgeUrlsCacheResponse PurgeUrlsCache(PurgeUrlsCacheRequest req)
                                      throws TencentCloudSDKException
```
    PurgeUrlsCache 用于批量刷新Url，一次提交将返回一个刷新任务id。
    
    Parameters:
    
    req - PurgeUrlsCacheRequest
    
    Returns:
    
    PurgeUrlsCacheResponse
    
    Throws:
    
    TencentCloudSDKException
  - PushUrlsCache
```
public PushUrlsCacheResponse PushUrlsCache(PushUrlsCacheRequest req)
                                    throws TencentCloudSDKException
```
    PushUrlsCache 用于将指定 URL 资源列表加载至 CDN 节点，默认情况下每次调用可提交 20 条 URL，每日一共可提交 1000 条。
    
    Parameters:
    
    req - PushUrlsCacheRequest
    
    Returns:
    
    PushUrlsCacheResponse
    
    Throws:
    
    TencentCloudSDKException

Class CdnClient

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractClient

Constructor Summary

Method Summary

Methods inherited from class com.tencentcloudapi.common.AbstractClient

Methods inherited from class java.lang.Object

Constructor Detail

CdnClient

CdnClient

Method Detail

DescribeCdnData

DescribeCdnIp

DescribeIpVisit

DescribeMapInfo

DescribeOriginData

DescribePayType

DescribePurgeTasks

DescribePushTasks

DisableCaches

EnableCaches

GetDisableRecords

ListTopData

PurgePathCache

PurgeUrlsCache

PushUrlsCache