API
  • History
  • Introduction
  • API Category
  • Making API Requests
    • Request Structure
    • Common Params
    • Signature v3
    • Signature
    • Responses
  • Site APIs
    • CreateZone
    • DescribeIdentifications
    • ModifyZone
    • DeleteZone
    • ModifyZoneStatus
    • CheckCnameStatus
    • IdentifyZone
    • DescribeZones
    • ExportZoneConfig
    • ImportZoneConfig
    • DescribeZoneConfigImportResult
  • Acceleration Domain Management APIs
    • CreateAccelerationDomain
    • DescribeAccelerationDomains
    • ModifyAccelerationDomain
    • ModifyAccelerationDomainStatuses
    • DeleteAccelerationDomains
    • CreateSharedCNAME
    • DescribeSharedCNAME
    • ModifySharedCNAME
    • BindSharedCNAME
    • DeleteSharedCNAME
  • Site Acceleration Configuration APIs
    • CreateL7AccRules
    • DescribeL7AccRules
    • ModifyL7AccRule
    • DeleteL7AccRules
    • DescribeL7AccSetting
    • ModifyL7AccSetting
    • ModifyL7AccRulePriority
  • Edge Function APIs
    • CreateFunction
    • DescribeFunctions
    • ModifyFunction
    • DeleteFunction
    • CreateFunctionRule
    • DescribeFunctionRules
    • ModifyFunctionRule
    • ModifyFunctionRulePriority
    • DeleteFunctionRules
    • DescribeFunctionRuntimeEnvironment
    • HandleFunctionRuntimeEnvironment
    • ModifyFunctionComponentBindings
    • DescribeFunctionComponentBindings
  • Alias Domain APIs
    • CreateAliasDomain
    • DescribeAliasDomains
    • ModifyAliasDomain
    • ModifyAliasDomainStatus
    • DeleteAliasDomain
  • Security Configuration APIs
    • CreateSecurityIPGroup
    • DescribeSecurityIPGroup
    • ModifySecurityIPGroup
    • DeleteSecurityIPGroup
    • DescribeSecurityTemplateBindings
    • BindSecurityTemplateToEntity
    • DescribeSecurityPolicy
    • ModifySecurityPolicy
    • DescribeSecurityIPGroupInfo
    • DescribeSecurityIPGroupContent
    • CreateSecurityJSInjectionRule
    • DescribeSecurityJSInjectionRule
    • ModifySecurityJSInjectionRule
    • DeleteSecurityJSInjectionRule
    • CreateSecurityClientAttester
    • DescribeSecurityClientAttester
    • ModifySecurityClientAttester
    • DeleteSecurityClientAttester
    • CreateWebSecurityTemplate
    • DeleteWebSecurityTemplate
    • DescribeWebSecurityTemplates
    • ModifyWebSecurityTemplate
    • DescribeDDoSProtection
    • DescribeWebSecurityTemplate
    • ModifyDDoSProtection
  • Layer 4 Application Proxy APIs
    • CreateL4Proxy
    • ModifyL4Proxy
    • ModifyL4ProxyStatus
    • DescribeL4Proxy
    • DeleteL4Proxy
    • CreateL4ProxyRules
    • ModifyL4ProxyRules
    • ModifyL4ProxyRulesStatus
    • DescribeL4ProxyRules
    • DeleteL4ProxyRules
  • Content Management APIs
    • CreatePurgeTask
    • DescribePurgeTasks
    • CreatePrefetchTask
    • DescribePrefetchTasks
    • DescribeContentQuota
    • DescribePrefetchOriginLimit
    • ModifyPrefetchOriginLimit
  • Data Analysis APIs
    • DescribeDDoSAttackData
    • DescribeDDoSAttackEvent
    • DescribeDDoSAttackTopData
    • DescribeOverviewL7Data
    • DescribeTimingL7OriginPullData
    • DescribeTimingL4Data
    • DescribeTimingL7AnalysisData
    • DescribeTopL7AnalysisData
    • DescribeTimingL7CacheData
    • DescribeTopL7CacheData
  • Log Service APIs
    • DownloadL7Logs
    • DownloadL4Logs
    • CreateCLSIndex
    • CreateRealtimeLogDeliveryTask
    • ModifyRealtimeLogDeliveryTask
    • DeleteRealtimeLogDeliveryTask
    • DescribeRealtimeLogDeliveryTasks
  • Billing APIs
    • CreatePlan
    • DescribePlans
    • UpgradePlan
    • RenewPlan
    • ModifyPlan
    • IncreasePlanQuota
    • DestroyPlan
    • CreatePlanForZone
    • BindZoneToPlan
    • DescribeBillingData
    • DescribeAvailablePlans
  • Certificate APIs
    • DescribeDefaultCertificates
    • ModifyHostsCertificate
    • ApplyFreeCertificate
    • CheckFreeCertificateVerification
  • Origin Protection APIs
    • EnableOriginACL
    • ModifyOriginACL
    • DescribeOriginACL
    • ConfirmOriginACLUpdate
    • DisableOriginACL
  • Load Balancing APIs
    • CreateOriginGroup
    • ModifyOriginGroup
    • DeleteOriginGroup
    • DescribeOriginGroup
    • CreateLoadBalancer
    • ModifyLoadBalancer
    • DeleteLoadBalancer
    • DescribeLoadBalancerList
    • DescribeOriginGroupHealthStatus
  • Diagnostic Tool APIs
    • DescribeIPRegion
  • Custom Response Page APIs
    • CreateCustomizeErrorPage
    • DescribeCustomErrorPages
    • ModifyCustomErrorPage
    • DeleteCustomErrorPage
  • Version Management APIs
    • CreateConfigGroupVersion
    • DeployConfigGroupVersion
    • DescribeConfigGroupVersionDetail
    • DescribeConfigGroupVersions
    • DescribeDeployHistory
    • DescribeEnvironments
    • ModifyZoneWorkMode
  • API Security APIs
    • CreateSecurityAPIResource
    • DescribeSecurityAPIResource
    • ModifySecurityAPIResource
    • DeleteSecurityAPIResource
    • CreateSecurityAPIService
    • DescribeSecurityAPIService
    • ModifySecurityAPIService
    • DeleteSecurityAPIService
  • DNS Record APIs
    • CreateDnsRecord
    • DescribeDnsRecords
    • ModifyDnsRecords
    • ModifyDnsRecordsStatus
    • DeleteDnsRecords
  • Content Identifier APIs
    • CreateContentIdentifier
    • DescribeContentIdentifiers
    • ModifyContentIdentifier
    • DeleteContentIdentifier
  • Legacy APIs
    • DescribeOriginProtection
    • CreateRule
    • DescribeRules
    • ModifyRule
    • DeleteRules
    • DescribeZoneSetting
    • ModifyZoneSetting
    • DescribeHostsSetting
    • DescribeRulesSetting
    • CreateApplicationProxy
    • DescribeApplicationProxies
    • ModifyApplicationProxy
    • ModifyApplicationProxyStatus
    • DeleteApplicationProxy
    • CreateApplicationProxyRule
    • ModifyApplicationProxyRule
    • ModifyApplicationProxyRuleStatus
    • DeleteApplicationProxyRule
  • Ownership APIs
    • VerifyOwnership
  • Image and Video Processing APIs
    • CreateJustInTimeTranscodeTemplate
    • DescribeJustInTimeTranscodeTemplates
    • DeleteJustInTimeTranscodeTemplates
  • Multi-Channel Security Gateway APIs
    • ConfirmMultiPathGatewayOriginACL
    • DescribeMultiPathGatewayOriginACL
    • CreateMultiPathGateway
    • DescribeMultiPathGateways
    • DescribeMultiPathGateway
    • ModifyMultiPathGateway
    • ModifyMultiPathGatewayStatus
    • DeleteMultiPathGateway
    • DescribeMultiPathGatewayRegions
    • CreateMultiPathGatewaySecretKey
    • DescribeMultiPathGatewaySecretKey
    • ModifyMultiPathGatewaySecretKey
    • RefreshMultiPathGatewaySecretKey
    • CreateMultiPathGatewayLine
    • DescribeMultiPathGatewayLine
    • ModifyMultiPathGatewayLine
    • DeleteMultiPathGatewayLine
  • KV Storage APIs
    • ModifyEdgeKVNamespace
    • EdgeKVPut
    • EdgeKVList
    • EdgeKVGet
    • EdgeKVDelete
    • DescribeEdgeKVNamespaces
    • DeleteEdgeKVNamespace
    • CreateEdgeKVNamespace
  • Data Types
  • Error Codes

Request Structure

1. Service Address

The API supports access from either a nearby region (at teo.intl.tencentcloudapi.com) or a specified region (at teo.ap-guangzhou.tencentcloudapi.com for Guangzhou, for example).

We recommend using the domain name to access the nearest server. When you call an API, the request is automatically resolved to a server in the region nearest to the location where the API is initiated. For example, when you initiate an API request in Guangzhou, this domain name is automatically resolved to a Guangzhou server, the result is the same as that of specifying the region in the domain like "teo.ap-guangzhou.tencentcloudapi.com".

Note: For latency-sensitive businesses, we recommend that you specify the region in the domain name.

Tencent Cloud currently supports the following regions:

Hosted regionDomain name
Local access region (recommended, only for non-financial availability zones)teo.intl.tencentcloudapi.com
South China (Guangzhou)teo.ap-guangzhou.tencentcloudapi.com
East China (Shanghai)teo.ap-shanghai.tencentcloudapi.com
East China (Nanjing)teo.ap-nanjing.tencentcloudapi.com
North China (Beijing)teo.ap-beijing.tencentcloudapi.com
Southwest China (Chengdu)teo.ap-chengdu.tencentcloudapi.com
Southwest China (Chongqing)teo.ap-chongqing.tencentcloudapi.com
Hong Kong, Macao, Taiwan (Hong Kong, China)teo.ap-hongkong.tencentcloudapi.com
Southeast Asia (Singapore)teo.ap-singapore.tencentcloudapi.com
Southeast Asia (Jakarta)teo.ap-jakarta.tencentcloudapi.com
Southeast Asia (Bangkok)teo.ap-bangkok.tencentcloudapi.com
Northeast Asia (Seoul)teo.ap-seoul.tencentcloudapi.com
Northeast Asia (Tokyo)teo.ap-tokyo.tencentcloudapi.com
U.S. East Coast (Virginia)teo.na-ashburn.tencentcloudapi.com
U.S. West Coast (Silicon Valley)teo.na-siliconvalley.tencentcloudapi.com
South America (São Paulo)teo.sa-saopaulo.tencentcloudapi.com
Europe (Frankfurt)teo.eu-frankfurt.tencentcloudapi.com

2. Communications Protocol

All the Tencent Cloud APIs communicate via HTTPS, providing highly secure communication tunnels.

3. Request Methods

Supported HTTP request methods:

  • POST (recommended)
  • GET

The Content-Type types supported by POST requests:

  • application/json (recommended). The TC3-HMAC-SHA256 signature algorithm must be used.
  • application/x-www-form-urlencoded. The HmacSHA1 or HmacSHA256 signature algorithm must be used.
  • multipart/form-data (only supported by certain APIs). You must use TC3-HMAC-SHA256 to calculate the signature.

The size of a GET request packet is up to 32 KB. The size of a POST request is up to 1 MB when the HmacSHA1 or HmacSHA256 signature algorithm is used, and up to 10 MB when TC3-HMAC-SHA256 is used.

4. Character Encoding

Only UTF-8 encoding is used.