com.tencentcloudapi.cdn.v20180606

Class CdnClient

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)
CdnClient(Credential credential, String region, ClientProfile profile)

Method Summary

Modifier and Type	Method and Description
AddCdnDomainResponse	AddCdnDomain(AddCdnDomainRequest req) This API is used to add a CDN acceleration domain name.
DeleteCdnDomainResponse	DeleteCdnDomain(DeleteCdnDomainRequest req) This API is used to delete a specified acceleration domain name.
DescribeCdnDataResponse	DescribeCdnData(DescribeCdnDataRequest req) This API (DescribeCdnData) is used to query CDN real-time access monitoring data and supports the following metrics: + Traffic (in bytes) + Bandwidth (in bps) + Number of requests + Traffic hit rate (in % with two decimal digits) + Aggregate list of 2xx status codes and the details of status codes starting with 2 (in entries) + Aggregate list of 3xx status codes and the details of status codes starting with 3 (in entries) + Aggregate list of 4xx status codes and the details of status codes starting with 4 (in entries) + Aggregate list of 5xx status codes and the details of status codes starting with 5 (in entries)
DescribeCdnDomainLogsResponse	DescribeCdnDomainLogs(DescribeCdnDomainLogsRequest req) This API is used to query the download link of an access log.
DescribeCdnIpResponse	DescribeCdnIp(DescribeCdnIpRequest req) This API is used to query CDN IP ownership.
DescribeDomainsResponse	DescribeDomains(DescribeDomainsRequest req) This API is used to query the basic configuration information of CDN acceleration domain names (inside and outside mainland China), including the project ID, service status, service type, creation time, and update time, etc.
DescribeDomainsConfigResponse	DescribeDomainsConfig(DescribeDomainsConfigRequest req) This API is used to query the complete configuration information of CDN acceleration domain names (inside and outside mainland China).
DescribeIpVisitResponse	DescribeIpVisit(DescribeIpVisitRequest req) This API (DescribeIpVisit) is used to query the number of users who remain active for 5 minutes and the detailed number of daily active users.
DescribeMapInfoResponse	DescribeMapInfo(DescribeMapInfoRequest req) This API (DescribeMapInfo) is used to query the IDs of districts or ISPs.
DescribeOriginDataResponse	DescribeOriginData(DescribeOriginDataRequest req) This API (DescribeOriginData) is used to query CDN real-time origin-pull monitoring data and supports the following metrics: + Origin-pull traffic (in bytes) + Origin-pull bandwidth (in bps) + Number of origin-pull requests + Number of failed origin-pull requests + Origin-pull failure rate (in % with two decimal digits) + Aggregate list of 2xx origin-pull status codes and the details of origin-pull status codes starting with 2 (in entries) + Aggregate list of 3xx origin-pull status codes and the details of origin-pull status codes starting with 3 (in entries) + Aggregate list of 4xx origin-pull status codes and the details of origin-pull status codes starting with 4 (in entries) + Aggregate list of 5xx origin-pull status codes and the details of origin-pull status codes starting with 5 (in entries)
DescribePayTypeResponse	DescribePayType(DescribePayTypeRequest req) This API (DescribePayType) is used to query billing information of the current account, such as billing mode and billing cycle.
DescribePurgeTasksResponse	DescribePurgeTasks(DescribePurgeTasksRequest req) This API is used to query the record and progress of URL or directory purge tasks submitted via the `PurgePathCache` or `PurgeUrlsCache` APIs.
DescribePushTasksResponse	DescribePushTasks(DescribePushTasksRequest req) This API is used to query the submission record and progress of prefetch tasks.
DescribeUrlViolationsResponse	DescribeUrlViolations(DescribeUrlViolationsRequest req) This API is used to query the list of domain name URLs containing regulation-violating content scanned and detected by the CDN system, and the current status of the URLs.
DisableCachesResponse	DisableCaches(DisableCachesRequest req) This API (DisableCaches) is used to block access to a specific URL on CDN.
EnableCachesResponse	EnableCaches(EnableCachesRequest req) This API (EnableCaches) is used to unblock manually blocked URLs.
GetDisableRecordsResponse	GetDisableRecords(GetDisableRecordsRequest req) This API is used to query the resource blocking history and the current URL status.
ListTopDataResponse	ListTopData(ListTopDataRequest req) This API is used to list data sorted the following ways by using different combinations of the Metric and Filter input parameters: + It sorts access URLs by total traffic and total requests, and returns the top 1,000 URLs in descending order.
PurgePathCacheResponse	PurgePathCache(PurgePathCacheRequest req) This API is used to submit multiple directory purge tasks, which are carried out according to the acceleration region of the domain names.
PurgeUrlsCacheResponse	PurgeUrlsCache(PurgeUrlsCacheRequest req) This API is used to submit multiple URL purge tasks, which are carried out according to the current acceleration region of the domain names in the URLs.
PushUrlsCacheResponse	PushUrlsCache(PushUrlsCacheRequest req) This API is used to cache specified URL resources to CDN nodes.
StartCdnDomainResponse	StartCdnDomain(StartCdnDomainRequest req) This API is used to enable the acceleration service for a disabled domain name.
StopCdnDomainResponse	StopCdnDomain(StopCdnDomainRequest req) This API is used to suspend the acceleration service for a domain name.
UpdateDomainConfigResponse	UpdateDomainConfig(UpdateDomainConfigRequest req) This API is used to modify the configuration of CDN acceleration domain names.
UpdatePayTypeResponse	UpdatePayType(UpdatePayTypeRequest req) This API is used to modify the billing mode of an account.

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)

CdnClient

public CdnClient(Credential credential,
                 String region,
                 ClientProfile profile)

Method Detail

AddCdnDomain

public AddCdnDomainResponse AddCdnDomain(AddCdnDomainRequest req)
                                  throws TencentCloudSDKException

This API is used to add a CDN acceleration domain name.

Parameters:

req - AddCdnDomainRequest

Returns:

AddCdnDomainResponse

Throws:

TencentCloudSDKException

DeleteCdnDomain

public DeleteCdnDomainResponse DeleteCdnDomain(DeleteCdnDomainRequest req)
                                        throws TencentCloudSDKException

This API is used to delete a specified acceleration domain name.

Parameters:

req - DeleteCdnDomainRequest

Returns:

DeleteCdnDomainResponse

Throws:

TencentCloudSDKException

DescribeCdnData

public DescribeCdnDataResponse DescribeCdnData(DescribeCdnDataRequest req)
                                        throws TencentCloudSDKException

This API (DescribeCdnData) is used to query CDN real-time access monitoring data and supports the following metrics: + Traffic (in bytes) + Bandwidth (in bps) + Number of requests + Traffic hit rate (in % with two decimal digits) + Aggregate list of 2xx status codes and the details of status codes starting with 2 (in entries) + Aggregate list of 3xx status codes and the details of status codes starting with 3 (in entries) + Aggregate list of 4xx status codes and the details of status codes starting with 4 (in entries) + Aggregate list of 5xx status codes and the details of status codes starting with 5 (in entries)

Parameters:

req - DescribeCdnDataRequest

Returns:

DescribeCdnDataResponse

Throws:

TencentCloudSDKException

DescribeCdnDomainLogs

public DescribeCdnDomainLogsResponse DescribeCdnDomainLogs(DescribeCdnDomainLogsRequest req)
                                                    throws TencentCloudSDKException

This API is used to query the download link of an access log. You can use this API for access logs in the last 30 days either within or outside Mainland China.

Parameters:

req - DescribeCdnDomainLogsRequest

Returns:

DescribeCdnDomainLogsResponse

Throws:

TencentCloudSDKException

DescribeCdnIp

public DescribeCdnIpResponse DescribeCdnIp(DescribeCdnIpRequest req)
                                    throws TencentCloudSDKException

This API is used to query CDN IP ownership.

Parameters:

req - DescribeCdnIpRequest

Returns:

DescribeCdnIpResponse

Throws:

TencentCloudSDKException

DescribeDomains

public DescribeDomainsResponse DescribeDomains(DescribeDomainsRequest req)
                                        throws TencentCloudSDKException

This API is used to query the basic configuration information of CDN acceleration domain names (inside and outside mainland China), including the project ID, service status, service type, creation time, and update time, etc.

Parameters:

req - DescribeDomainsRequest

Returns:

DescribeDomainsResponse

Throws:

TencentCloudSDKException

DescribeDomainsConfig

public DescribeDomainsConfigResponse DescribeDomainsConfig(DescribeDomainsConfigRequest req)
                                                    throws TencentCloudSDKException

This API is used to query the complete configuration information of CDN acceleration domain names (inside and outside mainland China).

Parameters:

req - DescribeDomainsConfigRequest

Returns:

DescribeDomainsConfigResponse

Throws:

TencentCloudSDKException

DescribeIpVisit

public DescribeIpVisitResponse DescribeIpVisit(DescribeIpVisitRequest req)
                                        throws TencentCloudSDKException

This API (DescribeIpVisit) is used to query the number of users who remain active for 5 minutes and the detailed number of daily active users. + Number of users who remain active for 5 minutes: Collects deduplicated statistics based on client IP addresses in the log with the 5-minute granularity. + Number of daily active users: Collects deduplicated statistics based on client IP addresses in the log with the 1-day granularity.

Parameters:

req - DescribeIpVisitRequest

Returns:

DescribeIpVisitResponse

Throws:

TencentCloudSDKException

DescribeMapInfo

public DescribeMapInfoResponse DescribeMapInfo(DescribeMapInfoRequest req)
                                        throws TencentCloudSDKException

This API (DescribeMapInfo) is used to query the IDs of districts or ISPs.

Parameters:

req - DescribeMapInfoRequest

Returns:

DescribeMapInfoResponse

Throws:

TencentCloudSDKException

DescribeOriginData

public DescribeOriginDataResponse DescribeOriginData(DescribeOriginDataRequest req)
                                              throws TencentCloudSDKException

This API (DescribeOriginData) is used to query CDN real-time origin-pull monitoring data and supports the following metrics: + Origin-pull traffic (in bytes) + Origin-pull bandwidth (in bps) + Number of origin-pull requests + Number of failed origin-pull requests + Origin-pull failure rate (in % with two decimal digits) + Aggregate list of 2xx origin-pull status codes and the details of origin-pull status codes starting with 2 (in entries) + Aggregate list of 3xx origin-pull status codes and the details of origin-pull status codes starting with 3 (in entries) + Aggregate list of 4xx origin-pull status codes and the details of origin-pull status codes starting with 4 (in entries) + Aggregate list of 5xx origin-pull status codes and the details of origin-pull status codes starting with 5 (in entries)

Parameters:

req - DescribeOriginDataRequest

Returns:

DescribeOriginDataResponse

Throws:

TencentCloudSDKException

DescribePayType

public DescribePayTypeResponse DescribePayType(DescribePayTypeRequest req)
                                        throws TencentCloudSDKException

This API (DescribePayType) is used to query billing information of the current account, such as billing mode and billing cycle.

Parameters:

req - DescribePayTypeRequest

Returns:

DescribePayTypeResponse

Throws:

TencentCloudSDKException

DescribePurgeTasks

public DescribePurgeTasksResponse DescribePurgeTasks(DescribePurgeTasksRequest req)
                                              throws TencentCloudSDKException

This API is used to query the record and progress of URL or directory purge tasks submitted via the `PurgePathCache` or `PurgeUrlsCache` APIs.

Parameters:

req - DescribePurgeTasksRequest

Returns:

DescribePurgeTasksResponse

Throws:

TencentCloudSDKException

DescribePushTasks

public DescribePushTasksResponse DescribePushTasks(DescribePushTasksRequest req)
                                            throws TencentCloudSDKException

This API is used to query the submission record and progress of prefetch tasks. This API is in beta test and not fully available yet. Please stay tuned.

Parameters:

req - DescribePushTasksRequest

Returns:

DescribePushTasksResponse

Throws:

TencentCloudSDKException

DescribeUrlViolations

public DescribeUrlViolationsResponse DescribeUrlViolations(DescribeUrlViolationsRequest req)
                                                    throws TencentCloudSDKException

This API is used to query the list of domain name URLs containing regulation-violating content scanned and detected by the CDN system, and the current status of the URLs. It corresponds to the **Pornography Detection** page on the CDN Console.

Parameters:

req - DescribeUrlViolationsRequest

Returns:

DescribeUrlViolationsResponse

Throws:

TencentCloudSDKException

DisableCaches

public DisableCachesResponse DisableCaches(DisableCachesRequest req)
                                    throws TencentCloudSDKException

This API (DisableCaches) is used to block access to a specific URL on CDN. After a URL is blocked, error 403 will be returned for all access requests to it. (This API is during beta test and not fully available now.)

Parameters:

req - DisableCachesRequest

Returns:

DisableCachesResponse

Throws:

TencentCloudSDKException

EnableCaches

public EnableCachesResponse EnableCaches(EnableCachesRequest req)
                                  throws TencentCloudSDKException

This API (EnableCaches) is used to unblock manually blocked URLs. After a URL is successfully unblocked, it takes about 5 to 10 minutes to take effect across the entire network. (This API is during beta test and not fully available now.)

Parameters:

req - EnableCachesRequest

Returns:

EnableCachesResponse

Throws:

TencentCloudSDKException

GetDisableRecords

public GetDisableRecordsResponse GetDisableRecords(GetDisableRecordsRequest req)
                                            throws TencentCloudSDKException

This API is used to query the resource blocking history and the current URL status. (This API is in beta test and not generally available yet.)

Parameters:

req - GetDisableRecordsRequest

Returns:

GetDisableRecordsResponse

Throws:

TencentCloudSDKException

ListTopData

public ListTopDataResponse ListTopData(ListTopDataRequest req)
                                throws TencentCloudSDKException

This API is used to list data sorted the following ways by using different combinations of the Metric and Filter input parameters: + It sorts access URLs by total traffic and total requests, and returns the top 1,000 URLs in descending order. + It sorts client districts by total traffic and total requests, and returns the list of districts in descending order. + It sorts client ISPs by total traffic and total requests, and returns the list of ISPs in descending order. + It sorts domain names by total traffic, peak bandwidth, total requests, average hit rate, and 2XX/3XX/4XX/5XX status codes, and returns the list of domain names in descending order. + It sorts domain names by total origin-pull traffic, peak origin-pull bandwidth, total origin-pull requests, average origin-pull failure rate, and 2XX/3XX/4XX/5XX origin-pull status codes, and returns the list of domain names in descending order. Note: only data from the last 90 days will be queried.

Parameters:

req - ListTopDataRequest

Returns:

ListTopDataResponse

Throws:

TencentCloudSDKException

PurgePathCache

public PurgePathCacheResponse PurgePathCache(PurgePathCacheRequest req)
                                      throws TencentCloudSDKException

This API is used to submit multiple directory purge tasks, which are carried out according to the acceleration region of the domain names. By default, a maximum of 100 directories can be purged per day for acceleration regions either within or outside Mainland China, and up to 20 tasks can be submitted at a time.

Parameters:

req - PurgePathCacheRequest

Returns:

PurgePathCacheResponse

Throws:

TencentCloudSDKException

PurgeUrlsCache

public PurgeUrlsCacheResponse PurgeUrlsCache(PurgeUrlsCacheRequest req)
                                      throws TencentCloudSDKException

This API is used to submit multiple URL purge tasks, which are carried out according to the current acceleration region of the domain names in the URLs. By default, a maximum of 10,000 URLs can be purged per day for acceleration regions either within or outside Mainland China, and up to 1,000 tasks can be submitted at a time.

Parameters:

req - PurgeUrlsCacheRequest

Returns:

PurgeUrlsCacheResponse

Throws:

TencentCloudSDKException

PushUrlsCache

public PushUrlsCacheResponse PushUrlsCache(PushUrlsCacheRequest req)
                                    throws TencentCloudSDKException

This API is used to cache specified URL resources to CDN nodes. You can specify acceleration regions for the prefetch. By default, a maximum of 1,000 URLs can be prefetched per day either within or outside Mainland China, and up to 20 tasks can be submitted at a time. This API is in beta test and not fully available yet. Please stay tuned.

Parameters:

req - PushUrlsCacheRequest

Returns:

PushUrlsCacheResponse

Throws:

TencentCloudSDKException

StartCdnDomain

public StartCdnDomainResponse StartCdnDomain(StartCdnDomainRequest req)
                                      throws TencentCloudSDKException

This API is used to enable the acceleration service for a disabled domain name.

Parameters:

req - StartCdnDomainRequest

Returns:

StartCdnDomainResponse

Throws:

TencentCloudSDKException

StopCdnDomain

public StopCdnDomainResponse StopCdnDomain(StopCdnDomainRequest req)
                                    throws TencentCloudSDKException

This API is used to suspend the acceleration service for a domain name. Note: after the acceleration service has been suspended, requests to the cache node will return a 404 error. In order to avoid impact to your business, please move the domain name to another service before suspending the acceleration service.

Parameters:

req - StopCdnDomainRequest

Returns:

StopCdnDomainResponse

Throws:

TencentCloudSDKException

UpdateDomainConfig

public UpdateDomainConfigResponse UpdateDomainConfig(UpdateDomainConfigRequest req)
                                              throws TencentCloudSDKException

This API is used to modify the configuration of CDN acceleration domain names. Note: if you need to update complex configuration items, you must pass all the attributes of the entire object. The default value will be used for attributes that are not passed. We recommend calling the querying API to obtain the configuration attributes first. You can then modify and pass the attributes to the API. The certificate and key fields do not need to be passed for HTTPS configuration.

Parameters:

req - UpdateDomainConfigRequest

Returns:

UpdateDomainConfigResponse

Throws:

TencentCloudSDKException

UpdatePayType

public UpdatePayTypeResponse UpdatePayType(UpdatePayTypeRequest req)
                                    throws TencentCloudSDKException

This API is used to modify the billing mode of an account. At present, the billing mode of accounts on a monthly billing cycle and sub-accounts cannot be modified.

Parameters:

req - UpdatePayTypeRequest

Returns:

UpdatePayTypeResponse

Throws:

TencentCloudSDKException