Content Delivery Network API Documentation
Total Page:16
File Type:pdf, Size:1020Kb
Content Delivery Network Content Delivery Network API Documentation Product Documentation ©2013-2019 Tencent Cloud. All rights reserved. Page 1 of 376 Content Delivery Network Copyright Notice ©2013-2019 Tencent Cloud. All rights reserved. Copyright in this document is exclusively owned by Tencent Cloud. You must not reproduce, modify, copy or distribute in any way, in whole or in part, the contents of this document without Tencent Cloud's the prior written consent. Trademark Notice All trademarks associated with Tencent Cloud and its services are owned by Tencent Cloud Computing (Beijing) Company Limited and its affiliated companies. Trademarks of third parties referred to in this document are owned by their respective proprietors. Service Statement This document is intended to provide users with general information about Tencent Cloud's products and services only and does not form part of Tencent Cloud's terms and conditions. Tencent Cloud's products or services are subject to change. Specific products and services and the standards applicable to them are exclusively provided for in Tencent Cloud's applicable terms and conditions. ©2013-2019 Tencent Cloud. All rights reserved. Page 2 of 376 Content Delivery Network Contents API Documentation History Introduction API Category Making API Requests Request Structure Common Params Signature v3 Signature Responses Data Query APIs ListTopData DescribeOriginData DescribeIpVisit DescribeCdnData DescribeBillingData DescribeReportData Service Query APIs DescribePayType DescribeMapInfo DescribeCdnIp DescribeIpStatus DescribeCertDomains DescribeCdnOriginIp Content Management APIs GetDisableRecords EnableCaches DisableCaches PushUrlsCache PurgeUrlsCache PurgePathCache DescribePushTasks DescribePurgeTasks DescribeUrlViolations DescribePushQuota ©2013-2019 Tencent Cloud. All rights reserved. Page 3 of 376 Content Delivery Network DescribePurgeQuota Log Query APIs DescribeCdnDomainLogs Configuration Management APIs UpdateDomainConfig DescribeDomainsConfig DescribeDomains Domain Name Management APIs StopCdnDomain StartCdnDomain DeleteCdnDomain AddCdnDomain Real-Time Log APIs SearchClsLog ManageClsTopicDomains ListClsTopicDomains ListClsLogTopics EnableClsLogTopic DisableClsLogTopic DeleteClsLogTopic CreateClsLogTopic Secure Content Delivery Network APIs UpdateScdnDomain CreateScdnFailedLogTask Other APIs UpdatePayType Data Types Error Codes ©2013-2019 Tencent Cloud. All rights reserved. Page 4 of 376 Content Delivery Network API Documentation History Last updated:2021-08-17 15:03:10 Release 12 Release time: 2021-08-17 15:01:46 Release updates: Improvement to existing documentation. Modified APIs: AddCdnDomain New input parameters:AwsPrivateAccess, OssPrivateAccess DescribeBillingData New input parameters:Product DescribeCdnData New input parameters:Product DescribeCertDomains New input parameters:CertId, Product **Modified input parameters:**Cert DescribePayType New input parameters:Product DisableCaches New output parameters:TaskId GetDisableRecords New input parameters:TaskId **Modified input parameters:**StartTime, EndTime ListTopData New input parameters:Product UpdateDomainConfig New input parameters:OssPrivateAccess, WebSocket New data structures: OssPrivateAccess ©2013-2019 Tencent Cloud. All rights reserved. Page 5 of 376 Content Delivery Network WebSocket Modified data structures: BriefDomain New members:Product DetailDomain New members:OssPrivateAccess, WebSocket ScdnAclGroup New members:ErrorPage TopicInfo New members:Channel Release 11 Release time: 2021-06-29 17:12:16 Release updates: Improvement to existing documentation. Modified APIs: DescribeIpStatus New input parameters:Segment EnableCaches New input parameters:Date Release 10 Release time: 2021-03-19 16:44:03 Release updates: Improvement to existing documentation. New APIs: CreateScdnFailedLogTask Modified APIs: AddCdnDomain ©2013-2019 Tencent Cloud. All rights reserved. Page 6 of 376 Content Delivery Network New input parameters:Quic UpdateDomainConfig New input parameters:Quic New data structures: PostSize Quic WafSubRuleStatus Modified data structures: DetailDomain New members:PostMaxSize, Quic ScdnWafConfig New members:Level, SubRuleSwitch Release 9 Release time: 2021-01-07 19:48:40 Release updates: Improvement to existing documentation. Modified APIs: AddCdnDomain New input parameters:Ipv6Access, OfflineCache PushUrlsCache New input parameters:ParseM3U8 UpdateDomainConfig New input parameters:Ipv6Access, OfflineCache, OriginCombine New data structures: AdvanceConfig Ipv6Access OfflineCache OriginCombine PathBasedOriginRule ©2013-2019 Tencent Cloud. All rights reserved. Page 7 of 376 Content Delivery Network Modified data structures: DetailDomain New members:Ipv6Access, AdvanceSet, OfflineCache, OriginCombine ForceRedirect New members:CarryHeaders Origin New members:PathBasedOrigin Release 8 Release time: 2020-12-17 16:44:25 Release updates: Improvement to existing documentation. New APIs: UpdateScdnDomain New data structures: BotCookie BotJavaScript ScdnAclConfig ScdnAclGroup ScdnAclRule ScdnBotConfig ScdnCCRules ScdnConfig ScdnDdosConfig ScdnErrorPage ScdnWafConfig ScdnWafRule Modified data structures: Https New members:TlsVersion ©2013-2019 Tencent Cloud. All rights reserved. Page 8 of 376 Content Delivery Network Release 7 Release time: 2020-12-11 16:09:27 Release updates: Improvement to existing documentation. New APIs: DescribeCdnOriginIp Modified APIs: UpdateDomainConfig New input parameters:AdvancedAuthentication, OriginAuthentication New data structures: AdvancedAuthentication AdvancedAuthenticationTypeA AdvancedAuthenticationTypeB AdvancedAuthenticationTypeC AdvancedAuthenticationTypeD AdvancedAuthenticationTypeE AdvancedAuthenticationTypeF OriginAuthentication OriginAuthenticationTypeA OriginIp Modified data structures: DetailDomain New members:AdvancedAuthentication, OriginAuthentication MaxAgeRule New members:FollowOrigin PathRule **Modified members:**Origin, ServerName, OriginArea UrlRedirectRule New members:RedirectHost ©2013-2019 Tencent Cloud. All rights reserved. Page 9 of 376 Content Delivery Network Release 6 Release time: 2020-11-27 15:59:53 Release updates: Improvement to existing documentation. Modified APIs: PurgePathCache New input parameters:UrlEncode PurgeUrlsCache New input parameters:UrlEncode Release 5 Release time: 2020-10-30 14:52:43 Release updates: Improvement to existing documentation. New data structures: HttpHeaderRule IpFilterPathRule PathRule Modified data structures: CdnIp New members:City IpFilter New members:FilterRules Origin New members:BasePath, PathRules Release 4 Release time: 2020-10-16 18:37:02 ©2013-2019 Tencent Cloud. All rights reserved. Page 10 of 376 Content Delivery Network Release updates: Improvement to existing documentation. Modified APIs: DescribeIpStatus New input parameters:Area Modified data structures: AuthenticationTypeC New members:TimeFormat Release 3 Release time: 2020-09-25 11:41:23 Release updates: Improvement to existing documentation. Modified APIs: AddCdnDomain New input parameters:Tag New data structures: CacheConfigCache CacheConfigFollowOrigin CacheConfigNoCache KeyRule RuleCache RuleCacheConfig RuleQueryString Modified data structures: Cache New members:RuleCache CacheKey New members:KeyRules ©2013-2019 Tencent Cloud. All rights reserved. Page 11 of 376 Content Delivery Network Release 2 Release time: 2020-09-17 17:26:59 Release updates: Improvement to existing documentation. New data structures: Tag Modified data structures: DetailDomain New members:Tag Existing Release Release time: 2020-07-30 19:20:06 Existing APIs/data structures are as follows: Improvement to existing documentation. Existing APIs: AddCdnDomain CreateClsLogTopic DeleteCdnDomain DeleteClsLogTopic DescribeBillingData DescribeCdnData DescribeCdnDomainLogs DescribeCdnIp DescribeCertDomains DescribeDomains DescribeDomainsConfig DescribeIpStatus DescribeIpVisit DescribeMapInfo DescribeOriginData ©2013-2019 Tencent Cloud. All rights reserved. Page 12 of 376 Content Delivery Network DescribePayType DescribePurgeQuota DescribePurgeTasks DescribePushQuota DescribePushTasks DescribeReportData DescribeUrlViolations DisableCaches DisableClsLogTopic EnableCaches EnableClsLogTopic GetDisableRecords ListClsLogTopics ListClsTopicDomains ListTopData ManageClsTopicDomains PurgePathCache PurgeUrlsCache PushUrlsCache SearchClsLog StartCdnDomain StopCdnDomain UpdateDomainConfig UpdatePayType Existing data structures: AccessControl AccessControlRule AdvanceCacheRule AdvancedCache Authentication AuthenticationTypeA AuthenticationTypeB AuthenticationTypeC AuthenticationTypeD AwsPrivateAccess BandwidthAlert BriefDomain ©2013-2019 Tencent Cloud. All rights reserved. Page 13 of 376 Content Delivery Network Cache CacheKey CacheOptResult CacheTagKey CappingRule CdnData CdnIp CdnIpHistory ClientCert ClsLogObject ClsSearchLogs Compatibility Compression CompressionRule CookieKey DetailDomain DomainAreaConfig DomainFilter DomainLog DownstreamCapping ErrorPage ErrorPageRule FollowRedirect ForceRedirect GuetzliAdapter HeaderKey Hsts HttpHeaderPathRule Https ImageOptimization IpFilter IpFreqLimit IpStatus Ipv6 LogSetInfo MainlandConfig MapInfo MaxAge ©2013-2019 Tencent Cloud. All rights reserved. Page 14 of 376 Content Delivery Network MaxAgeRule Origin OriginPullOptimization OriginPullTimeout OverseaConfig PurgeTask PushTask QueryStringKey Quota RangeOriginPull Referer RefererRule RegionMapRelation ReportData RequestHeader ResourceBillingData ResourceData ResourceOriginData ResponseHeader ResponseHeaderCache Revalidate SchemeKey SecurityConfig Seo ServerCert