Custom HTTPS configuration for origin-pull
Used by actions: AddEcdnDomain, DescribeDomains, DescribeDomainsConfig, UpdateDomainConfig.
Name | Type | Required | Description |
---|---|---|---|
CustomTlsStatus | String | No | Custom TLS data switch Note: This field may return null , indicating that no valid values can be obtained. |
TlsVersion | Array of String | No | TLS version settings. Valid values: TLSv1 , TLSV1.1 , TLSV1.2 , and TLSv1.3 . Only consecutive versions can be enabled at the same time.Note: This field may return null , indicating that no valid values can be obtained. |
Cipher | String | No | Custom encryption suite Note: This field may return null , indicating that no valid values can be obtained. |
VerifyOriginType | String | No | Origin-pull verification statusoff : Disables origin-pull verificationoneWay : Only verify the origintwoWay : Enables two-way origin-pull verificationNote: This field may return null , indicating that no valid values can be obtained. |
CertInfo | ServerCert | No | Configuration information of the origin-pull certificate Note: This field may return null , indicating that no valid values can be obtained. |
OriginCertInfo | ClientCert | No | Configuration information of the origin server certificate Note: This field may return null , indicating that no valid values can be obtained. |
Simple edition of cache configuration, which does not support setting a caching rule for scenarios where the max-age
is not returned from the origin server.
Used by actions: AddEcdnDomain, DescribeDomainsConfig, UpdateDomainConfig.
Name | Type | Required | Description |
---|---|---|---|
CacheRules | Array of CacheRule | Yes | Caching configuration rule array. |
FollowOrigin | String | No | Whether to follow the Cache-Control: max-age configuration on the origin server (this feature is only available to users on the allowlist).on: enable off: disable If it is enabled, resources that do not match CacheRules will be cached on node according to the max-age value returned by the origin server, while resources that match CacheRules will be cached on node according to the cache expiration time set in CacheRules .Note: this field may return null, indicating that no valid values can be obtained. |
Caching configuration.
Used by actions: AddEcdnDomain, DescribeDomainsConfig, UpdateDomainConfig.
Name | Type | Required | Description |
---|---|---|---|
FullUrlCache | String | No | Whether to enable full path cache. Valid values: on, off. |
Caching configuration rule.
Used by actions: AddEcdnDomain, DescribeDomainsConfig, UpdateDomainConfig.
Name | Type | Required | Description |
---|---|---|---|
CacheType | String | Yes | Cache type. Valid values: all (all files), file (extension type), directory (directory), path (full path), index (homepage). |
CacheContents | Array of String | Yes | Cached content list. |
CacheTime | Integer | Yes | Cache time in seconds. |
HTTPS client certificate configuration.
Used by actions: AddEcdnDomain, DescribeDomains, DescribeDomainsConfig, UpdateDomainConfig.
Name | Type | Required | Description |
---|---|---|---|
Certificate | String | Yes | Client certificate in PEM format. Note: this field may return null, indicating that no valid values can be obtained. |
CertName | String | No | Client certificate name. Note: this field may return null, indicating that no valid values can be obtained. |
ExpireTime | Timestamp | No | Certificate expiration time. Note: this field may return null, indicating that no valid values can be obtained. |
DeployTime | Timestamp | No | Certificate issuance time. Note: this field may return null, indicating that no valid values can be obtained. |
Data structure of sorted data
Used by actions: DescribeEcdnDomainStatistics.
Name | Type | Description |
---|---|---|
Name | String | Data type name |
Value | Float | Data value |
Basic information of a CDN domain name.
Used by actions: DescribeDomains.
Name | Type | Description |
---|---|---|
ResourceId | String | Domain name ID. |
AppId | Integer | Tencent Cloud account ID. |
Domain | String | CDN acceleration domain name. |
Cname | String | Domain name CNAME. |
Status | String | Domain name status. Valid values: pending (reviewing), rejected (rejected), processing (deploying after approval), online (enabled), offline (disabled), deleted (deleted). |
ProjectId | Integer | Project ID. |
CreateTime | Timestamp | Domain name creation time. |
UpdateTime | Timestamp | Domain name update time. |
Origin | Origin | Origin server configuration details. |
Disable | String | Domain name blockage status. Valid values: normal (normal), overdue (service is suspended due to arrears), quota (trial traffic package is used up), malicious (malicious user), ddos (DDoS attack), idle (no traffic), unlicensed (no ICP filing), capping (bandwidth cap reached), readonly (read-only) |
Area | String | Acceleration region. Valid values: mainland, oversea, global. |
Readonly | String | Domain name lock status. normal: not locked; global: globally locked |
Tag | Array of Tag | Domain name tag Note: This field may return null , indicating that no valid value can be found. |
Data structure of sorted data
Used by actions: DescribeEcdnDomainStatistics.
Name | Type | Description |
---|---|---|
Resource | String | Domain name |
DetailData | Array of DetailData | Result details. |
Detailed configuration information of ECDN domain name.
Used by actions: DescribeDomainsConfig.
Name | Type | Description |
---|---|---|
ResourceId | String | Domain name ID. |
AppId | Integer | Tencent Cloud account ID. |
Domain | String | Acceleration domain name. |
Cname | String | Domain name CNAME. Note: this field may return null, indicating that no valid values can be obtained. |
Status | String | Domain name status. Valid values: pending (reviewing), rejected (rejected), processing (deploying after approval), online (enabled), offline (disabled), deleted (deleted). |
ProjectId | Integer | Project ID. |
CreateTime | Timestamp | Domain name creation time. |
UpdateTime | Timestamp | Domain name update time. |
Origin | Origin | Origin server configuration. |
IpFilter | IpFilter | IP blocklist/allowlist configuration. Note: this field may return null, indicating that no valid values can be obtained. |
IpFreqLimit | IpFreqLimit | IP access limit configuration. Note: this field may return null, indicating that no valid values can be obtained. |
ResponseHeader | ResponseHeader | Origin server response header configuration. Note: this field may return null, indicating that no valid values can be obtained. |
CacheKey | CacheKey | Node caching configuration. Note: this field may return null, indicating that no valid values can be obtained. |
Cache | Cache | Caching rule configuration. Note: this field may return null, indicating that no valid values can be obtained. |
Https | Https | HTTPS configuration. Note: this field may return null, indicating that no valid values can be obtained. |
Disable | String | Domain name blockage status. Valid values: normal (normal), overdue (service is suspended due to arrears), quota (trial traffic package is used up), malicious (malicious user), ddos (DDoS attack), idle (no traffic), unlicensed (no ICP filing), capping (bandwidth cap reached), readonly (read-only). Note: this field may return null, indicating that no valid values can be obtained. |
ForceRedirect | ForceRedirect | Forced access protocol redirection configuration. Note: this field may return null, indicating that no valid values can be obtained. |
Area | String | Acceleration region. Valid values: mainland, overseas, global. Note: this field may return null, indicating that no valid values can be obtained. |
Readonly | String | Domain name lock status. normal: not locked; global: globally locked. Note: this field may return null, indicating that no valid values can be obtained. |
Tag | Array of Tag | Domain name tag Note: This field may return null , indicating that no valid value can be obtained. |
WebSocket | WebSocket | WebSocket configuration. Note: This field may return null , indicating that no valid values can be obtained. |
Filter for domain name query.
Used by actions: DescribeDomains, DescribeDomainsConfig.
Name | Type | Required | Description |
---|---|---|---|
Name | String | Yes | Filters by the field name, which includes: - origin : Primary origin server.- domain : Domain name.- resourceId : Domain name ID.- status : Domain name status. Valid values: online , offline , and processing .- disable : Whether the domain name is blocked. Valid values: normal , unlicensed .- projectId : Project ID.- fullUrlCache : Whether to enable full-path cache, which can be on or off .- https : Whether to configure HTTPS, which can be on , off or processing .- originPullProtocol : Origin-pull protocol type, which can be http , follow , or https .- area : Acceleration region, which can be mainland ,overseas or global .- tagKey : Tag key. |
Value | Array of String | Yes | Filter field value. |
Fuzzy | Boolean | No | Whether to enable fuzzy query, which is supported only for filter fields origin and domain . |
Domain name log information.
Used by actions: DescribeEcdnDomainLogs.
Name | Type | Description |
---|---|---|
StartTime | Timestamp | Log start time. |
EndTime | Timestamp | Log end time. |
LogPath | String | Log download path. |
Detailed access data type
Used by actions: DescribeEcdnStatistics.
Name | Type | Description |
---|---|---|
Metrics | Array of String | Queries the specified metric. Valid values: Bandwidth, Flux, Request, Delay, status code, LogBandwidth, LogFlux, LogRequest |
DetailData | Array of TimestampData | Detailed data collection |
Forced access protocol redirection configuration.
Used by actions: AddEcdnDomain, DescribeDomainsConfig, UpdateDomainConfig.
Name | Type | Required | Description |
---|---|---|---|
Switch | String | Yes | Forced access protocol redirection configuration switch. Valid values: on, off. Note: this field may return null, indicating that no valid values can be obtained. |
RedirectType | String | No | Access protocol type for forced redirection. Valid values: http (forced redirection to HTTP protocol), https (forced redirection to HTTPS protocol). Note: this field may return null, indicating that no valid values can be obtained. |
RedirectStatusCode | Integer | No | HTTP status code returned when forced redirection is enabled. Valid values: 301, 302. Note: this field may return null, indicating that no valid values can be obtained. |
HSTS configuration.
Used by actions: AddEcdnDomain, DescribeDomainsConfig, UpdateDomainConfig.
Name | Type | Required | Description |
---|---|---|---|
Switch | String | Yes | Whether to enable. Valid values: on, off. |
MaxAge | Integer | No | MaxAge value.Note: this field may return null, indicating that no valid values can be obtained. |
IncludeSubDomains | String | No | Whether to include subdomain names. Valid values: on, off. Note: this field may return null, indicating that no valid values can be obtained. |
Path-specific HTTP header setting rule.
Used by actions: AddEcdnDomain, DescribeDomainsConfig, UpdateDomainConfig.
Name | Type | Required | Description |
---|---|---|---|
HeaderMode | String | Yes | HTTP header setting method. Valid values: add (add header), set (set header), del (delete header). Request header currently does not support set .Note: this field may return null, indicating that no valid values can be obtained. |
HeaderName | String | Yes | HTTP header name. Note: this field may return null, indicating that no valid values can be obtained. |
HeaderValue | String | Yes | HTTP header value, which is optional when it is del .Note: this field may return null, indicating that no valid values can be obtained. |
RuleType | String | Yes | Type of effective URL path rule. Valid values: all (all paths), file (file extension), directory (directory), path (absolute path). Note: this field may return null, indicating that no valid values can be obtained. |
RulePaths | Array of String | Yes | URL path or file type list Note: this field may return null, indicating that no valid values can be obtained. |
HTTPS configuration of domain name.
Used by actions: AddEcdnDomain, DescribeDomainsConfig, UpdateDomainConfig.
Name | Type | Required | Description |
---|---|---|---|
Switch | String | Yes | HTTPS configuration switch. Valid values: on, off. If the domain name with HTTPS configuration enabled is being deployed, this switch will be off .Note: this field may return null, indicating that no valid values can be obtained. |
Http2 | String | No | Whether to enable HTTP2. Valid values: on, off. Note: this field may return null, indicating that no valid values can be obtained. |
OcspStapling | String | No | Whether to enable the OCSP feature. Valid values: on, off. Note: this field may return null, indicating that no valid values can be obtained. |
VerifyClient | String | No | Whether to enable the client certificate verification feature. Valid values: on, off. The client certificate information must be uploaded if this feature is enabled. Note: this field may return null, indicating that no valid values can be obtained. |
CertInfo | ServerCert | No | Server certificate configuration information. Note: this field may return null, indicating that no valid values can be obtained. |
ClientCertInfo | ClientCert | No | Client certificate configuration information. Note: this field may return null, indicating that no valid values can be obtained. |
Spdy | String | No | Whether to enable SPDY. Valid values: on, off. Note: this field may return null, indicating that no valid values can be obtained. |
SslStatus | String | No | HTTPS certificate deployment status. Valid values: closed (disabled), deploying (deploying), deployed (deployment succeeded), failed (deployment failed). This parameter cannot be used as an input parameter. Note: this field may return null, indicating that no valid values can be obtained. |
Hsts | Hsts | No | HSTS configuration Note: this field may return null, indicating that no valid values can be obtained. |
IP blocklist/allowlist.
Used by actions: AddEcdnDomain, DescribeDomainsConfig, UpdateDomainConfig.
Name | Type | Required | Description |
---|---|---|---|
Switch | String | Yes | IP blocklist/allowlist switch. Valid values: on, off. |
FilterType | String | No | IP blocklist/allowlist type. Valid values: whitelist, blacklist. Note: this field may return null, indicating that no valid values can be obtained. |
Filters | Array of String | No | IP blocklist/allowlist list. Note: this field may return null, indicating that no valid values can be obtained. |
IP access limit configuration.
Used by actions: AddEcdnDomain, DescribeDomainsConfig, UpdateDomainConfig.
Name | Type | Required | Description |
---|---|---|---|
Switch | String | Yes | IP access limit switch. Valid values: on, off. |
Qps | Integer | No | Number of requests per second. Note: this field may return null, indicating that no valid values can be obtained. |
Node IP information
Used by actions: DescribeIpStatus.
Name | Type | Description |
---|---|---|
Ip | String | Node IP |
District | String | Node region |
Isp | String | Node ISP |
City | String | Node city |
Status | String | Node status online: the node is online and scheduling normally offline: the node is offline |
CreateTime | Timestamp | Node IP creation time |
Origin server configuration.
Used by actions: AddEcdnDomain, DescribeDomains, DescribeDomainsConfig, UpdateDomainConfig.
Name | Type | Required | Description |
---|---|---|---|
Origins | Array of String | No | Primary origin server list. IP and the domain name of the origin server cannot be entered at the same time. Configure origin server port in the format of ["origin1:port1", "origin2:port2"]. Configure origin-pull weight in the format of ["origin1::weight1", "origin2::weight2"]. Configure both port and weight in the format of ["origin1:port1:weight1", "origin2:port2:weight2"]. Valid range of weight value: 0 - 100. |
OriginType | String | No | Primary origin server type. Valid values: domain (domain name origin server), ip (IP origin server). This is required when setting Origins .Note: this field may return null, indicating that no valid values can be obtained. |
ServerName | String | No | Host header value during origin-pull. Note: this field may return null, indicating that no valid values can be obtained. |
OriginPullProtocol | String | No | Origin-pull protocol type. Valid values: http (forced HTTP origin-pull), follow (protocol follow), https (HTTPS origin-pull). If this parameter is left empty, HTTP origin-pull will be used by default. Note: this field may return null , indicating that no valid value is obtained. |
BackupOrigins | Array of String | No | Secondary origin server list. |
BackupOriginType | String | No | Secondary origin server type, which is the same as OriginType .This is required when setting BackupOrigins .Note: this field may return null, indicating that no valid values can be obtained. |
AdvanceHttps | AdvanceHttps | No | HTTPS advanced origin-pull configuration Note: This field may return null , indicating that no valid values can be obtained. |
Purge task log details.
Used by actions: DescribePurgeTasks.
Name | Type | Description |
---|---|---|
TaskId | String | Purge task ID. |
Url | String | Purged URL. |
Status | String | Purge task status. fail: failed, done: succeeded, process: purging. |
PurgeType | String | Purge type. url: URL purge; path: directory purge. |
FlushType | String | Resource purge method. flush: purges updated resources, delete: purges all resources. |
CreateTime | Timestamp | Purge task submission time |
Purge usage and quota
Used by actions: DescribePurgeQuota.
Name | Type | Description |
---|---|---|
Batch | Integer | Quota limit for one batch submission request. |
Total | Integer | Daily submission quota limit. |
Available | Integer | Remaining daily submission quota. |
Query object and its access details
Used by actions: DescribeEcdnStatistics.
Name | Type | Description |
---|---|---|
Resource | String | Resource name, which is categorized as follows based on different query conditions: Specific domain name: indicates the details of the specific domain name multiDomains: indicates aggregated details of multiple domain names Project ID: displays the ID of the specified project to be queried all: details at the account level |
EcdnData | EcdnData | Data details of resource |
Custom response header configuration.
Used by actions: AddEcdnDomain, DescribeDomainsConfig, UpdateDomainConfig.
Name | Type | Required | Description |
---|---|---|---|
Switch | String | Yes | Custom response header switch. Valid values: on, off. |
HeaderRules | Array of HttpHeaderPathRule | No | Custom response header rule array. Note: this field may return null, indicating that no valid values can be obtained. |
HTTPS server certificate configuration.
Used by actions: AddEcdnDomain, DescribeDomains, DescribeDomainsConfig, UpdateDomainConfig.
Name | Type | Required | Description |
---|---|---|---|
CertId | String | No | Server certificate ID, which is required if the certificate is a Tencent Cloud-hosted certificate. Note: this field may return null, indicating that no valid values can be obtained. |
CertName | String | No | Server certificate name, which is required if the certificate is a Tencent Cloud-hosted certificate. Note: this field may return null, indicating that no valid values can be obtained. |
Certificate | String | No | Server certificate information, which is required when uploading your own certificate and must contain complete certificate chain information. Note: this field may return null, indicating that no valid values can be obtained. |
PrivateKey | String | No | Server key information, which is required when uploading your own certificate. Note: this field may return null, indicating that no valid values can be obtained. |
ExpireTime | Timestamp | No | Certificate expiration time. Note: this field may return null, indicating that no valid values can be obtained. |
DeployTime | Timestamp | No | Certificate issuance time. Note: this field may return null, indicating that no valid values can be obtained. |
Message | String | No | Certificate remarks. Note: this field may return null, indicating that no valid values can be obtained. |
Sorting criteria for query results.
Used by actions: DescribeDomainsConfig.
Name | Type | Required | Description |
---|---|---|---|
Key | String | Yes | Sort by field. Valid values: createTime: domain name creation time certExpireTime: certificate expiration time |
Sequence | String | No | asc/desc. Default value: desc. |
Tag key and tag value.
Used by actions: AddEcdnDomain, DescribeDomains, DescribeDomainsConfig.
Name | Type | Required | Description |
---|---|---|---|
TagKey | String | Yes | Tag key. Note: this field may return null , indicating that no valid value is obtained. |
TagValue | String | Yes | Tag value. Note: this field may return null , indicating that no valid value is obtained. |
Timestamp and its corresponding value
Used by actions: DescribeEcdnStatistics.
Name | Type | Description |
---|---|---|
Time | Timestamp | Statistical time point in forward rounding mode Taking the 5-minute granularity as an example, 13:35:00 indicates that the statistical interval is between 13:35:00 and 13:39:59 |
Value | Array of Float | Data value |
WebSocket configuration.
Used by actions: AddEcdnDomain, DescribeDomainsConfig, UpdateDomainConfig.
Name | Type | Required | Description |
---|---|---|---|
Switch | String | Yes | Whether to enable custom WebSocket timeout setting. When it’s off : WebSocket connection is supported, and the default timeout period is 15 seconds. To change the timeout period, please set it to on .* WebSocket is now only available for beta users. To use it, please submit a ticket. |
Timeout | Integer | No | Sets timeout period in seconds. Maximum value: 65 Note: This field may return null , indicating that no valid values can be obtained. |
Was this page helpful?