{ "name": "cdn", "display_name": "内容分发网络 CDN", "description": "介绍如何使用API对内容分发网络操作，包括域名管理、配置管理、日志查询等。", "domain": "cdn", "api_version": "2018-06-06", "endpoint": "cdn.tencentcloudapi.com", "actions": [ { "name": "AddCLSTopicDomains", "description": "AddCLSTopicDomains 用于新增域名到某日志主题下", "status": "online", "parameters": [ { "name": "LogsetId", "type": "string", "required": true, "description": "日志集ID", "example": "6d04373b-ba59-4a4f-a96e-9fe53b59a536" }, { "name": "TopicId", "type": "string", "required": true, "description": "日志主题ID", "example": "d2256449-c6ff-421b-93ef-aa3a7dde2de2" }, { "name": "DomainAreaConfigs", "type": "array", "required": true, "description": "域名区域配置", "example": "无", "item_type": "object", "children": [ { "name": "Domain", "type": "string", "required": true, "description": "域名", "example": "qq.com" }, { "name": "Area", "type": "array", "required": true, "description": "地区列表，其中元素可为mainland/overseas", "example": "mainland", "item_type": "string" } ] }, { "name": "Channel", "type": "string", "required": false, "description": "接入渠道，cdn或者ecdn，默认值为cdn", "example": "cdn" }, { "name": "InheritDomainTags", "type": "boolean", "required": false, "description": "是否继承域名标签, 默认保留上一次更改的值", "example": "true" } ], "required": [ "LogsetId", "TopicId", "DomainAreaConfigs" ] }, { "name": "AddCdnDomain", "description": "AddCdnDomain 用于新增内容分发网络加速域名。1分钟内最多可新增100个域名。", "status": "online", "parameters": [ { "name": "Domain", "type": "string", "required": true, "description": "域名", "example": "www.test.com" }, { "name": "ServiceType", "type": "string", "required": true, "description": "加速域名业务类型 web：网页小文件 download：下载大文件 media：音视频点播 hybrid: 动静加速 dynamic: 动态加速", "example": "web" }, { "name": "Origin", "type": "object", "required": true, "description": "源站配置", "example": "无", "children": [ { "name": "Origins", "type": "array", "required": false, "description": "主源站列表 修改源站时，需要同时填充对应的 OriginType 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"1.1.1.1\"]", "item_type": "string" }, { "name": "OriginType", "type": "string", "required": false, "description": "主源站类型 当源站列表 Origins 不为空时必填 入参支持以下几种类型： domain：域名类型 domainv6：域名解析V6类型 cos：对象存储源站 third_party: 第三方存储源站 igtm: IGTM多活源 ip：IP 列表作为源站 ipv6：源站列表为一个单独的 IPv6 地址 ip_ipv6：源站列表为多个 IPv4 地址和IPv6 地址 ip_domain: 支持IP和域名形式源站混填（白名单功能） ip_domainv6：源站列表为多个 IPv4 地址以及域名解析v6地...", "example": "ip" }, { "name": "ServerName", "type": "string", "required": false, "description": "回主源站时 Host 头部 当源站类型为cos或者第三方存储加速时,ServerName字段必填 不填充则默认为加速域名 若接入的是泛域名，则回源 Host 默认为访问时的子域名 注意：此字段可能返回 null，表示取不到有效值。", "example": "www.test.com" }, { "name": "CosPrivateAccess", "type": "string", "required": false, "description": "OriginType 为对象存储（COS）时，可以指定是否允许访问私有 bucket 注意：需要先授权 CDN 访问该私有 Bucket 的权限后，才可开启此配置。取值范围: on/off 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" }, { "name": "OriginPullProtocol", "type": "string", "required": false, "description": "回源协议配置 http：强制 http 回源 follow：协议跟随回源 https：强制 https 回源 注意：此字段可能返回 null，表示取不到有效值。", "example": "http" }, { "name": "BackupOrigins", "type": "array", "required": false, "description": "备源站列表 修改备源站时，需要同时填充对应的 BackupOriginType 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"2.2.2.2\"]", "item_type": "string" }, { "name": "BackupOriginType", "type": "string", "required": false, "description": "备源站类型 备源站列表BackupOrigins 不为空时必填 支持以下类型： domain：域名类型 ip：IP 列表作为源站 以下备源源站类型尚未全量支持，需要申请试用： ipv6_domain: 源站列表为多个 IPv6 地址以及域名 ip_ipv6：源站列表为多个 IPv4 地址和IPv6 地址 ip_ipv6_domain：源站列表为多个 IPv4 地址IPv6 地址以及域名 注意：此字段可能返回 null，表示取不到有效值。", "example": "ip" }, { "name": "BackupServerName", "type": "string", "required": false, "description": "回备源站时 Host 头部，不填充则默认为主源站的 ServerName 注意：此字段可能返回 null，表示取不到有效值。", "example": "www.test2.com" }, { "name": "BasePath", "type": "string", "required": false, "description": "回源路径 注意：此字段可能返回 null，表示取不到有效值。", "example": "/data" }, { "name": "PathRules", "type": "array", "required": false, "description": "回源路径重写规则配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Regex", "type": "boolean", "required": true, "description": "是否开启通配符“*”匹配： false：关闭 true：开启 注意：此字段可能返回 null，表示取不到有效值。", "example": "false" }, { "name": "Path", "type": "string", "required": true, "description": "匹配的URL路径，仅支持Url路径，不支持参数。默认完全匹配，开启通配符“*”匹配后，最多支持5个通配符，最大长度为1024个字符。 注意：此字段可能返回 null，表示取不到有效值。", "example": "/test" }, { "name": "Origin", "type": "string", "required": false, "description": "路径匹配时的回源源站。暂不支持开了私有读写的COS源。不填写时沿用默认源站。 注意：此字段可能返回 null，表示取不到有效值。", "example": "8.8.8.8" }, { "name": "ServerName", "type": "string", "required": false, "description": "路径匹配时回源的Host头部。不填写时沿用默认ServerName。 注意：此字段可能返回 null，表示取不到有效值。", "example": "www.test.com" }, { "name": "OriginArea", "type": "string", "required": false, "description": "源站所属区域，支持CN，OV： CN：中国境内 OV：中国境外 默认为CN。 注意：此字段可能返回 null，表示取不到有效值。", "example": "CN" }, { "name": "ForwardUri", "type": "string", "required": false, "description": "路径匹配时回源的URI路径，必须以“/”开头，不包含参数部分。最大长度为1024个字符。可使用$1, $2, $3, $4, $5分别捕获匹配路径中的通配符号“*”，最多支持10个捕获值。 注意：此字段可能返回 null，表示取不到有效值。", "example": "/demo" }, { "name": "RequestHeaders", "type": "array", "required": false, "description": "路径匹配时回源的头部设置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "HeaderMode", "type": "string", "required": true, "description": "http头部设置方式，支持add，set或del，分别表示新增，设置或删除头部。", "example": "add" }, { "name": "HeaderName", "type": "string", "required": true, "description": "http头部名称。", "example": "X-Cdn-Header" }, { "name": "HeaderValue", "type": "string", "required": true, "description": "http头部值。", "example": "header-value" } ] }, { "name": "FullMatch", "type": "boolean", "required": false, "description": "当Regex为false时，Path是否开启完全匹配。 false：关闭 true：开启 注意：此字段可能返回 null，表示取不到有效值。", "example": "true" } ] }, { "name": "PathBasedOrigin", "type": "array", "required": false, "description": "分路径回源配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "RuleType", "type": "string", "required": true, "description": "规则类型： file：指定文件后缀生效 directory：指定路径生效 path：指定绝对路径生效 index: 指定主页生效", "example": "file" }, { "name": "RulePaths", "type": "array", "required": true, "description": "RuleType 对应类型下的匹配内容： file 时填充后缀名，如 jpg、txt directory 时填充路径，如 /xxx/test/ path 时填充绝对路径，如 /xxx/test.html index 时填充 /", "example": "jpg", "item_type": "string" }, { "name": "Origin", "type": "array", "required": true, "description": "源站列表，支持域名或ipv4地址", "example": "10.0.0.1", "item_type": "string" } ] }, { "name": "Sni", "type": "object", "required": false, "description": "HTTPS回源SNI配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "是否开启HTTPS回源SNI。 开启：on， 关闭：off", "example": "on" }, { "name": "ServerName", "type": "string", "required": true, "description": "回源域名。 注意：此字段可能返回 null，表示取不到有效值。", "example": "qq.com" } ] }, { "name": "AdvanceHttps", "type": "object", "required": false, "description": "HTTPS回源高级配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "CustomTlsStatus", "type": "string", "required": false, "description": "自定义Tls数据开关 注意：此字段可能返回 null，表示取不到有效值。", "example": "on" }, { "name": "TlsVersion", "type": "array", "required": false, "description": "Tls版本列表，支持设置 TLSv1, TLSV1.1, TLSV1.2, TLSv1.3，修改时必须开启连续的版本 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"TLSv1\",\"TLSv1.1\",\"TLSv1.2\",\"TLSv1.3\"]", "item_type": "string" }, { "name": "Cipher", "type": "string", "required": false, "description": "自定义加密套件 注意：此字段可能返回 null，表示取不到有效值。", "example": "\"EECDH+AES128\"" }, { "name": "VerifyOriginType", "type": "string", "required": false, "description": "回源双向校验开启状态 off - 关闭校验 oneWay - 校验源站 twoWay - 双向校验 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" }, { "name": "CertInfo", "type": "object", "required": false, "description": "回源层证书配置信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "CertId", "type": "string", "required": false, "description": "服务器证书 ID 在 SSL 证书管理进行证书托管时自动生成 注意：此字段可能返回 null，表示取不到有效值。", "example": "LE-dsfdsf" }, { "name": "CertName", "type": "string", "required": false, "description": "服务器证书名称 在 SSL 证书管理进行证书托管时自动生成 注意：此字段可能返回 null，表示取不到有效值。", "example": "aa.com" }, { "name": "Certificate", "type": "string", "required": false, "description": "服务器证书信息 上传自有证书时必填，需要包含完整的证书链 注意：此字段可能返回 null，表示取不到有效值。", "example": "不展示" }, { "name": "PrivateKey", "type": "string", "required": false, "description": "服务器密钥信息 上传自有证书时必填 注意：此字段可能返回 null，表示取不到有效值。", "example": "不展示" }, { "name": "ExpireTime", "type": "string", "required": false, "description": "证书过期时间 作为入参配置时无需填充 注意：此字段可能返回 null，表示取不到有效值。", "example": "2021-12-01 09:48:19" }, { "name": "DeployTime", "type": "string", "required": false, "description": "证书颁发时间 作为入参配置时无需填充 注意：此字段可能返回 null，表示取不到有效值。", "example": "2021-12-01 09:48:19" }, { "name": "Message", "type": "string", "required": false, "description": "证书备注信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "备注" }, { "name": "From", "type": "string", "required": false, "description": "证书来源 注意：此字段可能返回 null，表示取不到有效值。", "example": "upload" } ] }, { "name": "OriginCertInfo", "type": "object", "required": false, "description": "源站证书配置信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Certificate", "type": "string", "required": true, "description": "客户端证书 PEM 格式，需要进行 Base 64 编码 注意：此字段可能返回 null，表示取不到有效值。", "example": "Certificate" }, { "name": "CertName", "type": "string", "required": false, "description": "客户端证书名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "qq.com" }, { "name": "ExpireTime", "type": "string", "required": false, "description": "证书过期时间 作为入参时无需填充 注意：此字段可能返回 null，表示取不到有效值。", "example": "2025-06-28 11:38:2" }, { "name": "DeployTime", "type": "string", "required": false, "description": "证书颁发时间 作为入参时无需填充 注意：此字段可能返回 null，表示取不到有效值。", "example": "2023-06-28 11:38:20" } ] } ] }, { "name": "OriginCompany", "type": "string", "required": false, "description": "对象存储回源厂商 当源站类型为第三方存储源站(third_party)时必填 可选值包括以下: aws_s3: AWS S3 ali_oss: 阿里云 OSS hw_obs: 华为 OBS qiniu_kodo: 七牛云 kodo others: 其它厂商对象存储,仅支持兼容以AWS签名算法的对象存储，如腾讯云金融专区COS 注意：此字段可能返回 null，表示取不到有效值。", "example": "hw-oss" } ] }, { "name": "ProjectId", "type": "integer", "required": false, "description": "项目 ID，默认为 0，代表【默认项目】", "example": "0" }, { "name": "IpFilter", "type": "object", "required": false, "description": "IP 黑白名单配置", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "IP 黑白名单配置开关，取值有 on：开启 off：关闭", "example": "on" }, { "name": "FilterType", "type": "string", "required": false, "description": "IP 黑白名单类型 whitelist：白名单 blacklist：黑名单 注意：此字段可能返回 null，表示取不到有效值。", "example": "blacklist" }, { "name": "Filters", "type": "array", "required": false, "description": "IP 黑白名单列表 支持 X.X.X.X 格式IPV4地址 或X:X:X:X:X:X:X:X 格式IPV6地址， 或网段格式/X（IPV4:1≤X≤32；IPV6:1≤X≤128） 最多可填充 200 个白名单或 200 个黑名单； 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"1.1.1.1\"]", "item_type": "string" }, { "name": "FilterRules", "type": "array", "required": false, "description": "IP 黑白名单分路径配置。黑白名单 IP 总数不能超过 1000 个。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "FilterType", "type": "string", "required": true, "description": "IP 黑白名单类型 whitelist：白名单 blacklist：黑名单 注意：此字段可能返回 null，表示取不到有效值。", "example": "whitelist" }, { "name": "Filters", "type": "array", "required": true, "description": "IP 黑白名单列表 支持 X.X.X.X 格式IPV4地址 或X:X:X:X:X:X:X:X 格式IPV6地址， 或网段格式/X（IPV4:1≤X≤32；IPV6:1≤X≤128） 最多可填充 500 个白名单或 200 个黑名单； 注意：此字段可能返回 null，表示取不到有效值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "RuleType", "type": "string", "required": true, "description": "规则类型： all：所有文件生效 file：指定文件后缀生效 directory：指定路径生效 path：指定绝对路径生效 注意：此字段可能返回 null，表示取不到有效值。", "example": "file" }, { "name": "RulePaths", "type": "array", "required": true, "description": "RuleType 对应类型下的匹配内容： all 时填充 * file 时填充后缀名，如 jpg、txt directory 时填充路径，如 /xxx/test/ path 时填充绝对路径，如 /xxx/test.html 注意：此字段可能返回 null，表示取不到有效值。", "example": "jpg", "item_type": "string" }, { "name": "Remark", "type": "string", "required": false, "description": "备注信息, 最多支持50个字符", "example": "remark" } ] }, { "name": "ReturnCode", "type": "integer", "required": false, "description": "IP 黑白名单验证失败时返回的状态码。 注意： 请求拒绝时，平台默认响应514状态。 支持自定义为403，404，609状态码，空值时或自定义的不在范围内，均默认为514. 非514状态码将计入HTTPS计费统计，最终账单将按您的计费规则生成。 若您开启了自定义状态码，则默认您认同HTTPS计费规则。 注意：此字段可能返回 null，表示取不到有效值。", "example": "514" } ] }, { "name": "IpFreqLimit", "type": "object", "required": false, "description": "IP 限频配置", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "IP 限频配置开关，取值有： on：开启 off：关闭", "example": "off" }, { "name": "Qps", "type": "integer", "required": false, "description": "设置每秒请求数限制 超出限制的请求会直接返回 514 注意：此字段可能返回 null，表示取不到有效值。", "example": "20" } ] }, { "name": "StatusCodeCache", "type": "object", "required": false, "description": "状态码缓存配置", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "状态码缓存过期配置开关，取值有： on：开启 off：关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" }, { "name": "CacheRules", "type": "array", "required": false, "description": "状态码缓存过期规则明细 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "StatusCode", "type": "string", "required": true, "description": "http 状态码 支持 403、404 状态码", "example": "403" }, { "name": "CacheTime", "type": "integer", "required": true, "description": "状态码缓存过期时间，单位秒", "example": "3600" } ] } ] }, { "name": "Compression", "type": "object", "required": false, "description": "智能压缩配置", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "智能压缩配置开关，取值有： on：开启 off：关闭", "example": "on" }, { "name": "CompressionRules", "type": "array", "required": false, "description": "压缩规则数组 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Compress", "type": "boolean", "required": true, "description": "true：需要设置为 ture，启用压缩 注意：此字段可能返回 null，表示取不到有效值。", "example": "true" }, { "name": "MinLength", "type": "integer", "required": true, "description": "触发压缩的文件长度最小值，单位为字节数 注意：此字段可能返回 null，表示取不到有效值。", "example": "256" }, { "name": "MaxLength", "type": "integer", "required": true, "description": "触发压缩的文件长度最大值，单位为字节数 最大可设置为 30MB 注意：此字段可能返回 null，表示取不到有效值。", "example": "10000" }, { "name": "Algorithms", "type": "array", "required": true, "description": "文件压缩算法 gzip：指定 GZIP 压缩 brotli：指定Brotli压缩 注意：此字段可能返回 null，表示取不到有效值。", "example": "gzIp", "item_type": "string" }, { "name": "FileExtensions", "type": "array", "required": false, "description": "根据文件后缀类型压缩 例如 jpg、txt 注意：此字段可能返回 null，表示取不到有效值。", "example": "jpg", "item_type": "string" }, { "name": "RuleType", "type": "string", "required": false, "description": "规则类型： all：所有文件生效 file：指定文件后缀生效 directory：指定路径生效 path：指定绝对路径生效 contentType：指定Content-Type头为特定值时生效 当指定了此字段时，FileExtensions字段不生效 注意：此字段可能返回 null，表示取不到有效值。", "example": "file" }, { "name": "RulePaths", "type": "array", "required": false, "description": "CacheType 对应类型下的匹配内容： all 时填充 * file 时填充后缀名，如 jpg、txt directory 时填充路径，如 /xxx/test path 时填充绝对路径，如 /xxx/test.html contentType 时填充 text/html 注意：此字段可能返回 null，表示取不到有效值。", "example": "jpg", "item_type": "string" } ] } ] }, { "name": "BandwidthAlert", "type": "object", "required": false, "description": "带宽封顶配置", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "用量封顶配置开关，取值有： on：开启 off：关闭", "example": "off" }, { "name": "BpsThreshold", "type": "integer", "required": false, "description": "用量封顶阈值，带宽单位为bps，流量单位byte 注意：此字段可能返回 null，表示取不到有效值。", "example": "1000000" }, { "name": "CounterMeasure", "type": "string", "required": false, "description": "达到阈值后的操作 RETURN_404：全部请求返回 404 注意：此字段可能返回 null，表示取不到有效值。", "example": "RETURN_404" }, { "name": "LastTriggerTime", "type": "string", "required": false, "description": "境内区域上次触发用量封顶阈值的时间 注意：此字段可能返回 null，表示取不到有效值。", "example": "2023-06-28 12:00:00" }, { "name": "AlertSwitch", "type": "string", "required": false, "description": "用量封顶提醒配置开关，取值有： on：开启 off：关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" }, { "name": "AlertPercentage", "type": "integer", "required": false, "description": "用量封顶阈值提醒百分比 注意：此字段可能返回 null，表示取不到有效值。", "example": "80" }, { "name": "LastTriggerTimeOverseas", "type": "string", "required": false, "description": "海外区域上次触发用量封顶阈值的时间 注意：此字段可能返回 null，表示取不到有效值。", "example": "2023-06-28 12:00:00" }, { "name": "Metric", "type": "string", "required": false, "description": "用量阈值触发的维度 带宽：bandwidth 流量：flux 注意：此字段可能返回 null，表示取不到有效值。", "example": "bandwith" }, { "name": "StatisticItems", "type": "array", "required": false, "description": "累计用量配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Type", "type": "string", "required": false, "description": "封顶类型，累计用量total，瞬时用量moment 注意：此字段可能返回 null，表示取不到有效值。", "example": "total" }, { "name": "UnBlockTime", "type": "integer", "required": false, "description": "自动解封时间 注意：此字段可能返回 null，表示取不到有效值。", "example": "60" }, { "name": "BpsThreshold", "type": "integer", "required": false, "description": "带宽、流量阈值 注意：此字段可能返回 null，表示取不到有效值。", "example": "1000000000" }, { "name": "CounterMeasure", "type": "string", "required": false, "description": "关闭方式 返回404:RETURN_404 注意：此字段可能返回 null，表示取不到有效值。", "example": "RETURN_404" }, { "name": "AlertPercentage", "type": "integer", "required": false, "description": "触发提醒阈值百分比 注意：此字段可能返回 null，表示取不到有效值。", "example": "80" }, { "name": "AlertSwitch", "type": "string", "required": false, "description": "累计用量封顶告警配置，取值有： on：开启 off：关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "on" }, { "name": "Metric", "type": "string", "required": false, "description": "指标类型，流量flux或带宽bandwidth 注意：此字段可能返回 null，表示取不到有效值。", "example": "flux" }, { "name": "Cycle", "type": "integer", "required": false, "description": "检测周期，单位分钟，60或1440 注意：此字段可能返回 null，表示取不到有效值。", "example": "60" }, { "name": "Switch", "type": "string", "required": false, "description": "累计用量封顶配置开关，取值有： on：开启 off：关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "on" } ] } ] }, { "name": "RangeOriginPull", "type": "object", "required": false, "description": "Range 回源配置", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "分片回源配置开关，取值有： on：开启 off：关闭", "example": "on" }, { "name": "RangeRules", "type": "array", "required": false, "description": "分路径分片回源配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "[{\"Switch\":\"on\",\"RuleType\":\"file\",\"RulePaths\":[\"jpg\"]}]", "item_type": "object", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "分片回源配置开关，取值有： on：开启 off：关闭", "example": "on" }, { "name": "RuleType", "type": "string", "required": true, "description": "规则类型： file：指定文件后缀生效 directory：指定路径生效 path：指定绝对路径生效 注意：此字段可能返回 null，表示取不到有效值。", "example": "file" }, { "name": "RulePaths", "type": "array", "required": true, "description": "RuleType 对应类型下的匹配内容： file 时填充后缀名，如 jpg、txt directory 时填充路径，如 /xxx/test path 时填充绝对路径，如 /xxx/test.html 注意：此字段可能返回 null，表示取不到有效值。", "example": "jpg", "item_type": "string" } ] } ] }, { "name": "FollowRedirect", "type": "object", "required": false, "description": "301/302 回源跟随配置。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "回源跟随配置开关，取值有： on：开启 off：关闭", "example": "off" }, { "name": "RedirectConfig", "type": "object", "required": false, "description": "自定义回源302 follow请求host配置，该功能为白名单功能，需要开启请联系腾讯云工程师。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "自定义回源302 follow请求host配置开关，取值有： on：开启 off：关闭", "example": "on" }, { "name": "FollowRedirectHost", "type": "string", "required": true, "description": "主源站follow302请求时带的自定义的host头部", "example": "main.host.com" }, { "name": "FollowRedirectBackupHost", "type": "string", "required": false, "description": "备份源站follow302请求时带的自定义的host头部", "example": "backup.host.com" } ] } ] }, { "name": "ErrorPage", "type": "object", "required": false, "description": "错误码重定向配置（功能灰度中，尚未全量）", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "状态码重定向配置开关，取值有： on：开启 off：关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" }, { "name": "PageRules", "type": "array", "required": false, "description": "状态码重定向规则配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "StatusCode", "type": "integer", "required": true, "description": "状态码 支持 400、403、404、500", "example": "404" }, { "name": "RedirectCode", "type": "integer", "required": true, "description": "重定向状态码设置 支持 301 或 302", "example": "301" }, { "name": "RedirectUrl", "type": "string", "required": true, "description": "重定向 URL 需要为完整跳转路径，如 https://www.test.com/error.html", "example": "https://www.test.com/error.html" } ] } ] }, { "name": "RequestHeader", "type": "object", "required": false, "description": "请求头部配置", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "自定义请求头配置开关，取值有： on：开启 off：关闭", "example": "off" }, { "name": "HeaderRules", "type": "array", "required": false, "description": "自定义请求头配置规则 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "HeaderMode", "type": "string", "required": true, "description": "http 头部设置方式 set：设置。变更指定头部参数的取值为设置后的值；若设置的头部不存在，则会增加该头部；若存在多个重复的头部参数，则会全部变更，同时合并为一个头部。 del：删除。删除指定的头部参数 add：增加。增加指定的头部参数，默认允许重复添加，即重复添加相同的头部（注：重复添加可能会影响浏览器响应，请优先使用set操作） 注意：此字段可能返回 null...", "example": "set" }, { "name": "HeaderName", "type": "string", "required": true, "description": "http 头部名称，最多可设置 100 个字符 注意：此字段可能返回 null，表示取不到有效值。", "example": "name" }, { "name": "HeaderValue", "type": "string", "required": true, "description": "http 头部值，自定义请求头中最多可设置 1000 个字符，自定义响应头中最多可以设置 2000 个字符 Mode 为 del 时非必填 Mode 为 add/set 时必填 注意：此字段可能返回 null，表示取不到有效值。", "example": "value" }, { "name": "RuleType", "type": "string", "required": true, "description": "规则类型： all：所有文件生效 file：指定文件后缀生效 directory：指定路径生效 path：指定绝对路径生效 注意：此字段可能返回 null，表示取不到有效值。", "example": "file" }, { "name": "RulePaths", "type": "array", "required": true, "description": "RuleType 对应类型下的匹配内容： all 时填充 * file 时填充后缀名，如 jpg、txt directory 时填充路径，如 /xxx/test/ path 时填充绝对路径，如 /xxx/test.html 注意：此字段可能返回 null，表示取不到有效值。", "example": "jpg", "item_type": "string" } ] } ] }, { "name": "ResponseHeader", "type": "object", "required": false, "description": "响应头部配置", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "自定义响应头配置开关，取值有： on：开启 off：关闭", "example": "off" }, { "name": "HeaderRules", "type": "array", "required": false, "description": "自定义响应头规则 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "HeaderMode", "type": "string", "required": true, "description": "http 头部设置方式 set：设置。变更指定头部参数的取值为设置后的值；若设置的头部不存在，则会增加该头部；若存在多个重复的头部参数，则会全部变更，同时合并为一个头部。 del：删除。删除指定的头部参数 add：增加。增加指定的头部参数，默认允许重复添加，即重复添加相同的头部（注：重复添加可能会影响浏览器响应，请优先使用set操作） 注意：此字段可能返回 null...", "example": "set" }, { "name": "HeaderName", "type": "string", "required": true, "description": "http 头部名称，最多可设置 100 个字符 注意：此字段可能返回 null，表示取不到有效值。", "example": "name" }, { "name": "HeaderValue", "type": "string", "required": true, "description": "http 头部值，自定义请求头中最多可设置 1000 个字符，自定义响应头中最多可以设置 2000 个字符 Mode 为 del 时非必填 Mode 为 add/set 时必填 注意：此字段可能返回 null，表示取不到有效值。", "example": "value" }, { "name": "RuleType", "type": "string", "required": true, "description": "规则类型： all：所有文件生效 file：指定文件后缀生效 directory：指定路径生效 path：指定绝对路径生效 注意：此字段可能返回 null，表示取不到有效值。", "example": "file" }, { "name": "RulePaths", "type": "array", "required": true, "description": "RuleType 对应类型下的匹配内容： all 时填充 * file 时填充后缀名，如 jpg、txt directory 时填充路径，如 /xxx/test/ path 时填充绝对路径，如 /xxx/test.html 注意：此字段可能返回 null，表示取不到有效值。", "example": "jpg", "item_type": "string" } ] } ] }, { "name": "DownstreamCapping", "type": "object", "required": false, "description": "下载速度配置", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "下行速度配置开关，取值有： on：开启 off：关闭", "example": "off" }, { "name": "CappingRules", "type": "array", "required": false, "description": "下行限速规则 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "RuleType", "type": "string", "required": true, "description": "规则类型： all：所有文件生效 file：指定文件后缀生效 directory：指定路径生效 path：指定绝对路径生效", "example": "file" }, { "name": "RulePaths", "type": "array", "required": true, "description": "RuleType 对应类型下的匹配内容： all 时填充 * file 时填充后缀名，如 jpg、txt directory 时填充路径，如 /xxx/test/ path 时填充绝对路径，如 /xxx/test.html", "example": "png", "item_type": "string" }, { "name": "KBpsThreshold", "type": "integer", "required": true, "description": "下行速度值设置，单位为 KB/s", "example": "100" } ] } ] }, { "name": "CacheKey", "type": "object", "required": false, "description": "节点缓存键配置", "example": "无", "children": [ { "name": "FullUrlCache", "type": "string", "required": false, "description": "是否开启全路径缓存 on：开启全路径缓存（即关闭参数忽略） off：关闭全路径缓存（即开启参数忽略）", "example": "off" }, { "name": "IgnoreCase", "type": "string", "required": false, "description": "是否忽略大小写缓存 on：开启 off：关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" }, { "name": "QueryString", "type": "object", "required": false, "description": "CacheKey中包含请求参数 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "CacheKey是否由QueryString组成配置开关，取值有： on：开启 off：关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "on" }, { "name": "Reorder", "type": "string", "required": false, "description": "是否重新排序 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" }, { "name": "Action", "type": "string", "required": false, "description": "使用/排除部分url参数，取值有： includeAll：包含所有 excludeAll：排除所有 includeCustom：自定义包含 excludeCustom：自定义排除 注意：此字段可能返回 null，表示取不到有效值。", "example": "includeCustom" }, { "name": "Value", "type": "string", "required": false, "description": "使用/排除的url参数数组，';' 分割 注意：此字段可能返回 null，表示取不到有效值。", "example": "key1;key2" } ] }, { "name": "Cookie", "type": "object", "required": false, "description": "CacheKey中包含Cookie 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "使用Cookie作为Cache的一部分配置开关，取值有： on：开启，使用Cookie作为Cache的一部分 off：关闭，不使用Cookie作为Cache的一部分 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" }, { "name": "Value", "type": "string", "required": false, "description": "使用的cookie，';' 分割 注意：此字段可能返回 null，表示取不到有效值。", "example": "cookie value" } ] }, { "name": "Header", "type": "object", "required": false, "description": "CacheKey中包含请求头部 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "组成Cachekey配置开关，取值有： on：开启 off：关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" }, { "name": "Value", "type": "string", "required": false, "description": "组成CacheKey的header数组，';' 分割 注意：此字段可能返回 null，表示取不到有效值。", "example": "header value" } ] }, { "name": "CacheTag", "type": "object", "required": false, "description": "CacheKey中包含自定义字符串 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "使用CacheTag作为CacheKey的一部分配置开关，取值有 on：开启，使用CacheTag作为CacheKey的一部分 off：关闭，不使用CacheTag作为CacheKey的一部分 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" }, { "name": "Value", "type": "string", "required": false, "description": "自定义CacheTag的值 注意：此字段可能返回 null，表示取不到有效值。", "example": "CacheTagValue" } ] }, { "name": "Scheme", "type": "object", "required": false, "description": "CacheKey中包含请求协议 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "scheme作为cache key配置开关，取值有： on：开启 off：关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" } ] }, { "name": "KeyRules", "type": "array", "required": false, "description": "分路径缓存键配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "RulePaths", "type": "array", "required": true, "description": "CacheType 对应类型下的匹配内容： file 时填充后缀名，如 jpg、txt directory 时填充路径，如 /xxx/test path 时填充绝对路径，如 /xxx/test.html index 时填充 / 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"jpg\"]", "item_type": "string" }, { "name": "RuleType", "type": "string", "required": true, "description": "规则类型： file：指定文件后缀生效 directory：指定路径生效 path：指定绝对路径生效 index：首页 注意：此字段可能返回 null，表示取不到有效值。", "example": "file" }, { "name": "FullUrlCache", "type": "string", "required": true, "description": "是否开启全路径缓存 on：开启全路径缓存（即关闭参数忽略） off：关闭全路径缓存（即开启参数忽略） 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" }, { "name": "IgnoreCase", "type": "string", "required": true, "description": "是否忽略大小写缓存 on：开启 off：关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" }, { "name": "QueryString", "type": "object", "required": true, "description": "CacheKey中包含请求参数 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "路径保留参数配置开关，取值有： on：开启，CacheKey由QueryString组成 off：关闭，CacheKey不由QueryString组成 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" }, { "name": "Action", "type": "string", "required": true, "description": "includeCustom 包含部分url参数 注意：此字段可能返回 null，表示取不到有效值。", "example": "includeAll" }, { "name": "Value", "type": "string", "required": true, "description": "使用/排除的url参数数组，';' 分割 注意：此字段可能返回 null，表示取不到有效值。", "example": "example-value" } ] }, { "name": "RuleTag", "type": "string", "required": true, "description": "路径缓存键标签，传 user 注意：此字段可能返回 null，表示取不到有效值。", "example": "user" } ] } ] }, { "name": "ResponseHeaderCache", "type": "object", "required": false, "description": "头部缓存配置", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "源站头部缓存配置开关，取值有： on：开启 off：关闭", "example": "off" } ] }, { "name": "VideoSeek", "type": "object", "required": false, "description": "视频拖拽配置", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "视频拖拽配置开关，取值有： on：开启 off：关闭", "example": "off" } ] }, { "name": "Cache", "type": "object", "required": false, "description": "缓存过期时间配置", "example": "无", "children": [ { "name": "SimpleCache", "type": "object", "required": false, "description": "基础缓存过期时间配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "CacheRules", "type": "array", "required": true, "description": "缓存过期时间规则 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "CacheType", "type": "string", "required": true, "description": "规则类型： all：所有文件生效 file：指定文件后缀生效 directory：指定路径生效 path：指定绝对路径生效 index：首页", "example": "file" }, { "name": "CacheContents", "type": "array", "required": true, "description": "CacheType 对应类型下的匹配内容： all 时填充 * file 时填充后缀名，如 jpg、txt directory 时填充路径，如 /xxx/test path 时填充绝对路径，如 /xxx/test.html index 时填充 /", "example": "jpg", "item_type": "string" }, { "name": "CacheTime", "type": "integer", "required": true, "description": "缓存过期时间设置 单位为秒，最大可设置为 365 天", "example": "3600" } ] }, { "name": "FollowOrigin", "type": "string", "required": true, "description": "遵循源站 Cache-Control: max-age 配置 on：开启 off：关闭 开启后，未能匹配 CacheRules 规则的资源将根据源站返回的 max-age 值进行节点缓存；匹配了 CacheRules 规则的资源将按照 CacheRules 中设置的缓存过期时间在节点进行缓存 与 CompareMaxAge 冲突，不能同时开启 注意：此字段可能返回 null，表示取不到有效值。", "example": "on" }, { "name": "IgnoreCacheControl", "type": "string", "required": true, "description": "强制缓存 on：开启 off：关闭 默认为关闭状态，开启后，源站返回的 no-store、no-cache 资源，也将按照 CacheRules 规则进行缓存 注意：此字段可能返回 null，表示取不到有效值。", "example": "on" }, { "name": "IgnoreSetCookie", "type": "string", "required": true, "description": "忽略源站的Set-Cookie头部 on：开启 off：关闭 默认为关闭状态 注意：此字段可能返回 null，表示取不到有效值。", "example": "on" }, { "name": "CompareMaxAge", "type": "string", "required": true, "description": "高级缓存过期配置，开启时会对比源站返回的 max-age 值与 CacheRules 中设置的缓存过期时间，取最小值在节点进行缓存 on：开启 off：关闭 默认为关闭状态 注意：此字段可能返回 null，表示取不到有效值。", "example": "on" }, { "name": "Revalidate", "type": "object", "required": false, "description": "总是回源站校验 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "总是回源校验配置开关，取值有： on：开启 off：关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" }, { "name": "Path", "type": "string", "required": false, "description": "只在特定请求路径回源站校验 注意：此字段可能返回 null，表示取不到有效值。", "example": "/data" } ] } ] }, { "name": "AdvancedCache", "type": "object", "required": false, "description": "高级缓存过期时间配置（已弃用） 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "CacheRules", "type": "array", "required": true, "description": "缓存过期规则 注意：此字段可能返回 null，表示取不到有效值。", "example": "暂无", "item_type": "object", "children": [ { "name": "CacheType", "type": "string", "required": true, "description": "规则类型： all：所有文件生效 file：指定文件后缀生效 directory：指定路径生效 path：指定绝对路径生效 default：源站未返回 max-age 情况下的缓存规则 注意：此字段可能返回 null，表示取不到有效值。", "example": "file" }, { "name": "CacheContents", "type": "array", "required": true, "description": "对应类型下的匹配内容： all 时填充 * file 时填充后缀名，如 jpg、txt directory 时填充路径，如 /xxx/test/ path 时填充绝对路径，如 /xxx/test.html default 时填充 \"no max-age\" 注意：此字段可能返回 null，表示取不到有效值。", "example": "jpg", "item_type": "string" }, { "name": "CacheTime", "type": "integer", "required": true, "description": "缓存过期时间 单位为秒，最大可设置为 365 天 注意：此字段可能返回 null，表示取不到有效值。", "example": "60" } ] }, { "name": "IgnoreCacheControl", "type": "string", "required": true, "description": "强制缓存配置 on：开启 off：关闭 开启时，源站返回 no-cache、no-store 头部时，仍按照缓存过期规则进行节点缓存 默认为关闭状态 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" }, { "name": "IgnoreSetCookie", "type": "string", "required": true, "description": "当源站返回Set-Cookie头部时，节点是否缓存该头部及body on：开启，不缓存该头部及body off：关闭，遵循用户自定义的节点缓存规则 默认为关闭状态 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" } ] }, { "name": "RuleCache", "type": "array", "required": false, "description": "高级路径缓存配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "RulePaths", "type": "array", "required": true, "description": "CacheType 对应类型下的匹配内容： all 时填充 * file 时填充后缀名，如 jpg、txt directory 时填充路径，如 /xxx/test path 时填充绝对路径，如 /xxx/test.html index 时填充 / 注意：此字段可能返回 null，表示取不到有效值。", "example": "jpg", "item_type": "string" }, { "name": "RuleType", "type": "string", "required": true, "description": "规则类型： all：所有文件生效 file：指定文件后缀生效 directory：指定路径生效 path：指定绝对路径生效 index：首页 注意：此字段可能返回 null，表示取不到有效值。", "example": "file" }, { "name": "CacheConfig", "type": "object", "required": true, "description": "缓存配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "{\"Cache\":{\"CacheTime\":86400,\"CompareMaxAge\":\"off\",\"IgnoreCacheCo", "children": [ { "name": "Cache", "type": "object", "required": true, "description": "缓存配置 注意：此字段可能返回 null，表示取不到有效值。" }, { "name": "NoCache", "type": "object", "required": true, "description": "不缓存配置 注意：此字段可能返回 null，表示取不到有效值。" }, { "name": "FollowOrigin", "type": "object", "required": true, "description": "遵循源站配置 注意：此字段可能返回 null，表示取不到有效值。" } ] } ] } ] }, { "name": "OriginPullOptimization", "type": "object", "required": false, "description": "跨国链路优化配置", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "跨国回源优化配置开关，取值有： on：开启 off：关闭", "example": "on" }, { "name": "OptimizationType", "type": "string", "required": false, "description": "跨国类型 OVToCN：境外回源境内 CNToOV：境内回源境外 注意：此字段可能返回 null，表示取不到有效值。", "example": "OVToCN" } ] }, { "name": "Https", "type": "object", "required": false, "description": "Https 加速配置", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "https 配置开关，取值有： on：开启 off：关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "on" }, { "name": "Http2", "type": "string", "required": false, "description": "http2 配置开关 on：开启 off：关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "on" }, { "name": "OcspStapling", "type": "string", "required": false, "description": "OCSP 配置开关 on：开启 off：关闭 默认为关闭状态 注意：此字段可能返回 null，表示取不到有效值。", "example": "on" }, { "name": "VerifyClient", "type": "string", "required": false, "description": "客户端证书校验功能 on：开启 off：关闭 默认为关闭状态，开启时需要上传客户端证书信息，该配置项目前在灰度中，尚未全量 注意：此字段可能返回 null，表示取不到有效值。", "example": "on" }, { "name": "CertInfo", "type": "object", "required": false, "description": "服务端证书配置信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "CertId", "type": "string", "required": false, "description": "服务器证书 ID 在 SSL 证书管理进行证书托管时自动生成 注意：此字段可能返回 null，表示取不到有效值。", "example": "LE-dsfdsf" }, { "name": "CertName", "type": "string", "required": false, "description": "服务器证书名称 在 SSL 证书管理进行证书托管时自动生成 注意：此字段可能返回 null，表示取不到有效值。", "example": "aa.com" }, { "name": "Certificate", "type": "string", "required": false, "description": "服务器证书信息 上传自有证书时必填，需要包含完整的证书链 注意：此字段可能返回 null，表示取不到有效值。", "example": "不展示" }, { "name": "PrivateKey", "type": "string", "required": false, "description": "服务器密钥信息 上传自有证书时必填 注意：此字段可能返回 null，表示取不到有效值。", "example": "不展示" }, { "name": "ExpireTime", "type": "string", "required": false, "description": "证书过期时间 作为入参配置时无需填充 注意：此字段可能返回 null，表示取不到有效值。", "example": "2021-12-01 09:48:19" }, { "name": "DeployTime", "type": "string", "required": false, "description": "证书颁发时间 作为入参配置时无需填充 注意：此字段可能返回 null，表示取不到有效值。", "example": "2021-12-01 09:48:19" }, { "name": "Message", "type": "string", "required": false, "description": "证书备注信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "备注" }, { "name": "From", "type": "string", "required": false, "description": "证书来源 注意：此字段可能返回 null，表示取不到有效值。", "example": "upload" } ] }, { "name": "ClientCertInfo", "type": "object", "required": false, "description": "客户端证书配置信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Certificate", "type": "string", "required": true, "description": "客户端证书 PEM 格式，需要进行 Base 64 编码 注意：此字段可能返回 null，表示取不到有效值。", "example": "Certificate" }, { "name": "CertName", "type": "string", "required": false, "description": "客户端证书名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "qq.com" }, { "name": "ExpireTime", "type": "string", "required": false, "description": "证书过期时间 作为入参时无需填充 注意：此字段可能返回 null，表示取不到有效值。", "example": "2025-06-28 11:38:2" }, { "name": "DeployTime", "type": "string", "required": false, "description": "证书颁发时间 作为入参时无需填充 注意：此字段可能返回 null，表示取不到有效值。", "example": "2023-06-28 11:38:20" } ] }, { "name": "Spdy", "type": "string", "required": false, "description": "Spdy 配置开关 on：开启 off：关闭 默认为关闭状态 注意：此字段可能返回 null，表示取不到有效值。", "example": "on" }, { "name": "SslStatus", "type": "string", "required": false, "description": "https 证书部署状态 closed：已关闭 deploying：部署中 deployed：部署成功 failed：部署失败 注意：此字段可能返回 null，表示取不到有效值。", "example": "closed" }, { "name": "Hsts", "type": "object", "required": false, "description": "Hsts配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "HSTS 配置开关，取值有： on：开启 off：关闭", "example": "off" }, { "name": "MaxAge", "type": "integer", "required": false, "description": "MaxAge数值。 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "IncludeSubDomains", "type": "string", "required": false, "description": "是否包含子域名，on或off。 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" } ] }, { "name": "TlsVersion", "type": "array", "required": false, "description": "Tls版本设置，仅支持部分Advance域名，支持设置 TLSv1, TLSv1.1, TLSv1.2, TLSv1.3，修改时必须开启连续的版本 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"TLSv1\"]", "item_type": "string" } ] }, { "name": "Authentication", "type": "object", "required": false, "description": "时间戳防盗链配置", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "防盗链配置开关，取值有： on：开启 off：关闭 开启时必须且只配置一种模式，其余模式需要设置为 null", "example": "off" }, { "name": "AuthAlgorithm", "type": "string", "required": false, "description": "鉴权算法，取值有： md5：按MD5算法取hash值 sha256：按SHA-256算法取hash值 默认为 md5 注意：此字段可能返回 null，表示取不到有效值。", "example": "md5" }, { "name": "TypeA", "type": "object", "required": false, "description": "时间戳防盗链模式 A 配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "SecretKey", "type": "string", "required": true, "description": "计算签名的密钥 仅允许大小写字母与数字，长度 6~32 位 注意：此字段可能返回 null，表示取不到有效值。", "example": "exmaple-secretkey" }, { "name": "SignParam", "type": "string", "required": true, "description": "签名参数名设置 仅允许大小写字母、数字或下划线，长度 1~100 位，不能以数字开头", "example": "s" }, { "name": "ExpireTime", "type": "integer", "required": true, "description": "签名过期时间设置 单位为秒，最大可设置为 630720000", "example": "7200" }, { "name": "FileExtensions", "type": "array", "required": true, "description": "鉴权/不做鉴权的文件扩展名列表设置 如果包含字符 * 则表示所有文件", "example": "[\"*\"]", "item_type": "string" }, { "name": "FilterType", "type": "string", "required": true, "description": "whitelist：白名单，表示对除了 FileExtensions 列表之外的所有类型进行鉴权 blacklist：黑名单，表示仅对 FileExtensions 中的类型进行鉴权", "example": "whitelist" }, { "name": "BackupSecretKey", "type": "string", "required": false, "description": "计算签名的备用密钥 仅允许大小写字母与数字，长度 6~32 位 注意：此字段可能返回 null，表示取不到有效值。", "example": "exmaple-backup-secretkey" } ] }, { "name": "TypeB", "type": "object", "required": false, "description": "时间戳防盗链模式 B 配置（模式 B 后台升级中，暂时不支持配置） 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "SecretKey", "type": "string", "required": true, "description": "计算签名的密钥 仅允许大小写字母与数字，长度 6~32 位 注意：此字段可能返回 null，表示取不到有效值。", "example": "exmaple-secretkey" }, { "name": "ExpireTime", "type": "integer", "required": true, "description": "签名过期时间设置 单位为秒，最大可设置为 630720000", "example": "7200" }, { "name": "FileExtensions", "type": "array", "required": true, "description": "鉴权/不做鉴权的文件扩展名列表设置 如果包含字符 * 则表示所有文件", "example": "[\"*\"]", "item_type": "string" }, { "name": "FilterType", "type": "string", "required": true, "description": "whitelist：白名单，表示对除了 FileExtensions 列表之外的所有类型进行鉴权 blacklist：黑名单，表示仅对 FileExtensions 中的类型进行鉴权", "example": "whitelist" }, { "name": "BackupSecretKey", "type": "string", "required": false, "description": "计算签名的备用密钥 仅允许大小写字母与数字，长度 6~32 位 注意：此字段可能返回 null，表示取不到有效值。", "example": "exmaple-backup-secretkey" } ] }, { "name": "TypeC", "type": "object", "required": false, "description": "时间戳防盗链模式 C 配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "SecretKey", "type": "string", "required": true, "description": "计算签名的密钥 仅允许大小写字母与数字，长度 6~32 位 注意：此字段可能返回 null，表示取不到有效值。", "example": "exmaple-secretkey" }, { "name": "ExpireTime", "type": "integer", "required": true, "description": "签名过期时间设置 单位为秒，最大可设置为 630720000", "example": "7200" }, { "name": "FileExtensions", "type": "array", "required": true, "description": "鉴权/不做鉴权的文件扩展名列表设置 如果包含字符 * 则表示所有文件", "example": "[\"*\"]", "item_type": "string" }, { "name": "FilterType", "type": "string", "required": true, "description": "whitelist：白名单，表示对除了 FileExtensions 列表之外的所有类型进行鉴权 blacklist：黑名单，表示仅对 FileExtensions 中的类型进行鉴权", "example": "whitelist" }, { "name": "TimeFormat", "type": "string", "required": false, "description": "时间戳进制设置 dec：十进制 hex：十六进制 注意：此字段可能返回 null，表示取不到有效值。", "example": "dec" }, { "name": "BackupSecretKey", "type": "string", "required": false, "description": "计算签名的备用密钥 仅允许大小写字母与数字，长度 6~32 位 注意：此字段可能返回 null，表示取不到有效值。", "example": "exmaple-backp-secretkey" } ] }, { "name": "TypeD", "type": "object", "required": false, "description": "时间戳防盗链模式 D 配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "SecretKey", "type": "string", "required": true, "description": "计算签名的密钥 仅允许大小写字母与数字，长度 6~32 位 注意：此字段可能返回 null，表示取不到有效值。", "example": "exmaple-secretkey" }, { "name": "ExpireTime", "type": "integer", "required": true, "description": "签名过期时间设置 单位为秒，最大可设置为 630720000", "example": "7200" }, { "name": "FileExtensions", "type": "array", "required": true, "description": "鉴权/不做鉴权的文件扩展名列表设置 如果包含字符 * 则表示所有文件", "example": "[\"*\"]", "item_type": "string" }, { "name": "FilterType", "type": "string", "required": true, "description": "whitelist：白名单，表示对除了 FileExtensions 列表之外的所有类型进行鉴权 blacklist：黑名单，表示仅对 FileExtensions 中的类型进行鉴权", "example": "whitelist" }, { "name": "SignParam", "type": "string", "required": true, "description": "签名参数名设置 仅允许大小写字母、数字或下划线，长度 1~100 位，不能以数字开头", "example": "e" }, { "name": "TimeParam", "type": "string", "required": true, "description": "时间戳参数名设置 仅允许大小写字母、数字或下划线，长度 1~100 位，不能以数字开头", "example": "tp" }, { "name": "TimeFormat", "type": "string", "required": true, "description": "时间戳进制设置 dec：十进制 hex：十六进制", "example": "dec" }, { "name": "BackupSecretKey", "type": "string", "required": false, "description": "计算签名的备用密钥 仅允许大小写字母与数字，长度 6~32 位 注意：此字段可能返回 null，表示取不到有效值。", "example": "exmaple-backup-secretkey" } ] } ] }, { "name": "Seo", "type": "object", "required": false, "description": "SEO 优化配置", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "SEO 搜索引擎优化配置开关，取值有： on：开启 off：关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" } ] }, { "name": "ForceRedirect", "type": "object", "required": false, "description": "访问协议强制跳转配置", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "访问强制跳转配置开关，取值有： on：开启 off：关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" }, { "name": "RedirectType", "type": "string", "required": false, "description": "访问强制跳转类型 http：强制 http 跳转 https：强制 https 跳转 注意：此字段可能返回 null，表示取不到有效值。", "example": "http" }, { "name": "RedirectStatusCode", "type": "integer", "required": false, "description": "强制跳转时返回状态码 支持 301、302、307、308 注意：此字段可能返回 null，表示取不到有效值。", "example": "302" }, { "name": "CarryHeaders", "type": "string", "required": false, "description": "强制跳转时是否返回增加的头部。 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" } ] }, { "name": "Referer", "type": "object", "required": false, "description": "Referer 防盗链配置", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "referer 黑白名单配置开关，取值有： on：开启 off：关闭", "example": "off" }, { "name": "RefererRules", "type": "array", "required": false, "description": "referer 黑白名单配置规则 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "RuleType", "type": "string", "required": true, "description": "规则类型： all：所有文件生效 file：指定文件后缀生效 directory：指定路径生效 path：指定绝对路径生效", "example": "file" }, { "name": "RulePaths", "type": "array", "required": true, "description": "RuleType 对应类型下的匹配内容： all 时填充 * file 时填充后缀名，如 jpg、txt directory 时填充路径，如 /xxx/test/ path 时填充绝对路径，如 /xxx/test.html", "example": "jpg", "item_type": "string" }, { "name": "RefererType", "type": "string", "required": true, "description": "referer 配置类型 whitelist：白名单 blacklist：黑名单", "example": "whitelist" }, { "name": "Referers", "type": "array", "required": true, "description": "referer 内容列表", "example": "qq.com", "item_type": "string" }, { "name": "AllowEmpty", "type": "boolean", "required": true, "description": "是否允许空 referer 防盗链类型为白名单时，true表示允许空 referer，false表示不允许空 referer； 防盗链类型为黑名单时，true表示拒绝空referer，false表示不拒绝空referer；", "example": "true" } ] } ] }, { "name": "MaxAge", "type": "object", "required": false, "description": "浏览器缓存配置（功能灰度中，尚未全量）", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "浏览器缓存配置开关，取值有： on：开启 off：关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" }, { "name": "MaxAgeRules", "type": "array", "required": false, "description": "MaxAge 规则 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "MaxAgeType", "type": "string", "required": true, "description": "规则类型： all：所有文件生效 file：指定文件后缀生效 directory：指定路径生效 path：指定绝对路径生效 index: 指定主页生效", "example": "file" }, { "name": "MaxAgeContents", "type": "array", "required": true, "description": "MaxAgeType 对应类型下的匹配内容： all 时填充 * file 时填充后缀名，如 jpg、txt directory 时填充路径，如 /xxx/test/ path 时填充绝对路径，如 /xxx/test.html index 时填充 / 注意：all规则不可删除，默认遵循源站，可修改。", "example": "jpg", "item_type": "string" }, { "name": "MaxAgeTime", "type": "integer", "required": true, "description": "MaxAge 时间设置，单位秒 注意：时间为0，即不缓存。", "example": "3600" }, { "name": "FollowOrigin", "type": "string", "required": false, "description": "是否遵循源站，on或off，开启时忽略时间设置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "on" } ] }, { "name": "MaxAgeCodeRule", "type": "object", "required": false, "description": "MaxAge 状态码相关规则 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Action", "type": "string", "required": true, "description": "处理动作 clear：清除 cache-control 头部", "example": "clear" }, { "name": "StatusCodes", "type": "array", "required": true, "description": "指定HTTP状态码生效，当前仅支持填写\"400-599\"", "example": "[\"400-599\"]", "item_type": "string" } ] } ] }, { "name": "Ipv6", "type": "object", "required": false, "description": "Ipv6 配置（功能灰度中，尚未全量）", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "域名开启源站ipv6配置开关，取值有： on：开启 off：关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" } ] }, { "name": "SpecificConfig", "type": "object", "required": false, "description": "地域属性特殊配置 适用于域名境内加速、境外加速配置不一致场景", "example": "无", "children": [ { "name": "Mainland", "type": "object", "required": false, "description": "国内特殊配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "null", "children": [ { "name": "Authentication", "type": "object", "required": false, "description": "时间戳防盗链配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "防盗链配置开关，取值有： on：开启 off：关闭 开启时必须且只配置一种模式，其余模式需要设置为 null", "example": "off" }, { "name": "AuthAlgorithm", "type": "string", "required": false, "description": "鉴权算法，取值有： md5：按MD5算法取hash值 sha256：按SHA-256算法取hash值 默认为 md5 注意：此字段可能返回 null，表示取不到有效值。", "example": "md5" }, { "name": "TypeA", "type": "object", "required": false, "description": "时间戳防盗链模式 A 配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "TypeB", "type": "object", "required": false, "description": "时间戳防盗链模式 B 配置（模式 B 后台升级中，暂时不支持配置） 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "TypeC", "type": "object", "required": false, "description": "时间戳防盗链模式 C 配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "TypeD", "type": "object", "required": false, "description": "时间戳防盗链模式 D 配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" } ] }, { "name": "BandwidthAlert", "type": "object", "required": false, "description": "带宽封顶配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "用量封顶配置开关，取值有： on：开启 off：关闭", "example": "off" }, { "name": "BpsThreshold", "type": "integer", "required": false, "description": "用量封顶阈值，带宽单位为bps，流量单位byte 注意：此字段可能返回 null，表示取不到有效值。", "example": "1000000" }, { "name": "CounterMeasure", "type": "string", "required": false, "description": "达到阈值后的操作 RETURN_404：全部请求返回 404 注意：此字段可能返回 null，表示取不到有效值。", "example": "RETURN_404" }, { "name": "LastTriggerTime", "type": "string", "required": false, "description": "境内区域上次触发用量封顶阈值的时间 注意：此字段可能返回 null，表示取不到有效值。", "example": "2023-06-28 12:00:00" }, { "name": "AlertSwitch", "type": "string", "required": false, "description": "用量封顶提醒配置开关，取值有： on：开启 off：关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" }, { "name": "AlertPercentage", "type": "integer", "required": false, "description": "用量封顶阈值提醒百分比 注意：此字段可能返回 null，表示取不到有效值。", "example": "80" }, { "name": "LastTriggerTimeOverseas", "type": "string", "required": false, "description": "海外区域上次触发用量封顶阈值的时间 注意：此字段可能返回 null，表示取不到有效值。", "example": "2023-06-28 12:00:00" }, { "name": "Metric", "type": "string", "required": false, "description": "用量阈值触发的维度 带宽：bandwidth 流量：flux 注意：此字段可能返回 null，表示取不到有效值。", "example": "bandwith" }, { "name": "StatisticItems", "type": "array", "required": false, "description": "累计用量配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" } ] }, { "name": "Cache", "type": "object", "required": false, "description": "缓存规则配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "SimpleCache", "type": "object", "required": false, "description": "基础缓存过期时间配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "AdvancedCache", "type": "object", "required": false, "description": "高级缓存过期时间配置（已弃用） 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "RuleCache", "type": "array", "required": false, "description": "高级路径缓存配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" } ] }, { "name": "CacheKey", "type": "object", "required": false, "description": "缓存相关配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "FullUrlCache", "type": "string", "required": false, "description": "是否开启全路径缓存 on：开启全路径缓存（即关闭参数忽略） off：关闭全路径缓存（即开启参数忽略）", "example": "off" }, { "name": "IgnoreCase", "type": "string", "required": false, "description": "是否忽略大小写缓存 on：开启 off：关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" }, { "name": "QueryString", "type": "object", "required": false, "description": "CacheKey中包含请求参数 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "Cookie", "type": "object", "required": false, "description": "CacheKey中包含Cookie 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "Header", "type": "object", "required": false, "description": "CacheKey中包含请求头部 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "CacheTag", "type": "object", "required": false, "description": "CacheKey中包含自定义字符串 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "Scheme", "type": "object", "required": false, "description": "CacheKey中包含请求协议 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "KeyRules", "type": "array", "required": false, "description": "分路径缓存键配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" } ] }, { "name": "Compression", "type": "object", "required": false, "description": "智能压缩配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "智能压缩配置开关，取值有： on：开启 off：关闭", "example": "on" }, { "name": "CompressionRules", "type": "array", "required": false, "description": "压缩规则数组 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" } ] }, { "name": "DownstreamCapping", "type": "object", "required": false, "description": "下载限速配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "下行速度配置开关，取值有： on：开启 off：关闭", "example": "off" }, { "name": "CappingRules", "type": "array", "required": false, "description": "下行限速规则 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" } ] }, { "name": "ErrorPage", "type": "object", "required": false, "description": "错误码重定向配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "状态码重定向配置开关，取值有： on：开启 off：关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" }, { "name": "PageRules", "type": "array", "required": false, "description": "状态码重定向规则配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" } ] }, { "name": "FollowRedirect", "type": "object", "required": false, "description": "301和302自动回源跟随配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "回源跟随配置开关，取值有： on：开启 off：关闭", "example": "off" }, { "name": "RedirectConfig", "type": "object", "required": false, "description": "自定义回源302 follow请求host配置，该功能为白名单功能，需要开启请联系腾讯云工程师。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" } ] }, { "name": "ForceRedirect", "type": "object", "required": false, "description": "访问协议强制跳转配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "访问强制跳转配置开关，取值有： on：开启 off：关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" }, { "name": "RedirectType", "type": "string", "required": false, "description": "访问强制跳转类型 http：强制 http 跳转 https：强制 https 跳转 注意：此字段可能返回 null，表示取不到有效值。", "example": "http" }, { "name": "RedirectStatusCode", "type": "integer", "required": false, "description": "强制跳转时返回状态码 支持 301、302、307、308 注意：此字段可能返回 null，表示取不到有效值。", "example": "302" }, { "name": "CarryHeaders", "type": "string", "required": false, "description": "强制跳转时是否返回增加的头部。 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" } ] }, { "name": "Https", "type": "object", "required": false, "description": "Https配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "https 配置开关，取值有： on：开启 off：关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "on" }, { "name": "Http2", "type": "string", "required": false, "description": "http2 配置开关 on：开启 off：关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "on" }, { "name": "OcspStapling", "type": "string", "required": false, "description": "OCSP 配置开关 on：开启 off：关闭 默认为关闭状态 注意：此字段可能返回 null，表示取不到有效值。", "example": "on" }, { "name": "VerifyClient", "type": "string", "required": false, "description": "客户端证书校验功能 on：开启 off：关闭 默认为关闭状态，开启时需要上传客户端证书信息，该配置项目前在灰度中，尚未全量 注意：此字段可能返回 null，表示取不到有效值。", "example": "on" }, { "name": "CertInfo", "type": "object", "required": false, "description": "服务端证书配置信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "ClientCertInfo", "type": "object", "required": false, "description": "客户端证书配置信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "Spdy", "type": "string", "required": false, "description": "Spdy 配置开关 on：开启 off：关闭 默认为关闭状态 注意：此字段可能返回 null，表示取不到有效值。", "example": "on" }, { "name": "SslStatus", "type": "string", "required": false, "description": "https 证书部署状态 closed：已关闭 deploying：部署中 deployed：部署成功 failed：部署失败 注意：此字段可能返回 null，表示取不到有效值。", "example": "closed" }, { "name": "Hsts", "type": "object", "required": false, "description": "Hsts配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "TlsVersion", "type": "array", "required": false, "description": "Tls版本设置，仅支持部分Advance域名，支持设置 TLSv1, TLSv1.1, TLSv1.2, TLSv1.3，修改时必须开启连续的版本 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"TLSv1\"]", "item_type": "string" } ] }, { "name": "IpFilter", "type": "object", "required": false, "description": "IP黑白名单配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "IP 黑白名单配置开关，取值有 on：开启 off：关闭", "example": "on" }, { "name": "FilterType", "type": "string", "required": false, "description": "IP 黑白名单类型 whitelist：白名单 blacklist：黑名单 注意：此字段可能返回 null，表示取不到有效值。", "example": "blacklist" }, { "name": "Filters", "type": "array", "required": false, "description": "IP 黑白名单列表 支持 X.X.X.X 格式IPV4地址 或X:X:X:X:X:X:X:X 格式IPV6地址， 或网段格式/X（IPV4:1≤X≤32；IPV6:1≤X≤128） 最多可填充 200 个白名单或 200 个黑名单； 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"1.1.1.1\"]", "item_type": "string" }, { "name": "FilterRules", "type": "array", "required": false, "description": "IP 黑白名单分路径配置。黑白名单 IP 总数不能超过 1000 个。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "ReturnCode", "type": "integer", "required": false, "description": "IP 黑白名单验证失败时返回的状态码。 注意： 请求拒绝时，平台默认响应514状态。 支持自定义为403，404，609状态码，空值时或自定义的不在范围内，均默认为514. 非514状态码将计入HTTPS计费统计，最终账单将按您的计费规则生成。 若您开启了自定义状态码，则默认您认同HTTPS计费规则。 注意：此字段可能返回 null，表示取不到有效值。", "example": "514" } ] }, { "name": "IpFreqLimit", "type": "object", "required": false, "description": "IP限频配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "IP 限频配置开关，取值有： on：开启 off：关闭", "example": "off" }, { "name": "Qps", "type": "integer", "required": false, "description": "设置每秒请求数限制 超出限制的请求会直接返回 514 注意：此字段可能返回 null，表示取不到有效值。", "example": "20" } ] }, { "name": "MaxAge", "type": "object", "required": false, "description": "浏览器缓存规则配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "浏览器缓存配置开关，取值有： on：开启 off：关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" }, { "name": "MaxAgeRules", "type": "array", "required": false, "description": "MaxAge 规则 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "MaxAgeCodeRule", "type": "object", "required": false, "description": "MaxAge 状态码相关规则 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" } ] }, { "name": "Origin", "type": "object", "required": false, "description": "源站配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Origins", "type": "array", "required": false, "description": "主源站列表 修改源站时，需要同时填充对应的 OriginType 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"1.1.1.1\"]", "item_type": "string" }, { "name": "OriginType", "type": "string", "required": false, "description": "主源站类型 当源站列表 Origins 不为空时必填 入参支持以下几种类型： domain：域名类型 domainv6：域名解析V6类型 cos：对象存储源站 third_party: 第三方存储源站 igtm: IGTM多活源 ip：IP 列表作为源站 ipv6：源站列表为一个单独的 IPv6 地址 ip_ipv6：源站列表为多个 IPv4 地址和IPv6 地址 ip_domain: 支持IP和域名形式源站混填（白名单功能） ip_domainv6：源站列表为多个 IPv4 地址以及域名解析v6地...", "example": "ip" }, { "name": "ServerName", "type": "string", "required": false, "description": "回主源站时 Host 头部 当源站类型为cos或者第三方存储加速时,ServerName字段必填 不填充则默认为加速域名 若接入的是泛域名，则回源 Host 默认为访问时的子域名 注意：此字段可能返回 null，表示取不到有效值。", "example": "www.test.com" }, { "name": "CosPrivateAccess", "type": "string", "required": false, "description": "OriginType 为对象存储（COS）时，可以指定是否允许访问私有 bucket 注意：需要先授权 CDN 访问该私有 Bucket 的权限后，才可开启此配置。取值范围: on/off 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" }, { "name": "OriginPullProtocol", "type": "string", "required": false, "description": "回源协议配置 http：强制 http 回源 follow：协议跟随回源 https：强制 https 回源 注意：此字段可能返回 null，表示取不到有效值。", "example": "http" }, { "name": "BackupOrigins", "type": "array", "required": false, "description": "备源站列表 修改备源站时，需要同时填充对应的 BackupOriginType 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"2.2.2.2\"]", "item_type": "string" }, { "name": "BackupOriginType", "type": "string", "required": false, "description": "备源站类型 备源站列表BackupOrigins 不为空时必填 支持以下类型： domain：域名类型 ip：IP 列表作为源站 以下备源源站类型尚未全量支持，需要申请试用： ipv6_domain: 源站列表为多个 IPv6 地址以及域名 ip_ipv6：源站列表为多个 IPv4 地址和IPv6 地址 ip_ipv6_domain：源站列表为多个 IPv4 地址IPv6 地址以及域名 注意：此字段可能返回 null，表示取不到有效值。", "example": "ip" }, { "name": "BackupServerName", "type": "string", "required": false, "description": "回备源站时 Host 头部，不填充则默认为主源站的 ServerName 注意：此字段可能返回 null，表示取不到有效值。", "example": "www.test2.com" }, { "name": "BasePath", "type": "string", "required": false, "description": "回源路径 注意：此字段可能返回 null，表示取不到有效值。", "example": "/data" }, { "name": "PathRules", "type": "array", "required": false, "description": "回源路径重写规则配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "PathBasedOrigin", "type": "array", "required": false, "description": "分路径回源配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "Sni", "type": "object", "required": false, "description": "HTTPS回源SNI配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "AdvanceHttps", "type": "object", "required": false, "description": "HTTPS回源高级配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "OriginCompany", "type": "string", "required": false, "description": "对象存储回源厂商 当源站类型为第三方存储源站(third_party)时必填 可选值包括以下: aws_s3: AWS S3 ali_oss: 阿里云 OSS hw_obs: 华为 OBS qiniu_kodo: 七牛云 kodo others: 其它厂商对象存储,仅支持兼容以AWS签名算法的对象存储，如腾讯云金融专区COS 注意：此字段可能返回 null，表示取不到有效值。", "example": "hw-oss" } ] }, { "name": "OriginPullOptimization", "type": "object", "required": false, "description": "跨国优化配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "跨国回源优化配置开关，取值有： on：开启 off：关闭", "example": "on" }, { "name": "OptimizationType", "type": "string", "required": false, "description": "跨国类型 OVToCN：境外回源境内 CNToOV：境内回源境外 注意：此字段可能返回 null，表示取不到有效值。", "example": "OVToCN" } ] }, { "name": "RangeOriginPull", "type": "object", "required": false, "description": "Range回源配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "分片回源配置开关，取值有： on：开启 off：关闭", "example": "on" }, { "name": "RangeRules", "type": "array", "required": false, "description": "分路径分片回源配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "[{\"Switch\":\"on\",\"RuleType\":\"file\",\"RulePaths\":[\"jpg\"]}]", "item_type": "string" } ] }, { "name": "Referer", "type": "object", "required": false, "description": "防盗链配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "referer 黑白名单配置开关，取值有： on：开启 off：关闭", "example": "off" }, { "name": "RefererRules", "type": "array", "required": false, "description": "referer 黑白名单配置规则 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" } ] }, { "name": "RequestHeader", "type": "object", "required": false, "description": "回源请求头部配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "自定义请求头配置开关，取值有： on：开启 off：关闭", "example": "off" }, { "name": "HeaderRules", "type": "array", "required": false, "description": "自定义请求头配置规则 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" } ] }, { "name": "ResponseHeader", "type": "object", "required": false, "description": "源站响应头部配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "自定义响应头配置开关，取值有： on：开启 off：关闭", "example": "off" }, { "name": "HeaderRules", "type": "array", "required": false, "description": "自定义响应头规则 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" } ] }, { "name": "ResponseHeaderCache", "type": "object", "required": false, "description": "遵循源站缓存头部配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "源站头部缓存配置开关，取值有： on：开启 off：关闭", "example": "off" } ] }, { "name": "Seo", "type": "object", "required": false, "description": "seo优化配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "SEO 搜索引擎优化配置开关，取值有： on：开启 off：关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" } ] }, { "name": "ServiceType", "type": "string", "required": false, "description": "域名业务类型，web，download，media分别表示静态加速，下载加速和流媒体加速。 注意：此字段可能返回 null，表示取不到有效值。", "example": "web" }, { "name": "StatusCodeCache", "type": "object", "required": false, "description": "状态码缓存配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "状态码缓存过期配置开关，取值有： on：开启 off：关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" }, { "name": "CacheRules", "type": "array", "required": false, "description": "状态码缓存过期规则明细 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" } ] }, { "name": "VideoSeek", "type": "object", "required": false, "description": "视频拖拽配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "视频拖拽配置开关，取值有： on：开启 off：关闭", "example": "off" } ] }, { "name": "AwsPrivateAccess", "type": "object", "required": false, "description": "回源S3私有鉴权。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "s3源站回源鉴权配置项开关，取值有： on：开启 off：关闭", "example": "on" }, { "name": "AccessKey", "type": "string", "required": false, "description": "访问ID。 注意：此字段可能返回 null，表示取不到有效值。", "example": "dfss12nk" }, { "name": "SecretKey", "type": "string", "required": false, "description": "密钥，字段为脱敏返回。 注意：此字段可能返回 null，表示取不到有效值。", "example": "wn***************mg" }, { "name": "Region", "type": "string", "required": false, "description": "地域 注意：此字段可能返回 null，表示取不到有效值。", "example": "gz" }, { "name": "Bucket", "type": "string", "required": false, "description": "Bucketname 注意：此字段可能返回 null，表示取不到有效值。", "example": "hw-oss" } ] }, { "name": "OssPrivateAccess", "type": "object", "required": false, "description": "回源OSS私有鉴权。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "oss回源鉴权配置开关，取值有： on：开启 off：关闭", "example": "on" }, { "name": "AccessKey", "type": "string", "required": false, "description": "访问ID。 注意：此字段可能返回 null，表示取不到有效值。", "example": "AKkjqrfjaoidn" }, { "name": "SecretKey", "type": "string", "required": false, "description": "密钥，字段为脱敏返回。 注意：此字段可能返回 null，表示取不到有效值。", "example": "wn***************mg\t" }, { "name": "Region", "type": "string", "required": false, "description": "地域 注意：此字段可能返回 null，表示取不到有效值。", "example": "gz" }, { "name": "Bucket", "type": "string", "required": false, "description": "Bucketname 注意：此字段可能返回 null，表示取不到有效值。", "example": "hw-oss" } ] }, { "name": "HwPrivateAccess", "type": "object", "required": false, "description": "华为云对象存储回源鉴权 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "华为云对象存储回源鉴权配置开关，取值有： on：开启 off：关闭", "example": "on" }, { "name": "AccessKey", "type": "string", "required": false, "description": "访问 ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "SYWKY0DAR8I5NXZO93YT" }, { "name": "SecretKey", "type": "string", "required": false, "description": "密钥，字段为脱敏返回。 注意：此字段可能返回 null，表示取不到有效值。", "example": "wn***************mg" }, { "name": "Bucket", "type": "string", "required": false, "description": "bucketname 注意：此字段可能返回 null，表示取不到有效值。", "example": "hw-1-163" } ] }, { "name": "QnPrivateAccess", "type": "object", "required": false, "description": "七牛云对象存储回源鉴权 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "七牛元对象存储回源鉴权配置开关，取值有： on：开启 off：关闭", "example": "on" }, { "name": "AccessKey", "type": "string", "required": false, "description": "访问 ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "ousbDM5xlzuAZJEhhwcLj8makXkYiaAvciZHqAQj" }, { "name": "SecretKey", "type": "string", "required": false, "description": "密钥，字段为脱敏返回。", "example": "wn***************mg" } ] } ] }, { "name": "Overseas", "type": "object", "required": false, "description": "海外特殊配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "null", "children": [ { "name": "Authentication", "type": "object", "required": false, "description": "时间戳防盗链配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "防盗链配置开关，取值有： on：开启 off：关闭 开启时必须且只配置一种模式，其余模式需要设置为 null", "example": "off" }, { "name": "AuthAlgorithm", "type": "string", "required": false, "description": "鉴权算法，取值有： md5：按MD5算法取hash值 sha256：按SHA-256算法取hash值 默认为 md5 注意：此字段可能返回 null，表示取不到有效值。", "example": "md5" }, { "name": "TypeA", "type": "object", "required": false, "description": "时间戳防盗链模式 A 配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "TypeB", "type": "object", "required": false, "description": "时间戳防盗链模式 B 配置（模式 B 后台升级中，暂时不支持配置） 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "TypeC", "type": "object", "required": false, "description": "时间戳防盗链模式 C 配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "TypeD", "type": "object", "required": false, "description": "时间戳防盗链模式 D 配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" } ] }, { "name": "BandwidthAlert", "type": "object", "required": false, "description": "带宽封顶配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "用量封顶配置开关，取值有： on：开启 off：关闭", "example": "off" }, { "name": "BpsThreshold", "type": "integer", "required": false, "description": "用量封顶阈值，带宽单位为bps，流量单位byte 注意：此字段可能返回 null，表示取不到有效值。", "example": "1000000" }, { "name": "CounterMeasure", "type": "string", "required": false, "description": "达到阈值后的操作 RETURN_404：全部请求返回 404 注意：此字段可能返回 null，表示取不到有效值。", "example": "RETURN_404" }, { "name": "LastTriggerTime", "type": "string", "required": false, "description": "境内区域上次触发用量封顶阈值的时间 注意：此字段可能返回 null，表示取不到有效值。", "example": "2023-06-28 12:00:00" }, { "name": "AlertSwitch", "type": "string", "required": false, "description": "用量封顶提醒配置开关，取值有： on：开启 off：关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" }, { "name": "AlertPercentage", "type": "integer", "required": false, "description": "用量封顶阈值提醒百分比 注意：此字段可能返回 null，表示取不到有效值。", "example": "80" }, { "name": "LastTriggerTimeOverseas", "type": "string", "required": false, "description": "海外区域上次触发用量封顶阈值的时间 注意：此字段可能返回 null，表示取不到有效值。", "example": "2023-06-28 12:00:00" }, { "name": "Metric", "type": "string", "required": false, "description": "用量阈值触发的维度 带宽：bandwidth 流量：flux 注意：此字段可能返回 null，表示取不到有效值。", "example": "bandwith" }, { "name": "StatisticItems", "type": "array", "required": false, "description": "累计用量配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" } ] }, { "name": "Cache", "type": "object", "required": false, "description": "缓存规则配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "SimpleCache", "type": "object", "required": false, "description": "基础缓存过期时间配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "AdvancedCache", "type": "object", "required": false, "description": "高级缓存过期时间配置（已弃用） 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "RuleCache", "type": "array", "required": false, "description": "高级路径缓存配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" } ] }, { "name": "CacheKey", "type": "object", "required": false, "description": "缓存相关配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "FullUrlCache", "type": "string", "required": false, "description": "是否开启全路径缓存 on：开启全路径缓存（即关闭参数忽略） off：关闭全路径缓存（即开启参数忽略）", "example": "off" }, { "name": "IgnoreCase", "type": "string", "required": false, "description": "是否忽略大小写缓存 on：开启 off：关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" }, { "name": "QueryString", "type": "object", "required": false, "description": "CacheKey中包含请求参数 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "Cookie", "type": "object", "required": false, "description": "CacheKey中包含Cookie 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "Header", "type": "object", "required": false, "description": "CacheKey中包含请求头部 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "CacheTag", "type": "object", "required": false, "description": "CacheKey中包含自定义字符串 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "Scheme", "type": "object", "required": false, "description": "CacheKey中包含请求协议 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "KeyRules", "type": "array", "required": false, "description": "分路径缓存键配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" } ] }, { "name": "Compression", "type": "object", "required": false, "description": "智能压缩配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "智能压缩配置开关，取值有： on：开启 off：关闭", "example": "on" }, { "name": "CompressionRules", "type": "array", "required": false, "description": "压缩规则数组 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" } ] }, { "name": "DownstreamCapping", "type": "object", "required": false, "description": "下载限速配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "下行速度配置开关，取值有： on：开启 off：关闭", "example": "off" }, { "name": "CappingRules", "type": "array", "required": false, "description": "下行限速规则 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" } ] }, { "name": "ErrorPage", "type": "object", "required": false, "description": "错误码重定向配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "状态码重定向配置开关，取值有： on：开启 off：关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" }, { "name": "PageRules", "type": "array", "required": false, "description": "状态码重定向规则配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" } ] }, { "name": "FollowRedirect", "type": "object", "required": false, "description": "301和302自动回源跟随配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "回源跟随配置开关，取值有： on：开启 off：关闭", "example": "off" }, { "name": "RedirectConfig", "type": "object", "required": false, "description": "自定义回源302 follow请求host配置，该功能为白名单功能，需要开启请联系腾讯云工程师。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" } ] }, { "name": "ForceRedirect", "type": "object", "required": false, "description": "访问协议强制跳转配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "访问强制跳转配置开关，取值有： on：开启 off：关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" }, { "name": "RedirectType", "type": "string", "required": false, "description": "访问强制跳转类型 http：强制 http 跳转 https：强制 https 跳转 注意：此字段可能返回 null，表示取不到有效值。", "example": "http" }, { "name": "RedirectStatusCode", "type": "integer", "required": false, "description": "强制跳转时返回状态码 支持 301、302、307、308 注意：此字段可能返回 null，表示取不到有效值。", "example": "302" }, { "name": "CarryHeaders", "type": "string", "required": false, "description": "强制跳转时是否返回增加的头部。 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" } ] }, { "name": "Https", "type": "object", "required": false, "description": "Https配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "https 配置开关，取值有： on：开启 off：关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "on" }, { "name": "Http2", "type": "string", "required": false, "description": "http2 配置开关 on：开启 off：关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "on" }, { "name": "OcspStapling", "type": "string", "required": false, "description": "OCSP 配置开关 on：开启 off：关闭 默认为关闭状态 注意：此字段可能返回 null，表示取不到有效值。", "example": "on" }, { "name": "VerifyClient", "type": "string", "required": false, "description": "客户端证书校验功能 on：开启 off：关闭 默认为关闭状态，开启时需要上传客户端证书信息，该配置项目前在灰度中，尚未全量 注意：此字段可能返回 null，表示取不到有效值。", "example": "on" }, { "name": "CertInfo", "type": "object", "required": false, "description": "服务端证书配置信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "ClientCertInfo", "type": "object", "required": false, "description": "客户端证书配置信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "Spdy", "type": "string", "required": false, "description": "Spdy 配置开关 on：开启 off：关闭 默认为关闭状态 注意：此字段可能返回 null，表示取不到有效值。", "example": "on" }, { "name": "SslStatus", "type": "string", "required": false, "description": "https 证书部署状态 closed：已关闭 deploying：部署中 deployed：部署成功 failed：部署失败 注意：此字段可能返回 null，表示取不到有效值。", "example": "closed" }, { "name": "Hsts", "type": "object", "required": false, "description": "Hsts配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "TlsVersion", "type": "array", "required": false, "description": "Tls版本设置，仅支持部分Advance域名，支持设置 TLSv1, TLSv1.1, TLSv1.2, TLSv1.3，修改时必须开启连续的版本 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"TLSv1\"]", "item_type": "string" } ] }, { "name": "IpFilter", "type": "object", "required": false, "description": "IP黑白名单配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "IP 黑白名单配置开关，取值有 on：开启 off：关闭", "example": "on" }, { "name": "FilterType", "type": "string", "required": false, "description": "IP 黑白名单类型 whitelist：白名单 blacklist：黑名单 注意：此字段可能返回 null，表示取不到有效值。", "example": "blacklist" }, { "name": "Filters", "type": "array", "required": false, "description": "IP 黑白名单列表 支持 X.X.X.X 格式IPV4地址 或X:X:X:X:X:X:X:X 格式IPV6地址， 或网段格式/X（IPV4:1≤X≤32；IPV6:1≤X≤128） 最多可填充 200 个白名单或 200 个黑名单； 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"1.1.1.1\"]", "item_type": "string" }, { "name": "FilterRules", "type": "array", "required": false, "description": "IP 黑白名单分路径配置。黑白名单 IP 总数不能超过 1000 个。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "ReturnCode", "type": "integer", "required": false, "description": "IP 黑白名单验证失败时返回的状态码。 注意： 请求拒绝时，平台默认响应514状态。 支持自定义为403，404，609状态码，空值时或自定义的不在范围内，均默认为514. 非514状态码将计入HTTPS计费统计，最终账单将按您的计费规则生成。 若您开启了自定义状态码，则默认您认同HTTPS计费规则。 注意：此字段可能返回 null，表示取不到有效值。", "example": "514" } ] }, { "name": "IpFreqLimit", "type": "object", "required": false, "description": "IP限频配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "IP 限频配置开关，取值有： on：开启 off：关闭", "example": "off" }, { "name": "Qps", "type": "integer", "required": false, "description": "设置每秒请求数限制 超出限制的请求会直接返回 514 注意：此字段可能返回 null，表示取不到有效值。", "example": "20" } ] }, { "name": "MaxAge", "type": "object", "required": false, "description": "浏览器缓存规则配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "浏览器缓存配置开关，取值有： on：开启 off：关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" }, { "name": "MaxAgeRules", "type": "array", "required": false, "description": "MaxAge 规则 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "MaxAgeCodeRule", "type": "object", "required": false, "description": "MaxAge 状态码相关规则 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" } ] }, { "name": "Origin", "type": "object", "required": false, "description": "源站配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Origins", "type": "array", "required": false, "description": "主源站列表 修改源站时，需要同时填充对应的 OriginType 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"1.1.1.1\"]", "item_type": "string" }, { "name": "OriginType", "type": "string", "required": false, "description": "主源站类型 当源站列表 Origins 不为空时必填 入参支持以下几种类型： domain：域名类型 domainv6：域名解析V6类型 cos：对象存储源站 third_party: 第三方存储源站 igtm: IGTM多活源 ip：IP 列表作为源站 ipv6：源站列表为一个单独的 IPv6 地址 ip_ipv6：源站列表为多个 IPv4 地址和IPv6 地址 ip_domain: 支持IP和域名形式源站混填（白名单功能） ip_domainv6：源站列表为多个 IPv4 地址以及域名解析v6地...", "example": "ip" }, { "name": "ServerName", "type": "string", "required": false, "description": "回主源站时 Host 头部 当源站类型为cos或者第三方存储加速时,ServerName字段必填 不填充则默认为加速域名 若接入的是泛域名，则回源 Host 默认为访问时的子域名 注意：此字段可能返回 null，表示取不到有效值。", "example": "www.test.com" }, { "name": "CosPrivateAccess", "type": "string", "required": false, "description": "OriginType 为对象存储（COS）时，可以指定是否允许访问私有 bucket 注意：需要先授权 CDN 访问该私有 Bucket 的权限后，才可开启此配置。取值范围: on/off 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" }, { "name": "OriginPullProtocol", "type": "string", "required": false, "description": "回源协议配置 http：强制 http 回源 follow：协议跟随回源 https：强制 https 回源 注意：此字段可能返回 null，表示取不到有效值。", "example": "http" }, { "name": "BackupOrigins", "type": "array", "required": false, "description": "备源站列表 修改备源站时，需要同时填充对应的 BackupOriginType 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"2.2.2.2\"]", "item_type": "string" }, { "name": "BackupOriginType", "type": "string", "required": false, "description": "备源站类型 备源站列表BackupOrigins 不为空时必填 支持以下类型： domain：域名类型 ip：IP 列表作为源站 以下备源源站类型尚未全量支持，需要申请试用： ipv6_domain: 源站列表为多个 IPv6 地址以及域名 ip_ipv6：源站列表为多个 IPv4 地址和IPv6 地址 ip_ipv6_domain：源站列表为多个 IPv4 地址IPv6 地址以及域名 注意：此字段可能返回 null，表示取不到有效值。", "example": "ip" }, { "name": "BackupServerName", "type": "string", "required": false, "description": "回备源站时 Host 头部，不填充则默认为主源站的 ServerName 注意：此字段可能返回 null，表示取不到有效值。", "example": "www.test2.com" }, { "name": "BasePath", "type": "string", "required": false, "description": "回源路径 注意：此字段可能返回 null，表示取不到有效值。", "example": "/data" }, { "name": "PathRules", "type": "array", "required": false, "description": "回源路径重写规则配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "PathBasedOrigin", "type": "array", "required": false, "description": "分路径回源配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "Sni", "type": "object", "required": false, "description": "HTTPS回源SNI配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "AdvanceHttps", "type": "object", "required": false, "description": "HTTPS回源高级配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "OriginCompany", "type": "string", "required": false, "description": "对象存储回源厂商 当源站类型为第三方存储源站(third_party)时必填 可选值包括以下: aws_s3: AWS S3 ali_oss: 阿里云 OSS hw_obs: 华为 OBS qiniu_kodo: 七牛云 kodo others: 其它厂商对象存储,仅支持兼容以AWS签名算法的对象存储，如腾讯云金融专区COS 注意：此字段可能返回 null，表示取不到有效值。", "example": "hw-oss" } ] }, { "name": "OriginPullOptimization", "type": "object", "required": false, "description": "跨国优化配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "跨国回源优化配置开关，取值有： on：开启 off：关闭", "example": "on" }, { "name": "OptimizationType", "type": "string", "required": false, "description": "跨国类型 OVToCN：境外回源境内 CNToOV：境内回源境外 注意：此字段可能返回 null，表示取不到有效值。", "example": "OVToCN" } ] }, { "name": "RangeOriginPull", "type": "object", "required": false, "description": "Range回源配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "分片回源配置开关，取值有： on：开启 off：关闭", "example": "on" }, { "name": "RangeRules", "type": "array", "required": false, "description": "分路径分片回源配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "[{\"Switch\":\"on\",\"RuleType\":\"file\",\"RulePaths\":[\"jpg\"]}]", "item_type": "string" } ] }, { "name": "Referer", "type": "object", "required": false, "description": "防盗链配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "referer 黑白名单配置开关，取值有： on：开启 off：关闭", "example": "off" }, { "name": "RefererRules", "type": "array", "required": false, "description": "referer 黑白名单配置规则 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" } ] }, { "name": "RequestHeader", "type": "object", "required": false, "description": "回源请求头部配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "自定义请求头配置开关，取值有： on：开启 off：关闭", "example": "off" }, { "name": "HeaderRules", "type": "array", "required": false, "description": "自定义请求头配置规则 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" } ] }, { "name": "ResponseHeader", "type": "object", "required": false, "description": "源站响应头部配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "自定义响应头配置开关，取值有： on：开启 off：关闭", "example": "off" }, { "name": "HeaderRules", "type": "array", "required": false, "description": "自定义响应头规则 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" } ] }, { "name": "ResponseHeaderCache", "type": "object", "required": false, "description": "遵循源站缓存头部配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "源站头部缓存配置开关，取值有： on：开启 off：关闭", "example": "off" } ] }, { "name": "Seo", "type": "object", "required": false, "description": "seo优化配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "SEO 搜索引擎优化配置开关，取值有： on：开启 off：关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" } ] }, { "name": "ServiceType", "type": "string", "required": false, "description": "域名业务类型，web，download，media分别表示静态加速，下载加速和流媒体加速。 注意：此字段可能返回 null，表示取不到有效值。", "example": "web" }, { "name": "StatusCodeCache", "type": "object", "required": false, "description": "状态码缓存配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "状态码缓存过期配置开关，取值有： on：开启 off：关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" }, { "name": "CacheRules", "type": "array", "required": false, "description": "状态码缓存过期规则明细 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" } ] }, { "name": "VideoSeek", "type": "object", "required": false, "description": "视频拖拽配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "视频拖拽配置开关，取值有： on：开启 off：关闭", "example": "off" } ] }, { "name": "AwsPrivateAccess", "type": "object", "required": false, "description": "回源S3私有鉴权。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "s3源站回源鉴权配置项开关，取值有： on：开启 off：关闭", "example": "on" }, { "name": "AccessKey", "type": "string", "required": false, "description": "访问ID。 注意：此字段可能返回 null，表示取不到有效值。", "example": "dfss12nk" }, { "name": "SecretKey", "type": "string", "required": false, "description": "密钥，字段为脱敏返回。 注意：此字段可能返回 null，表示取不到有效值。", "example": "wn***************mg" }, { "name": "Region", "type": "string", "required": false, "description": "地域 注意：此字段可能返回 null，表示取不到有效值。", "example": "gz" }, { "name": "Bucket", "type": "string", "required": false, "description": "Bucketname 注意：此字段可能返回 null，表示取不到有效值。", "example": "hw-oss" } ] }, { "name": "OssPrivateAccess", "type": "object", "required": false, "description": "回源OSS私有鉴权。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "oss回源鉴权配置开关，取值有： on：开启 off：关闭", "example": "on" }, { "name": "AccessKey", "type": "string", "required": false, "description": "访问ID。 注意：此字段可能返回 null，表示取不到有效值。", "example": "AKkjqrfjaoidn" }, { "name": "SecretKey", "type": "string", "required": false, "description": "密钥，字段为脱敏返回。 注意：此字段可能返回 null，表示取不到有效值。", "example": "wn***************mg\t" }, { "name": "Region", "type": "string", "required": false, "description": "地域 注意：此字段可能返回 null，表示取不到有效值。", "example": "gz" }, { "name": "Bucket", "type": "string", "required": false, "description": "Bucketname 注意：此字段可能返回 null，表示取不到有效值。", "example": "hw-oss" } ] }, { "name": "HwPrivateAccess", "type": "object", "required": false, "description": "华为云对象存储鉴权 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "华为云对象存储回源鉴权配置开关，取值有： on：开启 off：关闭", "example": "on" }, { "name": "AccessKey", "type": "string", "required": false, "description": "访问 ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "SYWKY0DAR8I5NXZO93YT" }, { "name": "SecretKey", "type": "string", "required": false, "description": "密钥，字段为脱敏返回。 注意：此字段可能返回 null，表示取不到有效值。", "example": "wn***************mg" }, { "name": "Bucket", "type": "string", "required": false, "description": "bucketname 注意：此字段可能返回 null，表示取不到有效值。", "example": "hw-1-163" } ] }, { "name": "QnPrivateAccess", "type": "object", "required": false, "description": "七牛云对象存储鉴权 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "七牛元对象存储回源鉴权配置开关，取值有： on：开启 off：关闭", "example": "on" }, { "name": "AccessKey", "type": "string", "required": false, "description": "访问 ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "ousbDM5xlzuAZJEhhwcLj8makXkYiaAvciZHqAQj" }, { "name": "SecretKey", "type": "string", "required": false, "description": "密钥，字段为脱敏返回。", "example": "wn***************mg" } ] } ] } ] }, { "name": "Area", "type": "string", "required": false, "description": "域名加速区域 mainland：中国境内加速 overseas：中国境外加速 global：全球加速 使用中国境外加速、全球加速时，需要先开通中国境外加速服务", "example": "mainland" }, { "name": "OriginPullTimeout", "type": "object", "required": false, "description": "回源超时配置", "example": "无", "children": [ { "name": "ConnectTimeout", "type": "integer", "required": true, "description": "回源建连超时时间，单位为秒，要求5~60之间 注意：此字段可能返回 null，表示取不到有效值。", "example": "5" }, { "name": "ReceiveTimeout", "type": "integer", "required": true, "description": "回源接收超时时间，单位为秒，要求10 ~ 300之间 注意：此字段可能返回 null，表示取不到有效值。", "example": "30" } ] }, { "name": "Tag", "type": "array", "required": false, "description": "标签配置", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签键 注意：此字段可能返回 null，表示取不到有效值。", "example": "产品" }, { "name": "TagValue", "type": "string", "required": true, "description": "标签值 注意：此字段可能返回 null，表示取不到有效值。", "example": "cdn" } ] }, { "name": "Ipv6Access", "type": "object", "required": false, "description": "Ipv6 访问配置", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "域名开启ipv6访问配置开关，取值有： on：开启 off：关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" } ] }, { "name": "OfflineCache", "type": "object", "required": false, "description": "离线缓存", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "离线缓存配置开关，取值有： on：开启 off：关闭", "example": "off" } ] }, { "name": "Quic", "type": "object", "required": false, "description": "Quic访问（收费服务，详见计费说明和产品文档）", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "Quic功能配置开关，取值有： on：开启 off：关闭", "example": "on/off" } ] }, { "name": "AwsPrivateAccess", "type": "object", "required": false, "description": "回源S3私有鉴权", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "s3源站回源鉴权配置项开关，取值有： on：开启 off：关闭", "example": "on" }, { "name": "AccessKey", "type": "string", "required": false, "description": "访问ID。 注意：此字段可能返回 null，表示取不到有效值。", "example": "dfss12nk" }, { "name": "SecretKey", "type": "string", "required": false, "description": "密钥，字段为脱敏返回。 注意：此字段可能返回 null，表示取不到有效值。", "example": "wn***************mg" }, { "name": "Region", "type": "string", "required": false, "description": "地域 注意：此字段可能返回 null，表示取不到有效值。", "example": "gz" }, { "name": "Bucket", "type": "string", "required": false, "description": "Bucketname 注意：此字段可能返回 null，表示取不到有效值。", "example": "hw-oss" } ] }, { "name": "OssPrivateAccess", "type": "object", "required": false, "description": "回源OSS私有鉴权", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "oss回源鉴权配置开关，取值有： on：开启 off：关闭", "example": "on" }, { "name": "AccessKey", "type": "string", "required": false, "description": "访问ID。 注意：此字段可能返回 null，表示取不到有效值。", "example": "AKkjqrfjaoidn" }, { "name": "SecretKey", "type": "string", "required": false, "description": "密钥，字段为脱敏返回。 注意：此字段可能返回 null，表示取不到有效值。", "example": "wn***************mg\t" }, { "name": "Region", "type": "string", "required": false, "description": "地域 注意：此字段可能返回 null，表示取不到有效值。", "example": "gz" }, { "name": "Bucket", "type": "string", "required": false, "description": "Bucketname 注意：此字段可能返回 null，表示取不到有效值。", "example": "hw-oss" } ] }, { "name": "HwPrivateAccess", "type": "object", "required": false, "description": "华为云对象存储回源鉴权", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "华为云对象存储回源鉴权配置开关，取值有： on：开启 off：关闭", "example": "on" }, { "name": "AccessKey", "type": "string", "required": false, "description": "访问 ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "SYWKY0DAR8I5NXZO93YT" }, { "name": "SecretKey", "type": "string", "required": false, "description": "密钥，字段为脱敏返回。 注意：此字段可能返回 null，表示取不到有效值。", "example": "wn***************mg" }, { "name": "Bucket", "type": "string", "required": false, "description": "bucketname 注意：此字段可能返回 null，表示取不到有效值。", "example": "hw-1-163" } ] }, { "name": "QnPrivateAccess", "type": "object", "required": false, "description": "七牛云对象存储回源鉴权", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "七牛元对象存储回源鉴权配置开关，取值有： on：开启 off：关闭", "example": "on" }, { "name": "AccessKey", "type": "string", "required": false, "description": "访问 ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "ousbDM5xlzuAZJEhhwcLj8makXkYiaAvciZHqAQj" }, { "name": "SecretKey", "type": "string", "required": false, "description": "密钥，字段为脱敏返回。", "example": "wn***************mg" } ] }, { "name": "OthersPrivateAccess", "type": "object", "required": false, "description": "其他厂商对象存储回源鉴权", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "其他厂商对象存储回源鉴权配置开关，取值有： on：开启 off：关闭", "example": "on" }, { "name": "AccessKey", "type": "string", "required": false, "description": "访问ID。 注意：此字段可能返回 null，表示取不到有效值。", "example": "TXUIWY0BAR8I5NXZ693YU" }, { "name": "SecretKey", "type": "string", "required": false, "description": "密钥，字段位脱敏返回。 注意：此字段可能返回 null，表示取不到有效值。", "example": "wn***************mg" }, { "name": "Region", "type": "string", "required": false, "description": "地域。 注意：此字段可能返回 null，表示取不到有效值。", "example": "gz" }, { "name": "Bucket", "type": "string", "required": false, "description": "存储桶名称。 注意：此字段可能返回 null，表示取不到有效值。", "example": "bucket-name" } ] }, { "name": "HttpsBilling", "type": "object", "required": false, "description": "HTTPS服务，默认开启（收费服务，详见计费说明和产品文档）", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "HTTPS服务配置开关，取值有： on：开启，缺省时默认开启，会产生计费 off：关闭，拦截https请求", "example": "on/off" } ] } ], "required": [ "Domain", "ServiceType", "Origin" ] }, { "name": "CreateClsLogTopic", "description": "CreateClsLogTopic 用于创建日志主题。注意：一个日志集下至多可创建10个日志主题。", "status": "online", "parameters": [ { "name": "TopicName", "type": "string", "required": true, "description": "日志主题名称", "example": "topic-name" }, { "name": "LogsetId", "type": "string", "required": true, "description": "日志集ID", "example": "57460798-8723-45e3-9c75-a0599ef9143a" }, { "name": "Channel", "type": "string", "required": false, "description": "接入渠道，cdn或者ecdn，默认值为cdn", "example": "cdn" }, { "name": "DomainAreaConfigs", "type": "array", "required": false, "description": "域名区域信息", "example": "无", "item_type": "object", "children": [ { "name": "Domain", "type": "string", "required": true, "description": "域名", "example": "qq.com" }, { "name": "Area", "type": "array", "required": true, "description": "地区列表，其中元素可为mainland/overseas", "example": "mainland", "item_type": "string" } ] }, { "name": "InheritDomainTags", "type": "boolean", "required": false, "description": "是否继承域名标签，默认为false", "example": "true" } ], "required": [ "TopicName", "LogsetId" ] }, { "name": "CreateEdgePackTask", "description": "动态打包任务提交接口", "status": "online", "parameters": [ { "name": "CosBucket", "type": "string", "required": true, "description": "apk 所在的 cos 存储桶, 如 edgepack-xxxxxxxx", "example": "‘edgepack-xxxxxxxx’" }, { "name": "CosUriFrom", "type": "string", "required": true, "description": "apk 源文件的存储路径, 如 /apk/xxxx.apk", "example": "‘/apk/xxxx.apk’" }, { "name": "BlockID", "type": "integer", "required": false, "description": "BlockID 的值, WALLE为1903654775(0x71777777)，VasDolly为2282837503(0x881155ff),传0或不传时默认为 WALLE 方案", "example": "0" }, { "name": "CosUriTo", "type": "string", "required": false, "description": "拓展之后的 apk 目标存储路径,如 /out/xxxx.apk", "example": "‘/out/xxxx.apk’" } ], "required": [ "CosBucket", "CosUriFrom" ] }, { "name": "CreateVerifyRecord", "description": "CreateVerifyRecord 用于生成一条子域名解析，提示客户添加到域名解析上，用于泛域名及域名取回校验归属权。 生成的解析记录可通过 [VerifyDomainRecord](https://cloud.tencent.com/document/product/228/48117) 完成归属权校验。 注意：生成的解析记录有效期为24小时，超过24小时后，需重新生成。 具体流程可参考：[使用API接口进行域名归属校验](https://cloud.tencent.com/document/product/228/61702#.E6.96.B9.E6.B3...", "status": "online", "parameters": [ { "name": "Domain", "type": "string", "required": true, "description": "要取回的域名", "example": "www.qq.com" } ], "required": [ "Domain" ] }, { "name": "DeleteCdnDomain", "description": "DeleteCdnDomain 用于删除指定加速域名", "status": "online", "parameters": [ { "name": "Domain", "type": "string", "required": true, "description": "域名 域名状态需要为【已停用】", "example": "www.test.com" } ], "required": [ "Domain" ] }, { "name": "DeleteClsLogTopic", "description": "DeleteClsLogTopic 用于删除日志主题。注意：删除后，所有该日志主题下绑定域名的日志将不再继续投递至该主题，已经投递的日志将会被全部清空。生效时间约为 5~15 分钟。", "status": "online", "parameters": [ { "name": "TopicId", "type": "string", "required": true, "description": "日志主题ID", "example": "6d04373b-ba59-4a4f-a96e-242424" }, { "name": "LogsetId", "type": "string", "required": true, "description": "日志集ID", "example": "6d04373b-ba59-4a4f-a96e-9fe53b59a536" }, { "name": "Channel", "type": "string", "required": false, "description": "接入渠道，cdn或者ecdn，默认值为cdn", "example": "cdn" } ], "required": [ "TopicId", "LogsetId" ] }, { "name": "DescribeBillingData", "description": "DescribeBillingData 用于查询实际计费数据明细。 注意: 受计费算法的影响，计费数据接口返回的数据均存在一定延时。小时结算客户预计延时3-5小时。月结算客户预计延迟4-28小时，在凌晨4点（不含4点）之前，仅能查询到前2天数据，4点（含）之后，能查询到前1天数据。若您对数据及时性较强的诉求，建议使用[监控访问数据](https://cloud.tencent.com/document/product/228/30986)。", "status": "online", "parameters": [ { "name": "StartTime", "type": "string", "required": true, "description": "查询起始时间，如：2018-09-04 10:40:00，返回结果大于等于指定时间 根据指定时间粒度参数不同，会进行向前取整，如指定起始时间为 2018-09-04 10:40:00 按小时粒度查询，返回的第一个数据对应时间点为 2018-09-04 10:00:00 起始时间与结束时间间隔小于等于 90 天", "example": "2018-09-04 10:40:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "查询结束时间，如：2018-09-04 10:40:00，返回结果小于等于指定时间 根据指定时间粒度参数不同，会进行向前取整，如指定结束时间为 2018-09-04 10:40:00 按小时粒度查询时，返回的最后一个数据对应时间点为 2018-09-04 10:00:00 起始时间与结束时间间隔小于等于 90 天", "example": "2018-09-04 10:40:00" }, { "name": "Interval", "type": "string", "required": false, "description": "时间粒度，支持模式如下： min：1 分钟粒度，查询区间需要小于等于 24 小时 5min：5 分钟粒度，查询区间需要小于等于 31 天(计费数据粒度) hour：1 小时粒度，查询区间需要小于等于 31 天内 day：天粒度，查询区间需要大于 31 天 Area 字段为 overseas 时暂不支持1分钟粒度数据查询", "example": "5min" }, { "name": "Domain", "type": "string", "required": false, "description": "指定域名查询计费数据", "example": "www.test.com" }, { "name": "Project", "type": "integer", "required": false, "description": "指定项目 ID 查询，[前往查看项目 ID](https://console.cloud.tencent.com/project) 若 Domain 参数填充了具体域名信息，则返回该域名的计费数据，而非指定项目计费数据", "example": "0" }, { "name": "Area", "type": "string", "required": false, "description": "指定加速区域查询计费数据： mainland：中国境内 overseas：中国境外 不填充时，默认为 mainland", "example": "mainland" }, { "name": "District", "type": "integer", "required": false, "description": "Area 为 overseas 时，指定国家/地区查询 省份、国家/地区编码可以查看 [省份编码映射](https://cloud.tencent.com/document/product/228/6316#.E7.9C.81.E4.BB.BD.E6.98.A0.E5.B0.84) 不填充时，查询所有国家/地区", "example": "10" }, { "name": "Metric", "type": "string", "required": false, "description": "计费统计类型 flux：计费流量 bandwidth：计费带宽 默认为 bandwidth", "example": "bandwidth" }, { "name": "Product", "type": "string", "required": false, "description": "指定查询的产品数据，可选为cdn或者ecdn，默认为cdn", "example": "cdn" }, { "name": "TimeZone", "type": "string", "required": false, "description": "指定查询时间的时区，默认UTC+08:00", "example": "UTC+08:00" } ], "required": [ "StartTime", "EndTime" ] }, { "name": "DescribeCdnData", "description": "DescribeCdnData 用于查询 CDN 实时访问监控数据，支持以下指标查询： + 流量（单位为 byte） + 带宽（单位为 bps） + 请求数（单位为 次） + 命中请求数（单位为 次） + 请求命中率（单位为 %） + 命中流量（单位为 byte） + 流量命中率（单位为 %） + 状态码 2xx 汇总及各 2 开头状态码明细（单位为 个） + 状态码 3xx 汇总及各 3 开头状态码明细（单位为 个） + 状态码 4xx 汇总及各 4 开头\ufffd...", "status": "online", "parameters": [ { "name": "StartTime", "type": "string", "required": true, "description": "查询起始时间，如：2018-09-04 10:40:00，返回结果大于等于指定时间 根据指定时间粒度不同，会进行向前归整，如 2018-09-04 10:40:00 在按 1 小时的时间粒度查询时，返回的第一个数据对应时间点为 2018-09-04 10:00:00 起始时间与结束时间间隔小于等于 90 天", "example": "2021-02-01 00:00:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "查询结束时间，如：2018-09-04 10:40:00，返回结果小于等于指定时间 根据指定时间粒度不同，会进行向前归整，如 2018-09-04 10:40:00 在按 1 小时的时间粒度查询时，返回的最后一个数据对应时间点为 2018-09-04 10:00:00 起始时间与结束时间间隔小于等于 90 天", "example": "2021-02-01 00:00:00" }, { "name": "Metric", "type": "string", "required": true, "description": "指定查询指标，支持的类型有： flux：流量，单位为 byte fluxIn：上行流量，单位为 byte，该指标仅ecdn支持查询 fluxOut：下行流量，单位为 byte，该指标仅ecdn支持查询 bandwidth：带宽，单位为 bps bandwidthIn：上行带宽，单位为 bps，该指标仅ecdn支持查询 bandwidthOut：下行带宽，单位为 bps，该指标仅ecdn支持查询 request：请求数，单位为 次 hitRequest：命中请求数，单位为 次 requestHitRate：请...", "example": "flux" }, { "name": "Domains", "type": "array", "required": false, "description": "指定查询域名列表 查询单域名：指定单个域名 查询多个域名：指定多个域名，最多可一次性查询 30 个 查询账号下所有域名：不传参，默认查询账号维度", "example": "[\"qq.com\", \"tencent.com\"]", "item_type": "string" }, { "name": "Project", "type": "integer", "required": false, "description": "指定要查询的项目 ID，[前往查看项目 ID](https://console.cloud.tencent.com/project) 未填充域名情况下，指定项目查询，若填充了具体域名信息，以域名为主", "example": "0" }, { "name": "Interval", "type": "string", "required": false, "description": "时间粒度，支持以下几种模式： min：1 分钟粒度，指定查询区间 24 小时内（含 24 小时），可返回 1 分钟粒度明细数据（指定查询服务地域为中国境外时不支持 1 分钟粒度） 5min：5 分钟粒度，指定查询区间 31 天内（含 31 天），可返回 5 分钟粒度明细数据 hour：1 小时粒度，指定查询区间 31 天内（含 31 天），可返回 1 小时粒度明细数据 day：天粒度，指定查询区间大于 31 天，可\ufffd...", "example": "day" }, { "name": "Detail", "type": "boolean", "required": false, "description": "多域名查询时，默认（false)返回多个域名的汇总数据 可按需指定为 true，返回每一个 Domain 的明细数据（statusCode、2xx、3xx、4xx、5xx 指标暂不支持）", "example": "false" }, { "name": "Isp", "type": "integer", "required": false, "description": "查询中国境内CDN数据时，指定运营商查询，不填充表示查询所有运营商 运营商编码可以查看 [运营商编码映射](https://cloud.tencent.com/document/product/228/6316#.E5.8C.BA.E5.9F.9F-.2F-.E8.BF.90.E8.90.A5.E5.95.86.E6.98.A0.E5.B0.84.E8.A1.A8) 指定运营商查询时，不可同时指定省份、IP协议查询", "example": "2" }, { "name": "District", "type": "integer", "required": false, "description": "查询中国境内CDN数据时，指定省份查询，不填充表示查询所有省份 查询中国境外CDN数据时，指定国家/地区查询，不填充表示查询所有国家/地区 省份、国家/地区编码可以查看 [省份编码映射](https://cloud.tencent.com/document/product/228/6316#.E5.8C.BA.E5.9F.9F-.2F-.E8.BF.90.E8.90.A5.E5.95.86.E6.98.A0.E5.B0.84.E8.A1.A8) 指定（中国境内）省份查询时，不可同时指定运营商、IP协议查询", "example": "4" }, { "name": "Protocol", "type": "string", "required": false, "description": "指定协议查询，不填充表示查询所有协议 all：所有协议 http：指定查询 HTTP 对应指标 https：指定查询 HTTPS 对应指标 quic：指定查询 QUIC 对应指标", "example": "all" }, { "name": "DataSource", "type": "string", "required": false, "description": "指定数据源查询 monitor：监控数据", "example": "monitor" }, { "name": "IpProtocol", "type": "string", "required": false, "description": "指定IP协议查询，不填充表示查询所有协议 all：所有协议 ipv4：指定查询 ipv4 对应指标 ipv6：指定查询 ipv6 对应指标 指定IP协议查询时，不可同时指定省份、运营商查询 注意：非IPv6白名单用户不可指定ipv4、ipv6进行查询", "example": "ipv4" }, { "name": "Area", "type": "string", "required": false, "description": "指定服务地域查询，不填充表示查询中国境内CDN数据 mainland：指定查询中国境内 CDN 数据 overseas：指定查询中国境外 CDN 数据", "example": "mainland" }, { "name": "AreaType", "type": "string", "required": false, "description": "查询中国境外CDN数据时，可指定地区类型查询，不填充表示查询服务地区数据（仅在 Area 为 overseas 时可用） server：指定查询服务地区（腾讯云 CDN 节点服务器所在地区）数据 client：指定查询客户端地区（用户请求终端所在地区）数据", "example": "server" }, { "name": "Product", "type": "string", "required": false, "description": "指定查询的产品数据，可选为cdn或者ecdn，默认为cdn", "example": "cdn" }, { "name": "TimeZone", "type": "string", "required": false, "description": "指定查询时间的时区，默认UTC+08:00", "example": "UTC+08:00" } ], "required": [ "StartTime", "EndTime", "Metric" ] }, { "name": "DescribeCdnDomainLogs", "description": "DescribeCdnDomainLogs 用于查询访问日志下载地址，仅支持 30 天以内的境内、境外访问日志下载链接查询。", "status": "online", "parameters": [ { "name": "Domain", "type": "string", "required": true, "description": "指定域名查询", "example": "www.test.com" }, { "name": "StartTime", "type": "string", "required": true, "description": "开始时间", "example": "2021-02-01 00:00:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间", "example": "2021-02-01 01:00:00" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页查询偏移量，默认为 0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页查询限制数目，默认为 100，最大为 1000", "example": "10" }, { "name": "Area", "type": "string", "required": false, "description": "指定区域下载日志，默认为 mainland，可取值有： mainland：获取境内加速日志包下载链接 overseas：获取境外加速日志包下载链接 global：同时获取境内、境外加速日志包下载链接（分开打包）", "example": "mainland" }, { "name": "LogType", "type": "string", "required": false, "description": "指定下载日志的类型，可取值有： access：访问日志", "example": "access" } ], "required": [ "Domain", "StartTime", "EndTime" ] }, { "name": "DescribeCdnIp", "description": "DescribeCdnIp 用于查询 CDN IP 归属。 （注意：此接口请求频率限制以 CDN 侧限制为准：200次/10分钟）", "status": "online", "parameters": [ { "name": "Ips", "type": "array", "required": true, "description": "需要查询的 IP 列表，单次可支持1-20个IP查询。", "example": "[\"1.1.1.1\"]", "item_type": "string" } ], "required": [ "Ips" ] }, { "name": "DescribeCdnOriginIp", "description": "### **该接口已废弃** 本接口（DescribeCdnOriginIp）用于查询 CDN 回源节点的IP信息。（注：替换接口为DescribeIpStatus）", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeCertDomains", "description": "DescribeCertDomains 用于校验SSL证书并提取证书中包含的域名。", "status": "online", "parameters": [ { "name": "Cert", "type": "string", "required": false, "description": "PEM格式证书Base64编码后的字符串", "example": "\"\\u65e0\"" }, { "name": "CertId", "type": "string", "required": false, "description": "托管证书ID，Cert和CertId不能均为空，都填写时以CertId为准。", "example": "证书ID" }, { "name": "Product", "type": "string", "required": false, "description": "域名所属产品，cdn或ecdn，默认cdn。", "example": "cdn" } ], "required": [] }, { "name": "DescribeDistrictIspData", "description": "查询指定域名的区域、运营商明细数据 注意事项：接口尚未全面开放，未在内测名单中的账号不支持调用", "status": "online", "parameters": [ { "name": "Domains", "type": "array", "required": true, "description": "域名列表，最多支持20个域名", "example": "[\"www.test.com\"]", "item_type": "string" }, { "name": "StartTime", "type": "string", "required": true, "description": "查询起始时间，如：2018-09-04 10:40:00，返回结果大于等于指定时间 支持近 60 天内的数据查询，每次查询时间区间为 3 小时", "example": "2020-03-27 00:00:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "查询结束时间，如：2018-09-04 10:40:00，返回结果小于等于指定时间 结束时间与起始时间区间最大为 3 小时", "example": "2020-03-27 00:00:00" }, { "name": "Metric", "type": "string", "required": true, "description": "指定查询指标，支持: bandwidth：带宽，单位为 bps flux：流量，单位为 byte request：请求数，单位为 次 statusCode：状态码，返回 0、2xx、3xx、4xx、5xx 汇总数据，单位为 次 2xx：返回 2xx 状态码汇总及各 2 开头状态码数据，单位为 次 3xx：返回 3xx 状态码汇总及各 3 开头状态码数据，单位为 次 4xx：返回 4xx 状态码汇总及各 4 开头状态码数据，单位为 次 5xx：返回 5xx 状态码汇总及各 5 开\ufffd...", "example": "bandwidth" }, { "name": "Districts", "type": "array", "required": false, "description": "指定省份查询，不填充表示查询所有省份 省份、国家/地区编码可以查看 [省份编码映射](https://cloud.tencent.com/document/product/228/6316#.E5.8C.BA.E5.9F.9F-.2F-.E8.BF.90.E8.90.A5.E5.95.86.E6.98.A0.E5.B0.84.E8.A1.A8)", "example": "[122]", "item_type": "integer" }, { "name": "Isps", "type": "array", "required": false, "description": "指定运营商查询，不填充表示查询所有运营商 运营商编码可以查看 [运营商编码映射](https://cloud.tencent.com/document/product/228/6316#.E5.8C.BA.E5.9F.9F-.2F-.E8.BF.90.E8.90.A5.E5.95.86.E6.98.A0.E5.B0.84.E8.A1.A8)", "example": "[3947]", "item_type": "integer" }, { "name": "Protocol", "type": "string", "required": false, "description": "指定协议查询，不填充表示查询所有协议 all：所有协议 http：指定查询 HTTP 对应指标 https：指定查询 HTTPS 对应指标", "example": "http" }, { "name": "IpProtocol", "type": "string", "required": false, "description": "指定IP协议查询，不填充表示查询所有协议 all：所有协议 ipv4：指定查询 ipv4 对应指标 ipv6：指定查询 ipv6 对应指标 指定IP协议查询时，不可同时指定省份、运营商查询", "example": "ipv4" }, { "name": "Interval", "type": "string", "required": false, "description": "时间粒度，支持以下几种模式（默认5min）： min：1 分钟粒度，支持近 60 天内的数据查询，每次查询时间区间不超过10分钟，可返回 1 分钟粒度明细数据 5min：5 分钟粒度，支持近 60 天内的数据查询，每次查询时间区间不超过3 小时，可返回 5 分钟粒度明细数据", "example": "5min" } ], "required": [ "Domains", "StartTime", "EndTime", "Metric" ] }, { "name": "DescribeDomains", "description": "DescribeDomains 用于查询内容分发网络加速域名（含境内、境外）基本配置信息，包括项目ID、服务状态，业务类型、创建时间、更新时间等信息。", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": false, "description": "分页查询偏移量，默认为 0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页查询限制数目，默认为 100，最大可设置为 1000", "example": "10" }, { "name": "Filters", "type": "array", "required": false, "description": "查询条件过滤器，复杂类型", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤字段名，支持的列表如下： - origin：主源站。 - domain：域名。 - resourceId：域名id。 - status：域名状态，online，offline或processing，deleted。 - serviceType：业务类型，web，download，media，hybrid或dynamic。 - projectId：项目ID。 - domainType：主源站类型，cname表示自有源，cos表示cos接入，third_party表示第三方对象存储，igtm表示IGTM多活源。 - fullUrlCache：全路径缓存，on或off。 - https：是否配置...", "example": "domainType" }, { "name": "Value", "type": "array", "required": true, "description": "过滤字段值，默认最多传 5 个。当 Name 是 origin/domain 且 Fuzzy 传 true，最多传 1 个。", "example": "cname", "item_type": "string" }, { "name": "Fuzzy", "type": "boolean", "required": false, "description": "是否启用模糊查询，仅支持过滤字段名为origin，domain。 模糊查询时，Value长度最大为1，否则Value长度最大为5。", "example": "false" } ] } ], "required": [] }, { "name": "DescribeDomainsConfig", "description": "DescribeDomainsConfig 用于查询内容分发网络加速域名（含境内、境外）的所有配置信息。", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": false, "description": "分页查询偏移量，默认为 0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页查询限制数目，默认为 100，最大可设置为 100", "example": "1" }, { "name": "Filters", "type": "array", "required": false, "description": "查询条件过滤器，复杂类型", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤字段名，支持的列表如下： - origin：主源站。 - domain：域名。 - resourceId：域名id。 - status：域名状态，online，offline或processing，deleted。 - serviceType：业务类型，web，download，media，hybrid或dynamic。 - projectId：项目ID。 - domainType：主源站类型，cname表示自有源，cos表示cos接入，third_party表示第三方对象存储，igtm表示IGTM多活源。 - fullUrlCache：全路径缓存，on或off。 - https：是否配置...", "example": "domainType" }, { "name": "Value", "type": "array", "required": true, "description": "过滤字段值，默认最多传 5 个。当 Name 是 origin/domain 且 Fuzzy 传 true，最多传 1 个。", "example": "cname", "item_type": "string" }, { "name": "Fuzzy", "type": "boolean", "required": false, "description": "是否启用模糊查询，仅支持过滤字段名为origin，domain。 模糊查询时，Value长度最大为1，否则Value长度最大为5。", "example": "false" } ] }, { "name": "Sort", "type": "object", "required": false, "description": "排序规则", "example": "无", "children": [ { "name": "Key", "type": "string", "required": false, "description": "排序字段，当前支持： createTime，域名创建时间 certExpireTime，证书过期时间 默认createTime。", "example": "createTime" }, { "name": "Sequence", "type": "string", "required": false, "description": "asc/desc，默认desc。", "example": "asc" } ] } ], "required": [] }, { "name": "DescribeEdgePackTaskStatus", "description": "DescribeEdgePackTaskStatus 用于查询动态打包任务状态列表", "status": "online", "parameters": [ { "name": "StartTime", "type": "string", "required": true, "description": "开始时间", "example": "2020-09-22T00:00:00+00:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间", "example": "2020-09-22T01:00:00+00:00" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页查询限制数目，默认为 100，最大可设置为 1000", "example": "100" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页查询偏移量，默认为 0", "example": "0" }, { "name": "Filters", "type": "array", "required": false, "description": "查询条件过滤器", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤字段名 apk: apk名称 status: 母包处理进度 done, failed, processing", "example": "apk" }, { "name": "Value", "type": "array", "required": true, "description": "过滤字段值", "example": "[\"test.apk\"]", "item_type": "string" }, { "name": "Fuzzy", "type": "boolean", "required": true, "description": "是否启用模糊查询，仅支持过滤字段名为 apk。 模糊查询时，Value长度最大为1。", "example": "true" } ] } ], "required": [ "StartTime", "EndTime" ] }, { "name": "DescribeHttpsPackages", "description": "DescribeHttpsPackages 用于查询 CDN HTTPS请求包详情。", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": false, "description": "分页查询起始地址，默认 0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页查询记录个数，默认100，最大1000", "example": "100" } ], "required": [] }, { "name": "DescribeImageConfig", "description": "DescribeImageConfig 用于获取域名图片优化的当前配置，支持Webp、TPG、 Guetzli 和 Avif。", "status": "online", "parameters": [ { "name": "Domain", "type": "string", "required": true, "description": "域名", "example": "test.tencent.com" } ], "required": [ "Domain" ] }, { "name": "DescribeIpStatus", "description": "DescribeIpStatus 用于查询域名所在加速平台的边缘节点、回源节点明细。注意事项：暂不支持查询边缘节点信息并且数据会存在一定延迟。 \u003e? 若您的业务已迁移至 CDN 控制台，请参考 CDN 接口文档，使用 CDN 相关API 进行操作。", "status": "online", "parameters": [ { "name": "Domain", "type": "string", "required": true, "description": "加速域名", "example": "www.test.com" }, { "name": "Layer", "type": "string", "required": false, "description": "节点类型： edge：表示边缘节点 last：表示回源层节点 不填充情况下，默认返回边缘节点信息", "example": "edge" }, { "name": "Area", "type": "string", "required": false, "description": "查询区域：mainland: 中国境内节点overseas: 海外节点global: 全球节点", "example": "last" }, { "name": "Segment", "type": "boolean", "required": false, "description": "是否以IP段的格式返回。", "example": "true" }, { "name": "ShowIpv6", "type": "boolean", "required": false, "description": "是否查询节点 IPV6 信息。", "example": "true" }, { "name": "AbbreviationIpv6", "type": "boolean", "required": false, "description": "是否对IPV6进行缩写。", "example": "true" } ], "required": [ "Domain" ] }, { "name": "DescribeIpVisit", "description": "DescribeIpVisit 用于查询 5 分钟活跃用户数，及日活跃用户数明细 + 5 分钟活跃用户数：根据日志中客户端 IP，5 分钟粒度去重统计 + 日活跃用户数：根据日志中客户端 IP，按天粒度去重统计", "status": "online", "parameters": [ { "name": "StartTime", "type": "string", "required": true, "description": "查询起始时间，如：2018-09-04 10:40:10，返回结果大于等于指定时间 根据指定时间粒度不同，会进行向前归整，如 2018-09-04 10:40:10 在按 5 分钟的时间粒度查询时，返回的第一个数据对应时间点为 2018-09-04 10:40:00", "example": "2018-09-04 10:40:10" }, { "name": "EndTime", "type": "string", "required": true, "description": "查询结束时间，如：2018-09-04 10:40:10，返回结果小于等于指定时间 根据指定时间粒度不同，会进行向前归整，如 2018-09-04 10:40:10 在按 5 分钟的时间粒度查询时，返回的最后一个数据对应时间点为 2018-09-04 10:40:00", "example": "2018-09-04 10:40:10" }, { "name": "Domains", "type": "array", "required": false, "description": "指定查询域名列表，最多可一次性查询 30 个加速域名明细", "example": "qq.com", "item_type": "string" }, { "name": "Project", "type": "integer", "required": false, "description": "指定要查询的项目 ID，[前往查看项目 ID](https://console.cloud.tencent.com/project) 未填充域名情况下，指定项目查询，若填充了具体域名信息，以域名为主", "example": "0" }, { "name": "Interval", "type": "string", "required": false, "description": "时间粒度，支持以下几种模式： 5min：5 分钟粒度，查询时间区间 24 小时内，默认返回 5 分钟粒度活跃用户数 day：天粒度，查询时间区间大于 1 天时，默认返回天粒度活跃用户数", "example": "5min" } ], "required": [ "StartTime", "EndTime" ] }, { "name": "DescribeMapInfo", "description": "DescribeMapInfo 用于查询省份对应的 ID，运营商对应的 ID 信息。", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": true, "description": "映射查询类别： isp：运营商映射查询 district：省份（中国境内）、国家/地区（中国境外）映射查询", "example": "isp" } ], "required": [ "Name" ] }, { "name": "DescribeOriginData", "description": "DescribeOriginData 用于查询 CDN 实时回源监控数据，支持以下指标查询： + 回源流量（单位为 byte） + 回源带宽（单位为 bps） + 回源请求数（单位为 次） + 回源失败请求数（单位为 次） + 回源失败率（单位为 %，小数点后保留两位） + 回源状态码 2xx 汇总及各 2 开头回源状态码明细（单位为 个） + 回源状态码 3xx 汇总及各 3 开头回源状态码明细（单位为 个） + 回源状态码 4xx 汇总\ufffd\ufffd...", "status": "online", "parameters": [ { "name": "StartTime", "type": "string", "required": true, "description": "查询起始时间，如：2018-09-04 10:40:00，返回结果大于等于指定时间 根据指定时间粒度不同，会进行向前归整，如 2018-09-04 10:40:00 在按 1 小时的时间粒度查询时，返回的第一个数据对应时间点为 2018-09-04 10:00:00 起始时间与结束时间间隔小于等于 90 天", "example": "2018-09-04 10:40:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "查询结束时间，如：2018-09-04 10:40:00，返回结果小于等于指定时间 根据指定时间粒度不同，会进行向前归整，如 2018-09-04 10:40:00 在按 1 小时的时间粒度查询时，返回的最后一个数据对应时间点为 2018-09-04 10:00:00 起始时间与结束时间间隔小于等于 90 天", "example": "2018-09-04 10:40:00" }, { "name": "Metric", "type": "string", "required": true, "description": "指定查询指标，支持的类型有： flux：回源流量，单位为 byte bandwidth：回源带宽，单位为 bps request：回源请求数，单位为 次 failRequest：回源失败请求数，单位为 次 failRate：回源失败率，单位为 % statusCode：回源状态码，返回 2xx、3xx、4xx、5xx 汇总数据，单位为 个 2xx：返回 2xx 回源状态码汇总及各 2 开头回源状态码数据，单位为 个 3xx：返回 3xx 回源状态码汇总及各 3 开头回源状\ufffd\ufffd...", "example": "flux" }, { "name": "Domains", "type": "array", "required": false, "description": "指定查询域名列表，最多可一次性查询 30 个加速域名明细", "example": "qq.com", "item_type": "string" }, { "name": "Project", "type": "integer", "required": false, "description": "指定要查询的项目 ID，[前往查看项目 ID](https://console.cloud.tencent.com/project) 未填充域名情况下，指定项目查询，最多可一次性查询 30 个加速域名明细 若填充了具体域名信息，以域名为主", "example": "0" }, { "name": "Interval", "type": "string", "required": false, "description": "时间粒度，支持以下几种模式： min：1 分钟粒度，指定查询区间 24 小时内（含 24 小时），可返回 1 分钟粒度明细数据（指定查询服务地域为中国境外时不支持 1 分钟粒度） 5min：5 分钟粒度，指定查询区间 31 天内（含 31 天），可返回 5 分钟粒度明细数据 hour：1 小时粒度，指定查询区间 31 天内（含 31 天），可返回 1 小时粒度明细数据 day：天粒度，指定查询区间大于 31 天，可\ufffd...", "example": "5min" }, { "name": "Detail", "type": "boolean", "required": false, "description": "Domains 传入多个时，默认(false)返回多个域名的汇总数据 可按需指定为 true，返回每一个 Domain 的明细数据（statusCode、2xx、3xx、4xx、5xx 指标暂不支持）", "example": "false" }, { "name": "Area", "type": "string", "required": false, "description": "指定服务地域查询，不填充表示查询中国境内 CDN 数据 mainland：指定查询中国境内 CDN 数据 overseas：指定查询中国境外 CDN 数据", "example": "mainland" }, { "name": "TimeZone", "type": "string", "required": false, "description": "指定查询时间的时区，默认UTC+08:00", "example": "UTC+08:00" } ], "required": [ "StartTime", "EndTime", "Metric" ] }, { "name": "DescribePayType", "description": "DescribePayType 用于查询用户的计费类型，计费周期等信息。", "status": "online", "parameters": [ { "name": "Area", "type": "string", "required": false, "description": "指定服务地域查询 mainland：境内计费方式查询 overseas：境外计费方式查询 global：全球计费方式查询 未填充时，默认为 mainland", "example": "mainland" }, { "name": "Product", "type": "string", "required": false, "description": "指定查询的产品数据，可选为cdn或者ecdn，默认为cdn", "example": "cdn" }, { "name": "Type", "type": "string", "required": false, "description": "指定资源包查询 flux：流量包 https：HTTPS请求包 未填充时，默认为 flux", "example": "https" } ], "required": [] }, { "name": "DescribePurgeQuota", "description": "DescribePurgeQuota 用于查询账户刷新配额和每日可用量。", "status": "online", "parameters": [], "required": [] }, { "name": "DescribePurgeTasks", "description": "DescribePurgeTasks 用于查询提交的 URL 刷新、目录刷新记录及执行进度，通过 PurgePathCache 与 PurgeUrlsCache 接口提交的任务均可通过此接口进行查询。", "status": "online", "parameters": [ { "name": "PurgeType", "type": "string", "required": false, "description": "指定刷新类型查询 url：url 刷新记录 path：目录刷新记录", "example": "url" }, { "name": "StartTime", "type": "string", "required": false, "description": "根据时间区间查询时，填充开始时间，如 2018-08-08 00:00:00", "example": "2021-02-01 00:00:00" }, { "name": "EndTime", "type": "string", "required": false, "description": "根据时间区间查询时，填充结束时间，如 2018-08-08 23:59:59", "example": "2021-02-01 01:00:00" }, { "name": "TaskId", "type": "string", "required": false, "description": "根据任务 ID 查询时，填充任务 ID 查询时任务 ID 与起始时间必须填充一项", "example": "123abc" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页查询偏移量，默认为 0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页查询限制数目，默认为 20", "example": "10" }, { "name": "Keyword", "type": "string", "required": false, "description": "支持域名过滤，或 http(s):// 开头完整 URL 过滤", "example": " http(s)://abc.com/index.html" }, { "name": "Status", "type": "string", "required": false, "description": "指定任务状态查询 fail：刷新失败 done：刷新成功 process：刷新中", "example": "process" }, { "name": "Area", "type": "string", "required": false, "description": "指定刷新地域查询 mainland：境内 overseas：境外 global：全球", "example": "mainland" } ], "required": [] }, { "name": "DescribePushQuota", "description": "DescribePushQuota 用于查询预热配额和每日可用量。", "status": "online", "parameters": [], "required": [] }, { "name": "DescribePushTasks", "description": "DescribePushTasks 用于查询预热任务提交历史记录及执行进度。", "status": "online", "parameters": [ { "name": "StartTime", "type": "string", "required": false, "description": "开始时间，如2018-08-08 00:00:00。", "example": "2018-08-08 00:00:00" }, { "name": "EndTime", "type": "string", "required": false, "description": "结束时间，如2018-08-08 23:59:59。", "example": "2018-08-08 23:59:59" }, { "name": "TaskId", "type": "string", "required": false, "description": "指定任务 ID 查询 TaskId 和起始时间必须指定一项", "example": "abc123" }, { "name": "Keyword", "type": "string", "required": false, "description": "查询关键字，请输入域名或 http(s):// 开头完整 URL", "example": " http(s)://abc.com/index.html" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页查询偏移量，默认为 0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页查询限制数目，默认为 20", "example": "10" }, { "name": "Area", "type": "string", "required": false, "description": "指定地区查询预热记录 mainland：境内 overseas：境外 global：全球", "example": "mainland" }, { "name": "Status", "type": "string", "required": false, "description": "指定任务状态查询 fail：预热失败 done：预热成功 process：预热中 invalid: 预热无效(源站返回4xx或5xx状态码)", "example": "done" } ], "required": [] }, { "name": "DescribeReportData", "description": "DescribeReportData 用于查询域名/项目维度的日/周/月报表数据。", "status": "online", "parameters": [ { "name": "StartTime", "type": "string", "required": true, "description": "查询起始时间：yyyy-MM-dd 当报表类型为daily，起始时间和结束时间必须为同一天 当报表类型为weekly，起始时间须为周一，结束时间须为同一周的周日 当报表类型为monthly，起始时间须为自然月第一天，即1号，结束时间须为该自然月最后一天", "example": "2021-02-01" }, { "name": "EndTime", "type": "string", "required": true, "description": "查询结束时间：yyyy-MM-dd 当报表类型为daily，起始时间和结束时间必须为同一天 当报表类型为weekly，起始时间须为周一，结束时间须为同一周的周日 当报表类型为monthly，起始时间须为自然月第一天，即1号，结束时间须为该自然月最后一天", "example": "2021-02-01" }, { "name": "ReportType", "type": "string", "required": true, "description": "报表类型 daily：日报表 weekly：周报表（周一至周日） monthly：月报表（自然月）", "example": "daily" }, { "name": "Area", "type": "string", "required": true, "description": "域名加速区域 mainland：中国境内 overseas：中国境外", "example": "mainland" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "数据个数，默认1000。", "example": "10" }, { "name": "Project", "type": "integer", "required": false, "description": "按项目ID筛选", "example": "0" } ], "required": [ "StartTime", "EndTime", "ReportType", "Area" ] }, { "name": "DescribeTopData", "description": "DescribeTopData 通过入参 Metric 和 Filter 组合不同，可以查询以下排序数据： + 依据总流量、总请求数对访问 IP 排序，从大至小返回 TOP 100 IP + 依据总流量、总请求数对访问 Refer 排序，从大至小返回 TOP 100 Refer + 依据总流量、总请求数对访问 设备 排序，从大至小返回 设备类型 + 依据总流量、总请求数对访问 操作系统 排序，从大至小返回 操作系统 + 依据总流量、总请求数对访问 \ufffd\ufffd...", "status": "online", "parameters": [ { "name": "StartTime", "type": "string", "required": true, "description": "查询起始日期：yyyy-MM-dd HH:mm:ss 仅支持按天粒度的数据查询，取入参中的天信息作为起始日期 返回大于等于起始日期当天 00:00:00 点产生的数据，如 StartTime为2018-09-04 10:40:00，返回数据的起始时间为2018-09-04 00:00:00 仅支持 90 天内数据查询", "example": "2021-01-01 00:00:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "查询结束日期：yyyy-MM-dd HH:mm:ss 仅支持按天粒度的数据查询，取入参中的天信息作为结束日期 返回小于等于结束日期当天 23:59:59 产生的数据，如EndTime为2018-09-05 22:40:00，返回数据的结束时间为2018-09-05 23:59:59 EndTime 需要大于等于 StartTime", "example": "2021-01-01 23:59:59" }, { "name": "Metric", "type": "string", "required": true, "description": "排序对象，支持以下几种形式： ip、ua_device、ua_browser、ua_os、referer", "example": "ip" }, { "name": "Filter", "type": "string", "required": true, "description": "排序使用的指标名称： flux：Metric 为 host 时指代访问流量 request：Metric 为 host 时指代访问请求数", "example": "flux" }, { "name": "Domains", "type": "array", "required": false, "description": "指定查询域名列表，最多可一次性查询 30 个加速域名明细", "example": "www.test.com", "item_type": "string" }, { "name": "Project", "type": "integer", "required": false, "description": "未填充域名情况下，指定项目查询，若填充了具体域名信息，以域名为主", "example": "0" }, { "name": "Detail", "type": "boolean", "required": false, "description": "是否详细显示每个域名的的具体数值", "example": "false" }, { "name": "Area", "type": "string", "required": false, "description": "指定服务地域查询，不填充表示查询中国境内 CDN 数据 mainland：指定查询中国境内 CDN 数据 overseas：指定查询中国境外 CDN 数据", "example": "mainland" }, { "name": "Product", "type": "string", "required": false, "description": "指定查询的产品数据，目前仅可使用cdn", "example": "cdn" } ], "required": [ "StartTime", "EndTime", "Metric", "Filter" ] }, { "name": "DescribeTrafficPackages", "description": "DescribeTrafficPackages 用于查询 CDN 流量包详情。", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": false, "description": "分页查询起始地址，默认 0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页查询记录个数，默认100，最大1000", "example": "100" }, { "name": "SortBy", "type": "string", "required": false, "description": "流量包排序方式，支持以下值： expireTimeDesc：默认值，按过期时间倒序 expireTimeAsc：按过期时间正序 createTimeDesc：按创建时间倒序 createTimeAsc：按创建时间正序 status：按状态排序，正常抵扣\u003e未生效\u003e已用尽\u003e已过期 channel：按来源排序，主动购买\u003e自动续订\u003eCDN赠送", "example": "status" } ], "required": [] }, { "name": "DescribeUrlViolations", "description": "DescribeUrlViolations 用于查询被 CDN 系统扫描到的域名违规 URL 列表及当前状态。 对应内容分发网络控制台【内容合规】页面。", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": false, "description": "分页查询偏移量，默认为 0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页查询限制数目，默认为 100", "example": "1" }, { "name": "Domains", "type": "array", "required": false, "description": "指定的域名查询", "example": "qq.com", "item_type": "string" } ], "required": [] }, { "name": "DisableClsLogTopic", "description": "DisableClsLogTopic 用于停止日志主题投递。注意：停止后，所有绑定该日志主题域名的日志将不再继续投递至该主题，已经投递的日志将会继续保留。生效时间约为 5~15 分钟。", "status": "online", "parameters": [ { "name": "LogsetId", "type": "string", "required": true, "description": "日志集ID", "example": "6d04373b-ba59-4a4f-a96e-9fe53b59a536" }, { "name": "TopicId", "type": "string", "required": true, "description": "日志主题ID", "example": "d2256449-c6ff-421b-93ef-aa3a7dde2de2" }, { "name": "Channel", "type": "string", "required": false, "description": "接入渠道，cdn或者ecdn，默认值为cdn", "example": "cdn" } ], "required": [ "LogsetId", "TopicId" ] }, { "name": "DuplicateDomainConfig", "description": "拷贝参考域名的配置至新域名。暂不支持自有证书以及定制化配置", "status": "online", "parameters": [ { "name": "Domain", "type": "string", "required": true, "description": "新增域名", "example": "www.test.com" }, { "name": "ReferenceDomain", "type": "string", "required": true, "description": "被拷贝配置的域名", "example": "www.test1.com" } ], "required": [ "Domain", "ReferenceDomain" ] }, { "name": "EnableClsLogTopic", "description": "EnableClsLogTopic 用于启动日志主题投递。注意：启动后，所有绑定该日志主题域名的日志将继续投递至该主题。生效时间约为 5~15 分钟。", "status": "online", "parameters": [ { "name": "LogsetId", "type": "string", "required": true, "description": "日志集ID", "example": "6d04373b-ba59-4a4f-a96e-9fe53b59a536" }, { "name": "TopicId", "type": "string", "required": true, "description": "日志主题ID", "example": "d2256449-c6ff-421b-93ef-aa3a7dde2de2" }, { "name": "Channel", "type": "string", "required": false, "description": "接入渠道，cdn或者ecdn，默认值为cdn", "example": "cdn" } ], "required": [ "LogsetId", "TopicId" ] }, { "name": "ListClsLogTopics", "description": "ListClsLogTopics 用于显示日志主题列表。注意：一个日志集下至多含10个日志主题。", "status": "online", "parameters": [ { "name": "Channel", "type": "string", "required": false, "description": "接入渠道，cdn或者ecdn，默认值为cdn", "example": "cdn" } ], "required": [] }, { "name": "ListClsTopicDomains", "description": "ListClsTopicDomains 用于获取某日志主题下绑定的域名列表。", "status": "online", "parameters": [ { "name": "LogsetId", "type": "string", "required": true, "description": "日志集ID", "example": "6d04373b-ba59-4a4f-a96e-9fe53b59a536" }, { "name": "TopicId", "type": "string", "required": true, "description": "日志主题ID", "example": "d2256449-c6ff-421b-93ef-aa3a7dde2de2" }, { "name": "Channel", "type": "string", "required": false, "description": "接入渠道，cdn或者ecdn，默认值为cdn", "example": "cdn" } ], "required": [ "LogsetId", "TopicId" ] }, { "name": "ListTopClsLogData", "description": "通过CLS日志计算Top信息。支持近7天的日志数据。", "status": "online", "parameters": [ { "name": "LogsetId", "type": "string", "required": true, "description": "需要查询的日志集ID", "example": "6d04373b-ba59-4a4f-a96e-9fe53b59a536" }, { "name": "TopicIds", "type": "string", "required": true, "description": "需要查询的日志主题ID组合，多个以逗号分隔", "example": "2feewq3-g327-0457-a12m-2e22e5df1111" }, { "name": "StartTime", "type": "string", "required": true, "description": "需要查询的日志的起始时间，格式 YYYY-mm-dd HH:MM:SS", "example": "2021-10-01 00:00:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "需要查询的日志的结束时间，格式 YYYY-mm-dd HH:MM:SS，时间跨度应小于10分钟", "example": "2021-10-01 00:00:01" }, { "name": "Domain", "type": "string", "required": true, "description": "指定域名查询", "example": "www.test.com" }, { "name": "Url", "type": "string", "required": true, "description": "指定访问的URL查询，支持URL开头和结尾使用\\*表示通配 如： /files/* 表示所有以/files/开头的请求 *.jpg 表示所有以.jpg结尾的请求", "example": "/test/abc.jpg" }, { "name": "Channel", "type": "string", "required": false, "description": "接入渠道，cdn或者ecdn，默认值为cdn", "example": "cdn" }, { "name": "Limit", "type": "integer", "required": false, "description": "要查询的Top条数，建议最大值100，默认为10", "example": "10" }, { "name": "Sort", "type": "string", "required": false, "description": "按请求量排序， asc（升序）或者 desc（降序），默认为 desc", "example": "desc" } ], "required": [ "LogsetId", "TopicIds", "StartTime", "EndTime", "Domain", "Url" ] }, { "name": "ListTopData", "description": "ListTopData 通过入参 Metric 和 Filter 组合不同，可以查询以下排序数据： + 依据总流量、总请求数对访问 URL 排序，从大至小返回 TOP 1000 URL + 依据总流量、总请求数对客户端省份排序，从大至小返回省份列表 + 依据总流量、总请求数对客户端运营商排序，从大至小返回运营商列表 + 依据总流量、峰值带宽、总请求数、平均命中率、2XX/3XX/4XX/5XX 状态码对域名排序，从大至小返回域名...", "status": "online", "parameters": [ { "name": "StartTime", "type": "string", "required": true, "description": "查询起始时间：yyyy-MM-dd HH:mm:ss 仅支持按分钟粒度的数据查询，按入参抹去秒位作为起始时间，如 StartTime为2018-09-04 10:40:23，返回数据的起始时间为2018-09-04 10:40:00 仅支持 90 天内数据查询", "example": "2021-01-01 00:00:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "查询结束时间：yyyy-MM-dd HH:mm:ss 仅支持按天粒度的数据查询，取入参中的天信息作为结束日期 返回小于等于结束日期当天 23:59:59 产生的数据，如EndTime为2018-09-05 22:40:00，返回数据的结束时间为2018-09-05 23:59:59 EndTime 需要大于等于 StartTime", "example": "2021-01-01 23:59:59" }, { "name": "Metric", "type": "string", "required": true, "description": "排序对象，支持以下几种形式： url：访问 URL 排序（无参数的URL），支持的 Filter 为 flux、request district：省份、国家/地区排序，支持的 Filter 为 flux、request isp：运营商排序，支持的 Filter 为 flux、request host：域名访问数据排序，支持的Filter 为：flux、request、bandwidth、fluxHitRate、2XX、3XX、4XX、5XX、statusCode originHost：域名回源数据排序，支持的 Filter 为 flux、request、bandwidth、origin_2XX\ufffd\ufffd...", "example": "host" }, { "name": "Filter", "type": "string", "required": true, "description": "排序使用的指标名称： flux：Metric 为 host 时指代访问流量，originHost 时指代回源流量 bandwidth：Metric 为 host 时指代访问带宽，originHost 时指代回源带宽 request：Metric 为 host 时指代访问请求数，originHost 时指代回源请求数 fluxHitRate：平均流量命中率 2XX：访问 2XX 状态码 3XX：访问 3XX 状态码 4XX：访问 4XX 状态码 5XX：访问 5XX 状态码 origin_2XX：回源 2XX 状态码 origin_3XX：回源 3XX 状态码 ori...", "example": "flux" }, { "name": "Domains", "type": "array", "required": false, "description": "指定查询域名列表，最多可一次性查询 30 个加速域名明细", "example": "www.test.com", "item_type": "string" }, { "name": "Project", "type": "integer", "required": false, "description": "指定要查询的项目 ID，[前往查看项目 ID](https://console.cloud.tencent.com/project) 未填充域名情况下，指定项目查询，若填充了具体域名信息，以域名为主", "example": "0" }, { "name": "Detail", "type": "boolean", "required": false, "description": "多域名查询时，默认（false)返回所有域名汇总排序结果 Metric 为 url、path、district、isp，Filter 为 flux、request 时，可设置为 true，返回每一个 Domain 的排序数据", "example": "false" }, { "name": "Code", "type": "string", "required": false, "description": "Filter 为 statusCode、OriginStatusCode 时，填充指定状态码查询排序结果", "example": "200" }, { "name": "Area", "type": "string", "required": false, "description": "指定服务地域查询，不填充表示查询中国境内 CDN 数据 mainland：指定查询中国境内 CDN 数据 overseas：指定查询中国境外 CDN 数据，支持的 Metric 为 url、district、host、originHost，当 Metric 为 originHost 时仅支持 flux、request、bandwidth Filter", "example": "overseas" }, { "name": "AreaType", "type": "string", "required": false, "description": "查询中国境外CDN数据，且仅当 Metric 为 district 或 host 时，可指定地区类型查询，不填充表示查询服务地区数据（仅在 Area 为 overseas，且 Metric 是 district 或 host 时可用） server：指定查询服务地区（腾讯云 CDN 节点服务器所在地区）数据 client：指定查询客户端地区（用户请求终端所在地区）数据，当 Metric 为 host 时仅支持 flux、request、bandwidth Filter", "example": "server" }, { "name": "Product", "type": "string", "required": false, "description": "指定查询的产品数据，可选为cdn或者ecdn，默认为cdn", "example": "cdn" }, { "name": "Limit", "type": "integer", "required": false, "description": "只返回前N条数据，默认为最大值100，metric=url时默认为最大值1000", "example": "100" } ], "required": [ "StartTime", "EndTime", "Metric", "Filter" ] }, { "name": "ManageClsTopicDomains", "description": "ManageClsTopicDomains 用于管理某日志主题下绑定的域名列表。", "status": "online", "parameters": [ { "name": "LogsetId", "type": "string", "required": true, "description": "日志集ID", "example": "6d04373b-ba59-4a4f-a96e-9fe53b59a536" }, { "name": "TopicId", "type": "string", "required": true, "description": "日志主题ID", "example": "d2256449-c6ff-421b-93ef-aa3a7dde2de2" }, { "name": "Channel", "type": "string", "required": false, "description": "接入渠道，cdn或者ecdn，默认值为cdn", "example": "cdn" }, { "name": "DomainAreaConfigs", "type": "array", "required": false, "description": "域名区域配置，注意：如果此字段为空，则表示解绑对应主题下的所有域名", "example": "无", "item_type": "object", "children": [ { "name": "Domain", "type": "string", "required": true, "description": "域名", "example": "qq.com" }, { "name": "Area", "type": "array", "required": true, "description": "地区列表，其中元素可为mainland/overseas", "example": "mainland", "item_type": "string" } ] }, { "name": "InheritDomainTags", "type": "boolean", "required": false, "description": "是否继承域名标签", "example": "true" } ], "required": [ "LogsetId", "TopicId" ] }, { "name": "ModifyDomainConfig", "description": "ModifyDomainConfig 用于修改内容分发网络加速域名配置信息 注意： Route 字段，使用点分隔，最后一段称为叶子节点，非叶子节点配置保持不变； Value 字段，使用 json 进行序列化，其中固定 update 作为 key，配置路径值参考 https://cloud.tencent.com/document/product/228/41116 接口各配置项复杂类型，为配置路径对应复杂类型下的节点。 操作审计相关：接口的入参可能包含密钥等敏感信息，所以...", "status": "online", "parameters": [ { "name": "Domain", "type": "string", "required": true, "description": "域名", "example": "www.test.com" }, { "name": "Route", "type": "string", "required": true, "description": "配置路径", "example": "Https.CertInfo.CertId" }, { "name": "Value", "type": "string", "required": true, "description": "配置路径值，使用 json 进行序列化，其中固定 update 作为 key", "example": "{\\\"update\\\":\\\"0VpOXiPz\\\"}" } ], "required": [ "Domain", "Route", "Value" ] }, { "name": "ModifyPurgeFetchTaskStatus", "description": "ModifyPurgeFetchTaskStatus 用于上报定时刷新预热任务执行状态", "status": "online", "parameters": [ { "name": "ExecutionTime", "type": "string", "required": true, "description": "执行时间", "example": "2020-09-22T00:00:00+00:00" }, { "name": "ExecutionStatus", "type": "string", "required": true, "description": "执行状态 success: 成功 failed: 失败", "example": "success" }, { "name": "Id", "type": "string", "required": true, "description": "任务 ID", "example": "taskId" }, { "name": "ExecutionStatusDesc", "type": "string", "required": false, "description": "执行状态详情", "example": "desc" } ], "required": [ "ExecutionTime", "ExecutionStatus", "Id" ] }, { "name": "PurgePathCache", "description": "PurgePathCache 用于批量提交目录刷新，根据域名的加速区域进行对应区域的刷新。 默认情况下境内、境外加速区域每日目录刷新额度为各 100 条，每次最多可提交 500 条。", "status": "online", "parameters": [ { "name": "Paths", "type": "array", "required": true, "description": "目录列表，需要包含协议头部 http:// 或 https://", "example": " https://qq.com/index.html", "item_type": "string" }, { "name": "FlushType", "type": "string", "required": true, "description": "刷新类型 flush：刷新产生更新的资源 delete：刷新全部资源", "example": "flush" }, { "name": "UrlEncode", "type": "boolean", "required": false, "description": "是否对中文字符进行编码后刷新", "example": "false" }, { "name": "Area", "type": "string", "required": false, "description": "刷新区域 无此参数时，默认刷新加速域名所在加速区域 填充 mainland 时，仅刷新中国境内加速节点上缓存内容 填充 overseas 时，仅刷新中国境外加速节点上缓存内容 指定刷新区域时，需要与域名加速区域匹配", "example": "mainland" } ], "required": [ "Paths", "FlushType" ] }, { "name": "PurgeUrlsCache", "description": "PurgeUrlsCache 用于批量提交 URL 进行刷新，根据 URL 中域名的当前加速区域进行对应区域的刷新。 默认情况下境内、境外加速区域每日 URL 刷新额度各为 10000 条，每次最多可提交 1000 条。", "status": "online", "parameters": [ { "name": "Urls", "type": "array", "required": true, "description": "URL 列表，需要包含协议头部 http:// 或 https://", "example": "http://www.test.com/1.jpg", "item_type": "string" }, { "name": "Area", "type": "string", "required": false, "description": "刷新区域 无此参数时，默认刷新加速域名所在加速区域 填充 mainland 时，仅刷新中国境内加速节点上缓存内容 填充 overseas 时，仅刷新中国境外加速节点上缓存内容 指定刷新区域时，需要与域名加速区域匹配", "example": "mainland" }, { "name": "UrlEncode", "type": "boolean", "required": false, "description": "是否对中文字符进行编码后刷新", "example": "false" } ], "required": [ "Urls" ] }, { "name": "PushUrlsCache", "description": "PushUrlsCache 用于将指定 URL 资源列表加载至 CDN 节点，支持指定加速区域预热。 默认情况下境内、境外每日预热 URL 限额为各 1000 条，每次最多可提交 500 条 URL，每次提交的数量会消耗配额总数。如：1次提交500条URL全球预热，此时境内、境外预热 URL 各剩余 500条。注意：中国境外区域预热，资源默认加载至中国境外边缘节点。", "status": "online", "parameters": [ { "name": "Urls", "type": "array", "required": true, "description": "URL 列表，需要包含协议头部 http:// 或 https://", "example": "https://qq.com/data", "item_type": "string" }, { "name": "UserAgent", "type": "string", "required": false, "description": "指定预热请求回源时 HTTP 请求的 User-Agent 头部 默认为 TencentCdn", "example": "TencentCdn" }, { "name": "Area", "type": "string", "required": false, "description": "预热生效区域 mainland：预热至境内节点 overseas：预热至境外节点 global：预热全球节点 不填充情况下，默认为 mainland， URL 中域名必须在对应区域启用了加速服务才能提交对应区域的预热任务", "example": "mainland" }, { "name": "Layer", "type": "string", "required": false, "description": "中国境内区域默认预热至中间层节点，中国境外区域默认预热至边缘节点。预热至边缘产生的边缘层流量会计入计费流量。 填写\"middle\"或不填充时，可指定预热至中间层节点。", "example": "middle" }, { "name": "ParseM3U8", "type": "boolean", "required": false, "description": "是否递归解析m3u8文件中的ts分片预热 注意事项： 1. 该功能要求m3u8索引文件能直接请求获取 2. 当前只支持递归解析一级索引和子索引中的ts分片，递归深度不超过3层 3. 解析获取的ts分片会正常累加每日预热用量，当用量超出配额时，会静默处理，不再执行预热", "example": "false" }, { "name": "DisableRange", "type": "boolean", "required": false, "description": "是否关闭Range回源 注意事项： 此功能灰度发布中，敬请期待", "example": "false" }, { "name": "Headers", "type": "array", "required": false, "description": "自定义 HTTP 请求头。最多定义 20 个，Name 长度不超过 128 字节，Value 长度不超过 1024 字节", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "请求头名称", "example": "User-Agent" }, { "name": "Value", "type": "string", "required": true, "description": "请求头值", "example": "TencentCDN" } ] }, { "name": "UrlEncode", "type": "boolean", "required": false, "description": "是否对URL进行编码", "example": "false" } ], "required": [ "Urls" ] }, { "name": "SearchClsLog", "description": "SearchClsLog 用于 CLS 日志检索。支持检索今天，24小时（可选近7中的某一天），近7天的日志数据。", "status": "online", "parameters": [ { "name": "LogsetId", "type": "string", "required": true, "description": "需要查询的日志集ID", "example": "6d04373b-ba59-4a4f-a96e-9fe53b59a536" }, { "name": "TopicIds", "type": "string", "required": true, "description": "需要查询的日志主题ID组合，以逗号分隔", "example": "2feewq3-g327-0457-a12m-2e22e5df1111" }, { "name": "StartTime", "type": "string", "required": true, "description": "需要查询的日志的起始时间，格式 YYYY-mm-dd HH:MM:SS", "example": "2021-02-01 00:00:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "需要查询的日志的结束时间，格式 YYYY-mm-dd HH:MM:SS", "example": "2021-02-01 01:00:00" }, { "name": "Limit", "type": "integer", "required": true, "description": "单次要返回的日志条数，单次返回的最大条数为100", "example": "10" }, { "name": "Channel", "type": "string", "required": false, "description": "接入渠道，cdn或者ecdn，默认值为cdn", "example": "CDN" }, { "name": "Query", "type": "string", "required": false, "description": "需要查询的内容，详情请参考https://cloud.tencent.com/document/product/614/16982", "example": "http_status:200" }, { "name": "Context", "type": "string", "required": false, "description": "加载更多使用，透传上次返回的 context 值，获取后续的日志内容，通过游标最多可获取10000条，请尽可能缩小时间范围", "example": "Y29udGV4dC04MjMzNWRkMi01YmMxLTQ4NGYtYjQ4MS04MDg0NzAwYjQ1NDUxNjcy" }, { "name": "Sort", "type": "string", "required": false, "description": "按日志时间排序， asc（升序）或者 desc（降序），默认为 desc", "example": "asc" } ], "required": [ "LogsetId", "TopicIds", "StartTime", "EndTime", "Limit" ] }, { "name": "StartCdnDomain", "description": "StartCdnDomain 用于启用已停用域名的加速服务", "status": "online", "parameters": [ { "name": "Domain", "type": "string", "required": true, "description": "域名 域名状态需要为【已停用】", "example": "www.test.com" } ], "required": [ "Domain" ] }, { "name": "StopCdnDomain", "description": "StopCdnDomain 用于停止域名的加速服务。 注意：停止加速服务后，访问至加速节点的请求将会直接返回 404。为避免对您的业务造成影响，请在停止加速服务前将解析切走。", "status": "online", "parameters": [ { "name": "Domain", "type": "string", "required": true, "description": "域名 域名需要为【已启动】状态", "example": "www.test.com" } ], "required": [ "Domain" ] }, { "name": "UpdateDomainConfig", "description": "UpdateDomainConfig 用于修改内容分发网络加速域名配置信息。 注意：如果需要更新复杂类型的配置项，必须传递整个对象的所有属性，未传递的属性将使用默认值，建议通过查询接口获取配置属性后，直接修改后传递给本接口；如果仅修改单独配置项只传对应配置参数即可。 操作审计相关：接口的入参可能包含密钥等敏感信息，所以此接口的入参不会上报到操作审计。", "status": "online", "parameters": [ { "name": "Domain", "type": "string", "required": true, "description": "域名", "example": "www.test.com" }, { "name": "ProjectId", "type": "integer", "required": false, "description": "项目 ID", "example": "0" }, { "name": "Origin", "type": "object", "required": false, "description": "源站配置", "example": "无", "children": [ { "name": "Origins", "type": "array", "required": false, "description": "主源站列表 修改源站时，需要同时填充对应的 OriginType 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"1.1.1.1\"]", "item_type": "string" }, { "name": "OriginType", "type": "string", "required": false, "description": "主源站类型 当源站列表 Origins 不为空时必填 入参支持以下几种类型： domain：域名类型 domainv6：域名解析V6类型 cos：对象存储源站 third_party: 第三方存储源站 igtm: IGTM多活源 ip：IP 列表作为源站 ipv6：源站列表为一个单独的 IPv6 地址 ip_ipv6：源站列表为多个 IPv4 地址和IPv6 地址 ip_domain: 支持IP和域名形式源站混填（白名单功能） ip_domainv6：源站列表为多个 IPv4 地址以及域名解析v6地...", "example": "ip" }, { "name": "ServerName", "type": "string", "required": false, "description": "回主源站时 Host 头部 当源站类型为cos或者第三方存储加速时,ServerName字段必填 不填充则默认为加速域名 若接入的是泛域名，则回源 Host 默认为访问时的子域名 注意：此字段可能返回 null，表示取不到有效值。", "example": "www.test.com" }, { "name": "CosPrivateAccess", "type": "string", "required": false, "description": "OriginType 为对象存储（COS）时，可以指定是否允许访问私有 bucket 注意：需要先授权 CDN 访问该私有 Bucket 的权限后，才可开启此配置。取值范围: on/off 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" }, { "name": "OriginPullProtocol", "type": "string", "required": false, "description": "回源协议配置 http：强制 http 回源 follow：协议跟随回源 https：强制 https 回源 注意：此字段可能返回 null，表示取不到有效值。", "example": "http" }, { "name": "BackupOrigins", "type": "array", "required": false, "description": "备源站列表 修改备源站时，需要同时填充对应的 BackupOriginType 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"2.2.2.2\"]", "item_type": "string" }, { "name": "BackupOriginType", "type": "string", "required": false, "description": "备源站类型 备源站列表BackupOrigins 不为空时必填 支持以下类型： domain：域名类型 ip：IP 列表作为源站 以下备源源站类型尚未全量支持，需要申请试用： ipv6_domain: 源站列表为多个 IPv6 地址以及域名 ip_ipv6：源站列表为多个 IPv4 地址和IPv6 地址 ip_ipv6_domain：源站列表为多个 IPv4 地址IPv6 地址以及域名 注意：此字段可能返回 null，表示取不到有效值。", "example": "ip" }, { "name": "BackupServerName", "type": "string", "required": false, "description": "回备源站时 Host 头部，不填充则默认为主源站的 ServerName 注意：此字段可能返回 null，表示取不到有效值。", "example": "www.test2.com" }, { "name": "BasePath", "type": "string", "required": false, "description": "回源路径 注意：此字段可能返回 null，表示取不到有效值。", "example": "/data" }, { "name": "PathRules", "type": "array", "required": false, "description": "回源路径重写规则配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Regex", "type": "boolean", "required": true, "description": "是否开启通配符“*”匹配： false：关闭 true：开启 注意：此字段可能返回 null，表示取不到有效值。", "example": "false" }, { "name": "Path", "type": "string", "required": true, "description": "匹配的URL路径，仅支持Url路径，不支持参数。默认完全匹配，开启通配符“*”匹配后，最多支持5个通配符，最大长度为1024个字符。 注意：此字段可能返回 null，表示取不到有效值。", "example": "/test" }, { "name": "Origin", "type": "string", "required": false, "description": "路径匹配时的回源源站。暂不支持开了私有读写的COS源。不填写时沿用默认源站。 注意：此字段可能返回 null，表示取不到有效值。", "example": "8.8.8.8" }, { "name": "ServerName", "type": "string", "required": false, "description": "路径匹配时回源的Host头部。不填写时沿用默认ServerName。 注意：此字段可能返回 null，表示取不到有效值。", "example": "www.test.com" }, { "name": "OriginArea", "type": "string", "required": false, "description": "源站所属区域，支持CN，OV： CN：中国境内 OV：中国境外 默认为CN。 注意：此字段可能返回 null，表示取不到有效值。", "example": "CN" }, { "name": "ForwardUri", "type": "string", "required": false, "description": "路径匹配时回源的URI路径，必须以“/”开头，不包含参数部分。最大长度为1024个字符。可使用$1, $2, $3, $4, $5分别捕获匹配路径中的通配符号“*”，最多支持10个捕获值。 注意：此字段可能返回 null，表示取不到有效值。", "example": "/demo" }, { "name": "RequestHeaders", "type": "array", "required": false, "description": "路径匹配时回源的头部设置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "HeaderMode", "type": "string", "required": true, "description": "http头部设置方式，支持add，set或del，分别表示新增，设置或删除头部。", "example": "add" }, { "name": "HeaderName", "type": "string", "required": true, "description": "http头部名称。", "example": "X-Cdn-Header" }, { "name": "HeaderValue", "type": "string", "required": true, "description": "http头部值。", "example": "header-value" } ] }, { "name": "FullMatch", "type": "boolean", "required": false, "description": "当Regex为false时，Path是否开启完全匹配。 false：关闭 true：开启 注意：此字段可能返回 null，表示取不到有效值。", "example": "true" } ] }, { "name": "PathBasedOrigin", "type": "array", "required": false, "description": "分路径回源配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "RuleType", "type": "string", "required": true, "description": "规则类型： file：指定文件后缀生效 directory：指定路径生效 path：指定绝对路径生效 index: 指定主页生效", "example": "file" }, { "name": "RulePaths", "type": "array", "required": true, "description": "RuleType 对应类型下的匹配内容： file 时填充后缀名，如 jpg、txt directory 时填充路径，如 /xxx/test/ path 时填充绝对路径，如 /xxx/test.html index 时填充 /", "example": "jpg", "item_type": "string" }, { "name": "Origin", "type": "array", "required": true, "description": "源站列表，支持域名或ipv4地址", "example": "10.0.0.1", "item_type": "string" } ] }, { "name": "Sni", "type": "object", "required": false, "description": "HTTPS回源SNI配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "是否开启HTTPS回源SNI。 开启：on， 关闭：off", "example": "on" }, { "name": "ServerName", "type": "string", "required": true, "description": "回源域名。 注意：此字段可能返回 null，表示取不到有效值。", "example": "qq.com" } ] }, { "name": "AdvanceHttps", "type": "object", "required": false, "description": "HTTPS回源高级配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "CustomTlsStatus", "type": "string", "required": false, "description": "自定义Tls数据开关 注意：此字段可能返回 null，表示取不到有效值。", "example": "on" }, { "name": "TlsVersion", "type": "array", "required": false, "description": "Tls版本列表，支持设置 TLSv1, TLSV1.1, TLSV1.2, TLSv1.3，修改时必须开启连续的版本 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"TLSv1\",\"TLSv1.1\",\"TLSv1.2\",\"TLSv1.3\"]", "item_type": "string" }, { "name": "Cipher", "type": "string", "required": false, "description": "自定义加密套件 注意：此字段可能返回 null，表示取不到有效值。", "example": "\"EECDH+AES128\"" }, { "name": "VerifyOriginType", "type": "string", "required": false, "description": "回源双向校验开启状态 off - 关闭校验 oneWay - 校验源站 twoWay - 双向校验 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" }, { "name": "CertInfo", "type": "object", "required": false, "description": "回源层证书配置信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "CertId", "type": "string", "required": false, "description": "服务器证书 ID 在 SSL 证书管理进行证书托管时自动生成 注意：此字段可能返回 null，表示取不到有效值。", "example": "LE-dsfdsf" }, { "name": "CertName", "type": "string", "required": false, "description": "服务器证书名称 在 SSL 证书管理进行证书托管时自动生成 注意：此字段可能返回 null，表示取不到有效值。", "example": "aa.com" }, { "name": "Certificate", "type": "string", "required": false, "description": "服务器证书信息 上传自有证书时必填，需要包含完整的证书链 注意：此字段可能返回 null，表示取不到有效值。", "example": "不展示" }, { "name": "PrivateKey", "type": "string", "required": false, "description": "服务器密钥信息 上传自有证书时必填 注意：此字段可能返回 null，表示取不到有效值。", "example": "不展示" }, { "name": "ExpireTime", "type": "string", "required": false, "description": "证书过期时间 作为入参配置时无需填充 注意：此字段可能返回 null，表示取不到有效值。", "example": "2021-12-01 09:48:19" }, { "name": "DeployTime", "type": "string", "required": false, "description": "证书颁发时间 作为入参配置时无需填充 注意：此字段可能返回 null，表示取不到有效值。", "example": "2021-12-01 09:48:19" }, { "name": "Message", "type": "string", "required": false, "description": "证书备注信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "备注" }, { "name": "From", "type": "string", "required": false, "description": "证书来源 注意：此字段可能返回 null，表示取不到有效值。", "example": "upload" } ] }, { "name": "OriginCertInfo", "type": "object", "required": false, "description": "源站证书配置信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Certificate", "type": "string", "required": true, "description": "客户端证书 PEM 格式，需要进行 Base 64 编码 注意：此字段可能返回 null，表示取不到有效值。", "example": "Certificate" }, { "name": "CertName", "type": "string", "required": false, "description": "客户端证书名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "qq.com" }, { "name": "ExpireTime", "type": "string", "required": false, "description": "证书过期时间 作为入参时无需填充 注意：此字段可能返回 null，表示取不到有效值。", "example": "2025-06-28 11:38:2" }, { "name": "DeployTime", "type": "string", "required": false, "description": "证书颁发时间 作为入参时无需填充 注意：此字段可能返回 null，表示取不到有效值。", "example": "2023-06-28 11:38:20" } ] } ] }, { "name": "OriginCompany", "type": "string", "required": false, "description": "对象存储回源厂商 当源站类型为第三方存储源站(third_party)时必填 可选值包括以下: aws_s3: AWS S3 ali_oss: 阿里云 OSS hw_obs: 华为 OBS qiniu_kodo: 七牛云 kodo others: 其它厂商对象存储,仅支持兼容以AWS签名算法的对象存储，如腾讯云金融专区COS 注意：此字段可能返回 null，表示取不到有效值。", "example": "hw-oss" } ] }, { "name": "IpFilter", "type": "object", "required": false, "description": "IP 黑白名单配置", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "IP 黑白名单配置开关，取值有 on：开启 off：关闭", "example": "on" }, { "name": "FilterType", "type": "string", "required": false, "description": "IP 黑白名单类型 whitelist：白名单 blacklist：黑名单 注意：此字段可能返回 null，表示取不到有效值。", "example": "blacklist" }, { "name": "Filters", "type": "array", "required": false, "description": "IP 黑白名单列表 支持 X.X.X.X 格式IPV4地址 或X:X:X:X:X:X:X:X 格式IPV6地址， 或网段格式/X（IPV4:1≤X≤32；IPV6:1≤X≤128） 最多可填充 200 个白名单或 200 个黑名单； 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"1.1.1.1\"]", "item_type": "string" }, { "name": "FilterRules", "type": "array", "required": false, "description": "IP 黑白名单分路径配置。黑白名单 IP 总数不能超过 1000 个。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "FilterType", "type": "string", "required": true, "description": "IP 黑白名单类型 whitelist：白名单 blacklist：黑名单 注意：此字段可能返回 null，表示取不到有效值。", "example": "whitelist" }, { "name": "Filters", "type": "array", "required": true, "description": "IP 黑白名单列表 支持 X.X.X.X 格式IPV4地址 或X:X:X:X:X:X:X:X 格式IPV6地址， 或网段格式/X（IPV4:1≤X≤32；IPV6:1≤X≤128） 最多可填充 500 个白名单或 200 个黑名单； 注意：此字段可能返回 null，表示取不到有效值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "RuleType", "type": "string", "required": true, "description": "规则类型： all：所有文件生效 file：指定文件后缀生效 directory：指定路径生效 path：指定绝对路径生效 注意：此字段可能返回 null，表示取不到有效值。", "example": "file" }, { "name": "RulePaths", "type": "array", "required": true, "description": "RuleType 对应类型下的匹配内容： all 时填充 * file 时填充后缀名，如 jpg、txt directory 时填充路径，如 /xxx/test/ path 时填充绝对路径，如 /xxx/test.html 注意：此字段可能返回 null，表示取不到有效值。", "example": "jpg", "item_type": "string" }, { "name": "Remark", "type": "string", "required": false, "description": "备注信息, 最多支持50个字符", "example": "remark" } ] }, { "name": "ReturnCode", "type": "integer", "required": false, "description": "IP 黑白名单验证失败时返回的状态码。 注意： 请求拒绝时，平台默认响应514状态。 支持自定义为403，404，609状态码，空值时或自定义的不在范围内，均默认为514. 非514状态码将计入HTTPS计费统计，最终账单将按您的计费规则生成。 若您开启了自定义状态码，则默认您认同HTTPS计费规则。 注意：此字段可能返回 null，表示取不到有效值。", "example": "514" } ] }, { "name": "IpFreqLimit", "type": "object", "required": false, "description": "IP 限频配置", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "IP 限频配置开关，取值有： on：开启 off：关闭", "example": "off" }, { "name": "Qps", "type": "integer", "required": false, "description": "设置每秒请求数限制 超出限制的请求会直接返回 514 注意：此字段可能返回 null，表示取不到有效值。", "example": "20" } ] }, { "name": "StatusCodeCache", "type": "object", "required": false, "description": "状态码缓存配置", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "状态码缓存过期配置开关，取值有： on：开启 off：关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" }, { "name": "CacheRules", "type": "array", "required": false, "description": "状态码缓存过期规则明细 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "StatusCode", "type": "string", "required": true, "description": "http 状态码 支持 403、404 状态码", "example": "403" }, { "name": "CacheTime", "type": "integer", "required": true, "description": "状态码缓存过期时间，单位秒", "example": "3600" } ] } ] }, { "name": "Compression", "type": "object", "required": false, "description": "智能压缩配置", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "智能压缩配置开关，取值有： on：开启 off：关闭", "example": "on" }, { "name": "CompressionRules", "type": "array", "required": false, "description": "压缩规则数组 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Compress", "type": "boolean", "required": true, "description": "true：需要设置为 ture，启用压缩 注意：此字段可能返回 null，表示取不到有效值。", "example": "true" }, { "name": "MinLength", "type": "integer", "required": true, "description": "触发压缩的文件长度最小值，单位为字节数 注意：此字段可能返回 null，表示取不到有效值。", "example": "256" }, { "name": "MaxLength", "type": "integer", "required": true, "description": "触发压缩的文件长度最大值，单位为字节数 最大可设置为 30MB 注意：此字段可能返回 null，表示取不到有效值。", "example": "10000" }, { "name": "Algorithms", "type": "array", "required": true, "description": "文件压缩算法 gzip：指定 GZIP 压缩 brotli：指定Brotli压缩 注意：此字段可能返回 null，表示取不到有效值。", "example": "gzIp", "item_type": "string" }, { "name": "FileExtensions", "type": "array", "required": false, "description": "根据文件后缀类型压缩 例如 jpg、txt 注意：此字段可能返回 null，表示取不到有效值。", "example": "jpg", "item_type": "string" }, { "name": "RuleType", "type": "string", "required": false, "description": "规则类型： all：所有文件生效 file：指定文件后缀生效 directory：指定路径生效 path：指定绝对路径生效 contentType：指定Content-Type头为特定值时生效 当指定了此字段时，FileExtensions字段不生效 注意：此字段可能返回 null，表示取不到有效值。", "example": "file" }, { "name": "RulePaths", "type": "array", "required": false, "description": "CacheType 对应类型下的匹配内容： all 时填充 * file 时填充后缀名，如 jpg、txt directory 时填充路径，如 /xxx/test path 时填充绝对路径，如 /xxx/test.html contentType 时填充 text/html 注意：此字段可能返回 null，表示取不到有效值。", "example": "jpg", "item_type": "string" } ] } ] }, { "name": "BandwidthAlert", "type": "object", "required": false, "description": "带宽封顶配置", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "用量封顶配置开关，取值有： on：开启 off：关闭", "example": "off" }, { "name": "BpsThreshold", "type": "integer", "required": false, "description": "用量封顶阈值，带宽单位为bps，流量单位byte 注意：此字段可能返回 null，表示取不到有效值。", "example": "1000000" }, { "name": "CounterMeasure", "type": "string", "required": false, "description": "达到阈值后的操作 RETURN_404：全部请求返回 404 注意：此字段可能返回 null，表示取不到有效值。", "example": "RETURN_404" }, { "name": "LastTriggerTime", "type": "string", "required": false, "description": "境内区域上次触发用量封顶阈值的时间 注意：此字段可能返回 null，表示取不到有效值。", "example": "2023-06-28 12:00:00" }, { "name": "AlertSwitch", "type": "string", "required": false, "description": "用量封顶提醒配置开关，取值有： on：开启 off：关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" }, { "name": "AlertPercentage", "type": "integer", "required": false, "description": "用量封顶阈值提醒百分比 注意：此字段可能返回 null，表示取不到有效值。", "example": "80" }, { "name": "LastTriggerTimeOverseas", "type": "string", "required": false, "description": "海外区域上次触发用量封顶阈值的时间 注意：此字段可能返回 null，表示取不到有效值。", "example": "2023-06-28 12:00:00" }, { "name": "Metric", "type": "string", "required": false, "description": "用量阈值触发的维度 带宽：bandwidth 流量：flux 注意：此字段可能返回 null，表示取不到有效值。", "example": "bandwith" }, { "name": "StatisticItems", "type": "array", "required": false, "description": "累计用量配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Type", "type": "string", "required": false, "description": "封顶类型，累计用量total，瞬时用量moment 注意：此字段可能返回 null，表示取不到有效值。", "example": "total" }, { "name": "UnBlockTime", "type": "integer", "required": false, "description": "自动解封时间 注意：此字段可能返回 null，表示取不到有效值。", "example": "60" }, { "name": "BpsThreshold", "type": "integer", "required": false, "description": "带宽、流量阈值 注意：此字段可能返回 null，表示取不到有效值。", "example": "1000000000" }, { "name": "CounterMeasure", "type": "string", "required": false, "description": "关闭方式 返回404:RETURN_404 注意：此字段可能返回 null，表示取不到有效值。", "example": "RETURN_404" }, { "name": "AlertPercentage", "type": "integer", "required": false, "description": "触发提醒阈值百分比 注意：此字段可能返回 null，表示取不到有效值。", "example": "80" }, { "name": "AlertSwitch", "type": "string", "required": false, "description": "累计用量封顶告警配置，取值有： on：开启 off：关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "on" }, { "name": "Metric", "type": "string", "required": false, "description": "指标类型，流量flux或带宽bandwidth 注意：此字段可能返回 null，表示取不到有效值。", "example": "flux" }, { "name": "Cycle", "type": "integer", "required": false, "description": "检测周期，单位分钟，60或1440 注意：此字段可能返回 null，表示取不到有效值。", "example": "60" }, { "name": "Switch", "type": "string", "required": false, "description": "累计用量封顶配置开关，取值有： on：开启 off：关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "on" } ] } ] }, { "name": "RangeOriginPull", "type": "object", "required": false, "description": "Range 回源配置", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "分片回源配置开关，取值有： on：开启 off：关闭", "example": "on" }, { "name": "RangeRules", "type": "array", "required": false, "description": "分路径分片回源配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "[{\"Switch\":\"on\",\"RuleType\":\"file\",\"RulePaths\":[\"jpg\"]}]", "item_type": "object", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "分片回源配置开关，取值有： on：开启 off：关闭", "example": "on" }, { "name": "RuleType", "type": "string", "required": true, "description": "规则类型： file：指定文件后缀生效 directory：指定路径生效 path：指定绝对路径生效 注意：此字段可能返回 null，表示取不到有效值。", "example": "file" }, { "name": "RulePaths", "type": "array", "required": true, "description": "RuleType 对应类型下的匹配内容： file 时填充后缀名，如 jpg、txt directory 时填充路径，如 /xxx/test path 时填充绝对路径，如 /xxx/test.html 注意：此字段可能返回 null，表示取不到有效值。", "example": "jpg", "item_type": "string" } ] } ] }, { "name": "FollowRedirect", "type": "object", "required": false, "description": "301/302 回源跟随配置", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "回源跟随配置开关，取值有： on：开启 off：关闭", "example": "off" }, { "name": "RedirectConfig", "type": "object", "required": false, "description": "自定义回源302 follow请求host配置，该功能为白名单功能，需要开启请联系腾讯云工程师。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "自定义回源302 follow请求host配置开关，取值有： on：开启 off：关闭", "example": "on" }, { "name": "FollowRedirectHost", "type": "string", "required": true, "description": "主源站follow302请求时带的自定义的host头部", "example": "main.host.com" }, { "name": "FollowRedirectBackupHost", "type": "string", "required": false, "description": "备份源站follow302请求时带的自定义的host头部", "example": "backup.host.com" } ] } ] }, { "name": "ErrorPage", "type": "object", "required": false, "description": "错误码重定向配置（功能灰度中，尚未全量）", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "状态码重定向配置开关，取值有： on：开启 off：关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" }, { "name": "PageRules", "type": "array", "required": false, "description": "状态码重定向规则配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "StatusCode", "type": "integer", "required": true, "description": "状态码 支持 400、403、404、500", "example": "404" }, { "name": "RedirectCode", "type": "integer", "required": true, "description": "重定向状态码设置 支持 301 或 302", "example": "301" }, { "name": "RedirectUrl", "type": "string", "required": true, "description": "重定向 URL 需要为完整跳转路径，如 https://www.test.com/error.html", "example": "https://www.test.com/error.html" } ] } ] }, { "name": "RequestHeader", "type": "object", "required": false, "description": "回源请求头部配置", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "自定义请求头配置开关，取值有： on：开启 off：关闭", "example": "off" }, { "name": "HeaderRules", "type": "array", "required": false, "description": "自定义请求头配置规则 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "HeaderMode", "type": "string", "required": true, "description": "http 头部设置方式 set：设置。变更指定头部参数的取值为设置后的值；若设置的头部不存在，则会增加该头部；若存在多个重复的头部参数，则会全部变更，同时合并为一个头部。 del：删除。删除指定的头部参数 add：增加。增加指定的头部参数，默认允许重复添加，即重复添加相同的头部（注：重复添加可能会影响浏览器响应，请优先使用set操作） 注意：此字段可能返回 null...", "example": "set" }, { "name": "HeaderName", "type": "string", "required": true, "description": "http 头部名称，最多可设置 100 个字符 注意：此字段可能返回 null，表示取不到有效值。", "example": "name" }, { "name": "HeaderValue", "type": "string", "required": true, "description": "http 头部值，自定义请求头中最多可设置 1000 个字符，自定义响应头中最多可以设置 2000 个字符 Mode 为 del 时非必填 Mode 为 add/set 时必填 注意：此字段可能返回 null，表示取不到有效值。", "example": "value" }, { "name": "RuleType", "type": "string", "required": true, "description": "规则类型： all：所有文件生效 file：指定文件后缀生效 directory：指定路径生效 path：指定绝对路径生效 注意：此字段可能返回 null，表示取不到有效值。", "example": "file" }, { "name": "RulePaths", "type": "array", "required": true, "description": "RuleType 对应类型下的匹配内容： all 时填充 * file 时填充后缀名，如 jpg、txt directory 时填充路径，如 /xxx/test/ path 时填充绝对路径，如 /xxx/test.html 注意：此字段可能返回 null，表示取不到有效值。", "example": "jpg", "item_type": "string" } ] } ] }, { "name": "ResponseHeader", "type": "object", "required": false, "description": "响应头部配置", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "自定义响应头配置开关，取值有： on：开启 off：关闭", "example": "off" }, { "name": "HeaderRules", "type": "array", "required": false, "description": "自定义响应头规则 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "HeaderMode", "type": "string", "required": true, "description": "http 头部设置方式 set：设置。变更指定头部参数的取值为设置后的值；若设置的头部不存在，则会增加该头部；若存在多个重复的头部参数，则会全部变更，同时合并为一个头部。 del：删除。删除指定的头部参数 add：增加。增加指定的头部参数，默认允许重复添加，即重复添加相同的头部（注：重复添加可能会影响浏览器响应，请优先使用set操作） 注意：此字段可能返回 null...", "example": "set" }, { "name": "HeaderName", "type": "string", "required": true, "description": "http 头部名称，最多可设置 100 个字符 注意：此字段可能返回 null，表示取不到有效值。", "example": "name" }, { "name": "HeaderValue", "type": "string", "required": true, "description": "http 头部值，自定义请求头中最多可设置 1000 个字符，自定义响应头中最多可以设置 2000 个字符 Mode 为 del 时非必填 Mode 为 add/set 时必填 注意：此字段可能返回 null，表示取不到有效值。", "example": "value" }, { "name": "RuleType", "type": "string", "required": true, "description": "规则类型： all：所有文件生效 file：指定文件后缀生效 directory：指定路径生效 path：指定绝对路径生效 注意：此字段可能返回 null，表示取不到有效值。", "example": "file" }, { "name": "RulePaths", "type": "array", "required": true, "description": "RuleType 对应类型下的匹配内容： all 时填充 * file 时填充后缀名，如 jpg、txt directory 时填充路径，如 /xxx/test/ path 时填充绝对路径，如 /xxx/test.html 注意：此字段可能返回 null，表示取不到有效值。", "example": "jpg", "item_type": "string" } ] } ] }, { "name": "DownstreamCapping", "type": "object", "required": false, "description": "下载速度配置", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "下行速度配置开关，取值有： on：开启 off：关闭", "example": "off" }, { "name": "CappingRules", "type": "array", "required": false, "description": "下行限速规则 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "RuleType", "type": "string", "required": true, "description": "规则类型： all：所有文件生效 file：指定文件后缀生效 directory：指定路径生效 path：指定绝对路径生效", "example": "file" }, { "name": "RulePaths", "type": "array", "required": true, "description": "RuleType 对应类型下的匹配内容： all 时填充 * file 时填充后缀名，如 jpg、txt directory 时填充路径，如 /xxx/test/ path 时填充绝对路径，如 /xxx/test.html", "example": "png", "item_type": "string" }, { "name": "KBpsThreshold", "type": "integer", "required": true, "description": "下行速度值设置，单位为 KB/s", "example": "100" } ] } ] }, { "name": "CacheKey", "type": "object", "required": false, "description": "节点缓存键配置", "example": "无", "children": [ { "name": "FullUrlCache", "type": "string", "required": false, "description": "是否开启全路径缓存 on：开启全路径缓存（即关闭参数忽略） off：关闭全路径缓存（即开启参数忽略）", "example": "off" }, { "name": "IgnoreCase", "type": "string", "required": false, "description": "是否忽略大小写缓存 on：开启 off：关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" }, { "name": "QueryString", "type": "object", "required": false, "description": "CacheKey中包含请求参数 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "CacheKey是否由QueryString组成配置开关，取值有： on：开启 off：关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "on" }, { "name": "Reorder", "type": "string", "required": false, "description": "是否重新排序 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" }, { "name": "Action", "type": "string", "required": false, "description": "使用/排除部分url参数，取值有： includeAll：包含所有 excludeAll：排除所有 includeCustom：自定义包含 excludeCustom：自定义排除 注意：此字段可能返回 null，表示取不到有效值。", "example": "includeCustom" }, { "name": "Value", "type": "string", "required": false, "description": "使用/排除的url参数数组，';' 分割 注意：此字段可能返回 null，表示取不到有效值。", "example": "key1;key2" } ] }, { "name": "Cookie", "type": "object", "required": false, "description": "CacheKey中包含Cookie 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "使用Cookie作为Cache的一部分配置开关，取值有： on：开启，使用Cookie作为Cache的一部分 off：关闭，不使用Cookie作为Cache的一部分 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" }, { "name": "Value", "type": "string", "required": false, "description": "使用的cookie，';' 分割 注意：此字段可能返回 null，表示取不到有效值。", "example": "cookie value" } ] }, { "name": "Header", "type": "object", "required": false, "description": "CacheKey中包含请求头部 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "组成Cachekey配置开关，取值有： on：开启 off：关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" }, { "name": "Value", "type": "string", "required": false, "description": "组成CacheKey的header数组，';' 分割 注意：此字段可能返回 null，表示取不到有效值。", "example": "header value" } ] }, { "name": "CacheTag", "type": "object", "required": false, "description": "CacheKey中包含自定义字符串 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "使用CacheTag作为CacheKey的一部分配置开关，取值有 on：开启，使用CacheTag作为CacheKey的一部分 off：关闭，不使用CacheTag作为CacheKey的一部分 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" }, { "name": "Value", "type": "string", "required": false, "description": "自定义CacheTag的值 注意：此字段可能返回 null，表示取不到有效值。", "example": "CacheTagValue" } ] }, { "name": "Scheme", "type": "object", "required": false, "description": "CacheKey中包含请求协议 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "scheme作为cache key配置开关，取值有： on：开启 off：关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" } ] }, { "name": "KeyRules", "type": "array", "required": false, "description": "分路径缓存键配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "RulePaths", "type": "array", "required": true, "description": "CacheType 对应类型下的匹配内容： file 时填充后缀名，如 jpg、txt directory 时填充路径，如 /xxx/test path 时填充绝对路径，如 /xxx/test.html index 时填充 / 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"jpg\"]", "item_type": "string" }, { "name": "RuleType", "type": "string", "required": true, "description": "规则类型： file：指定文件后缀生效 directory：指定路径生效 path：指定绝对路径生效 index：首页 注意：此字段可能返回 null，表示取不到有效值。", "example": "file" }, { "name": "FullUrlCache", "type": "string", "required": true, "description": "是否开启全路径缓存 on：开启全路径缓存（即关闭参数忽略） off：关闭全路径缓存（即开启参数忽略） 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" }, { "name": "IgnoreCase", "type": "string", "required": true, "description": "是否忽略大小写缓存 on：开启 off：关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" }, { "name": "QueryString", "type": "object", "required": true, "description": "CacheKey中包含请求参数 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "路径保留参数配置开关，取值有： on：开启，CacheKey由QueryString组成 off：关闭，CacheKey不由QueryString组成 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" }, { "name": "Action", "type": "string", "required": true, "description": "includeCustom 包含部分url参数 注意：此字段可能返回 null，表示取不到有效值。", "example": "includeAll" }, { "name": "Value", "type": "string", "required": true, "description": "使用/排除的url参数数组，';' 分割 注意：此字段可能返回 null，表示取不到有效值。", "example": "example-value" } ] }, { "name": "RuleTag", "type": "string", "required": true, "description": "路径缓存键标签，传 user 注意：此字段可能返回 null，表示取不到有效值。", "example": "user" } ] } ] }, { "name": "ResponseHeaderCache", "type": "object", "required": false, "description": "头部缓存配置", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "源站头部缓存配置开关，取值有： on：开启 off：关闭", "example": "off" } ] }, { "name": "VideoSeek", "type": "object", "required": false, "description": "视频拖拽配置", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "视频拖拽配置开关，取值有： on：开启 off：关闭", "example": "off" } ] }, { "name": "Cache", "type": "object", "required": false, "description": "缓存过期时间配置", "example": "无", "children": [ { "name": "SimpleCache", "type": "object", "required": false, "description": "基础缓存过期时间配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "CacheRules", "type": "array", "required": true, "description": "缓存过期时间规则 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "CacheType", "type": "string", "required": true, "description": "规则类型： all：所有文件生效 file：指定文件后缀生效 directory：指定路径生效 path：指定绝对路径生效 index：首页", "example": "file" }, { "name": "CacheContents", "type": "array", "required": true, "description": "CacheType 对应类型下的匹配内容： all 时填充 * file 时填充后缀名，如 jpg、txt directory 时填充路径，如 /xxx/test path 时填充绝对路径，如 /xxx/test.html index 时填充 /", "example": "jpg", "item_type": "string" }, { "name": "CacheTime", "type": "integer", "required": true, "description": "缓存过期时间设置 单位为秒，最大可设置为 365 天", "example": "3600" } ] }, { "name": "FollowOrigin", "type": "string", "required": true, "description": "遵循源站 Cache-Control: max-age 配置 on：开启 off：关闭 开启后，未能匹配 CacheRules 规则的资源将根据源站返回的 max-age 值进行节点缓存；匹配了 CacheRules 规则的资源将按照 CacheRules 中设置的缓存过期时间在节点进行缓存 与 CompareMaxAge 冲突，不能同时开启 注意：此字段可能返回 null，表示取不到有效值。", "example": "on" }, { "name": "IgnoreCacheControl", "type": "string", "required": true, "description": "强制缓存 on：开启 off：关闭 默认为关闭状态，开启后，源站返回的 no-store、no-cache 资源，也将按照 CacheRules 规则进行缓存 注意：此字段可能返回 null，表示取不到有效值。", "example": "on" }, { "name": "IgnoreSetCookie", "type": "string", "required": true, "description": "忽略源站的Set-Cookie头部 on：开启 off：关闭 默认为关闭状态 注意：此字段可能返回 null，表示取不到有效值。", "example": "on" }, { "name": "CompareMaxAge", "type": "string", "required": true, "description": "高级缓存过期配置，开启时会对比源站返回的 max-age 值与 CacheRules 中设置的缓存过期时间，取最小值在节点进行缓存 on：开启 off：关闭 默认为关闭状态 注意：此字段可能返回 null，表示取不到有效值。", "example": "on" }, { "name": "Revalidate", "type": "object", "required": false, "description": "总是回源站校验 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "总是回源校验配置开关，取值有： on：开启 off：关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" }, { "name": "Path", "type": "string", "required": false, "description": "只在特定请求路径回源站校验 注意：此字段可能返回 null，表示取不到有效值。", "example": "/data" } ] } ] }, { "name": "AdvancedCache", "type": "object", "required": false, "description": "高级缓存过期时间配置（已弃用） 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "CacheRules", "type": "array", "required": true, "description": "缓存过期规则 注意：此字段可能返回 null，表示取不到有效值。", "example": "暂无", "item_type": "object", "children": [ { "name": "CacheType", "type": "string", "required": true, "description": "规则类型： all：所有文件生效 file：指定文件后缀生效 directory：指定路径生效 path：指定绝对路径生效 default：源站未返回 max-age 情况下的缓存规则 注意：此字段可能返回 null，表示取不到有效值。", "example": "file" }, { "name": "CacheContents", "type": "array", "required": true, "description": "对应类型下的匹配内容： all 时填充 * file 时填充后缀名，如 jpg、txt directory 时填充路径，如 /xxx/test/ path 时填充绝对路径，如 /xxx/test.html default 时填充 \"no max-age\" 注意：此字段可能返回 null，表示取不到有效值。", "example": "jpg", "item_type": "string" }, { "name": "CacheTime", "type": "integer", "required": true, "description": "缓存过期时间 单位为秒，最大可设置为 365 天 注意：此字段可能返回 null，表示取不到有效值。", "example": "60" } ] }, { "name": "IgnoreCacheControl", "type": "string", "required": true, "description": "强制缓存配置 on：开启 off：关闭 开启时，源站返回 no-cache、no-store 头部时，仍按照缓存过期规则进行节点缓存 默认为关闭状态 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" }, { "name": "IgnoreSetCookie", "type": "string", "required": true, "description": "当源站返回Set-Cookie头部时，节点是否缓存该头部及body on：开启，不缓存该头部及body off：关闭，遵循用户自定义的节点缓存规则 默认为关闭状态 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" } ] }, { "name": "RuleCache", "type": "array", "required": false, "description": "高级路径缓存配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "RulePaths", "type": "array", "required": true, "description": "CacheType 对应类型下的匹配内容： all 时填充 * file 时填充后缀名，如 jpg、txt directory 时填充路径，如 /xxx/test path 时填充绝对路径，如 /xxx/test.html index 时填充 / 注意：此字段可能返回 null，表示取不到有效值。", "example": "jpg", "item_type": "string" }, { "name": "RuleType", "type": "string", "required": true, "description": "规则类型： all：所有文件生效 file：指定文件后缀生效 directory：指定路径生效 path：指定绝对路径生效 index：首页 注意：此字段可能返回 null，表示取不到有效值。", "example": "file" }, { "name": "CacheConfig", "type": "object", "required": true, "description": "缓存配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "{\"Cache\":{\"CacheTime\":86400,\"CompareMaxAge\":\"off\",\"IgnoreCacheCo", "children": [ { "name": "Cache", "type": "object", "required": true, "description": "缓存配置 注意：此字段可能返回 null，表示取不到有效值。" }, { "name": "NoCache", "type": "object", "required": true, "description": "不缓存配置 注意：此字段可能返回 null，表示取不到有效值。" }, { "name": "FollowOrigin", "type": "object", "required": true, "description": "遵循源站配置 注意：此字段可能返回 null，表示取不到有效值。" } ] } ] } ] }, { "name": "OriginPullOptimization", "type": "object", "required": false, "description": "跨国链路优化配置（已下线）", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "跨国回源优化配置开关，取值有： on：开启 off：关闭", "example": "on" }, { "name": "OptimizationType", "type": "string", "required": false, "description": "跨国类型 OVToCN：境外回源境内 CNToOV：境内回源境外 注意：此字段可能返回 null，表示取不到有效值。", "example": "OVToCN" } ] }, { "name": "Https", "type": "object", "required": false, "description": "Https 加速配置", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "https 配置开关，取值有： on：开启 off：关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "on" }, { "name": "Http2", "type": "string", "required": false, "description": "http2 配置开关 on：开启 off：关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "on" }, { "name": "OcspStapling", "type": "string", "required": false, "description": "OCSP 配置开关 on：开启 off：关闭 默认为关闭状态 注意：此字段可能返回 null，表示取不到有效值。", "example": "on" }, { "name": "VerifyClient", "type": "string", "required": false, "description": "客户端证书校验功能 on：开启 off：关闭 默认为关闭状态，开启时需要上传客户端证书信息，该配置项目前在灰度中，尚未全量 注意：此字段可能返回 null，表示取不到有效值。", "example": "on" }, { "name": "CertInfo", "type": "object", "required": false, "description": "服务端证书配置信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "CertId", "type": "string", "required": false, "description": "服务器证书 ID 在 SSL 证书管理进行证书托管时自动生成 注意：此字段可能返回 null，表示取不到有效值。", "example": "LE-dsfdsf" }, { "name": "CertName", "type": "string", "required": false, "description": "服务器证书名称 在 SSL 证书管理进行证书托管时自动生成 注意：此字段可能返回 null，表示取不到有效值。", "example": "aa.com" }, { "name": "Certificate", "type": "string", "required": false, "description": "服务器证书信息 上传自有证书时必填，需要包含完整的证书链 注意：此字段可能返回 null，表示取不到有效值。", "example": "不展示" }, { "name": "PrivateKey", "type": "string", "required": false, "description": "服务器密钥信息 上传自有证书时必填 注意：此字段可能返回 null，表示取不到有效值。", "example": "不展示" }, { "name": "ExpireTime", "type": "string", "required": false, "description": "证书过期时间 作为入参配置时无需填充 注意：此字段可能返回 null，表示取不到有效值。", "example": "2021-12-01 09:48:19" }, { "name": "DeployTime", "type": "string", "required": false, "description": "证书颁发时间 作为入参配置时无需填充 注意：此字段可能返回 null，表示取不到有效值。", "example": "2021-12-01 09:48:19" }, { "name": "Message", "type": "string", "required": false, "description": "证书备注信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "备注" }, { "name": "From", "type": "string", "required": false, "description": "证书来源 注意：此字段可能返回 null，表示取不到有效值。", "example": "upload" } ] }, { "name": "ClientCertInfo", "type": "object", "required": false, "description": "客户端证书配置信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Certificate", "type": "string", "required": true, "description": "客户端证书 PEM 格式，需要进行 Base 64 编码 注意：此字段可能返回 null，表示取不到有效值。", "example": "Certificate" }, { "name": "CertName", "type": "string", "required": false, "description": "客户端证书名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "qq.com" }, { "name": "ExpireTime", "type": "string", "required": false, "description": "证书过期时间 作为入参时无需填充 注意：此字段可能返回 null，表示取不到有效值。", "example": "2025-06-28 11:38:2" }, { "name": "DeployTime", "type": "string", "required": false, "description": "证书颁发时间 作为入参时无需填充 注意：此字段可能返回 null，表示取不到有效值。", "example": "2023-06-28 11:38:20" } ] }, { "name": "Spdy", "type": "string", "required": false, "description": "Spdy 配置开关 on：开启 off：关闭 默认为关闭状态 注意：此字段可能返回 null，表示取不到有效值。", "example": "on" }, { "name": "SslStatus", "type": "string", "required": false, "description": "https 证书部署状态 closed：已关闭 deploying：部署中 deployed：部署成功 failed：部署失败 注意：此字段可能返回 null，表示取不到有效值。", "example": "closed" }, { "name": "Hsts", "type": "object", "required": false, "description": "Hsts配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "HSTS 配置开关，取值有： on：开启 off：关闭", "example": "off" }, { "name": "MaxAge", "type": "integer", "required": false, "description": "MaxAge数值。 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "IncludeSubDomains", "type": "string", "required": false, "description": "是否包含子域名，on或off。 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" } ] }, { "name": "TlsVersion", "type": "array", "required": false, "description": "Tls版本设置，仅支持部分Advance域名，支持设置 TLSv1, TLSv1.1, TLSv1.2, TLSv1.3，修改时必须开启连续的版本 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"TLSv1\"]", "item_type": "string" } ] }, { "name": "Authentication", "type": "object", "required": false, "description": "时间戳防盗链配置", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "防盗链配置开关，取值有： on：开启 off：关闭 开启时必须且只配置一种模式，其余模式需要设置为 null", "example": "off" }, { "name": "AuthAlgorithm", "type": "string", "required": false, "description": "鉴权算法，取值有： md5：按MD5算法取hash值 sha256：按SHA-256算法取hash值 默认为 md5 注意：此字段可能返回 null，表示取不到有效值。", "example": "md5" }, { "name": "TypeA", "type": "object", "required": false, "description": "时间戳防盗链模式 A 配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "SecretKey", "type": "string", "required": true, "description": "计算签名的密钥 仅允许大小写字母与数字，长度 6~32 位 注意：此字段可能返回 null，表示取不到有效值。", "example": "exmaple-secretkey" }, { "name": "SignParam", "type": "string", "required": true, "description": "签名参数名设置 仅允许大小写字母、数字或下划线，长度 1~100 位，不能以数字开头", "example": "s" }, { "name": "ExpireTime", "type": "integer", "required": true, "description": "签名过期时间设置 单位为秒，最大可设置为 630720000", "example": "7200" }, { "name": "FileExtensions", "type": "array", "required": true, "description": "鉴权/不做鉴权的文件扩展名列表设置 如果包含字符 * 则表示所有文件", "example": "[\"*\"]", "item_type": "string" }, { "name": "FilterType", "type": "string", "required": true, "description": "whitelist：白名单，表示对除了 FileExtensions 列表之外的所有类型进行鉴权 blacklist：黑名单，表示仅对 FileExtensions 中的类型进行鉴权", "example": "whitelist" }, { "name": "BackupSecretKey", "type": "string", "required": false, "description": "计算签名的备用密钥 仅允许大小写字母与数字，长度 6~32 位 注意：此字段可能返回 null，表示取不到有效值。", "example": "exmaple-backup-secretkey" } ] }, { "name": "TypeB", "type": "object", "required": false, "description": "时间戳防盗链模式 B 配置（模式 B 后台升级中，暂时不支持配置） 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "SecretKey", "type": "string", "required": true, "description": "计算签名的密钥 仅允许大小写字母与数字，长度 6~32 位 注意：此字段可能返回 null，表示取不到有效值。", "example": "exmaple-secretkey" }, { "name": "ExpireTime", "type": "integer", "required": true, "description": "签名过期时间设置 单位为秒，最大可设置为 630720000", "example": "7200" }, { "name": "FileExtensions", "type": "array", "required": true, "description": "鉴权/不做鉴权的文件扩展名列表设置 如果包含字符 * 则表示所有文件", "example": "[\"*\"]", "item_type": "string" }, { "name": "FilterType", "type": "string", "required": true, "description": "whitelist：白名单，表示对除了 FileExtensions 列表之外的所有类型进行鉴权 blacklist：黑名单，表示仅对 FileExtensions 中的类型进行鉴权", "example": "whitelist" }, { "name": "BackupSecretKey", "type": "string", "required": false, "description": "计算签名的备用密钥 仅允许大小写字母与数字，长度 6~32 位 注意：此字段可能返回 null，表示取不到有效值。", "example": "exmaple-backup-secretkey" } ] }, { "name": "TypeC", "type": "object", "required": false, "description": "时间戳防盗链模式 C 配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "SecretKey", "type": "string", "required": true, "description": "计算签名的密钥 仅允许大小写字母与数字，长度 6~32 位 注意：此字段可能返回 null，表示取不到有效值。", "example": "exmaple-secretkey" }, { "name": "ExpireTime", "type": "integer", "required": true, "description": "签名过期时间设置 单位为秒，最大可设置为 630720000", "example": "7200" }, { "name": "FileExtensions", "type": "array", "required": true, "description": "鉴权/不做鉴权的文件扩展名列表设置 如果包含字符 * 则表示所有文件", "example": "[\"*\"]", "item_type": "string" }, { "name": "FilterType", "type": "string", "required": true, "description": "whitelist：白名单，表示对除了 FileExtensions 列表之外的所有类型进行鉴权 blacklist：黑名单，表示仅对 FileExtensions 中的类型进行鉴权", "example": "whitelist" }, { "name": "TimeFormat", "type": "string", "required": false, "description": "时间戳进制设置 dec：十进制 hex：十六进制 注意：此字段可能返回 null，表示取不到有效值。", "example": "dec" }, { "name": "BackupSecretKey", "type": "string", "required": false, "description": "计算签名的备用密钥 仅允许大小写字母与数字，长度 6~32 位 注意：此字段可能返回 null，表示取不到有效值。", "example": "exmaple-backp-secretkey" } ] }, { "name": "TypeD", "type": "object", "required": false, "description": "时间戳防盗链模式 D 配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "SecretKey", "type": "string", "required": true, "description": "计算签名的密钥 仅允许大小写字母与数字，长度 6~32 位 注意：此字段可能返回 null，表示取不到有效值。", "example": "exmaple-secretkey" }, { "name": "ExpireTime", "type": "integer", "required": true, "description": "签名过期时间设置 单位为秒，最大可设置为 630720000", "example": "7200" }, { "name": "FileExtensions", "type": "array", "required": true, "description": "鉴权/不做鉴权的文件扩展名列表设置 如果包含字符 * 则表示所有文件", "example": "[\"*\"]", "item_type": "string" }, { "name": "FilterType", "type": "string", "required": true, "description": "whitelist：白名单，表示对除了 FileExtensions 列表之外的所有类型进行鉴权 blacklist：黑名单，表示仅对 FileExtensions 中的类型进行鉴权", "example": "whitelist" }, { "name": "SignParam", "type": "string", "required": true, "description": "签名参数名设置 仅允许大小写字母、数字或下划线，长度 1~100 位，不能以数字开头", "example": "e" }, { "name": "TimeParam", "type": "string", "required": true, "description": "时间戳参数名设置 仅允许大小写字母、数字或下划线，长度 1~100 位，不能以数字开头", "example": "tp" }, { "name": "TimeFormat", "type": "string", "required": true, "description": "时间戳进制设置 dec：十进制 hex：十六进制", "example": "dec" }, { "name": "BackupSecretKey", "type": "string", "required": false, "description": "计算签名的备用密钥 仅允许大小写字母与数字，长度 6~32 位 注意：此字段可能返回 null，表示取不到有效值。", "example": "exmaple-backup-secretkey" } ] } ] }, { "name": "Seo", "type": "object", "required": false, "description": "SEO 优化配置", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "SEO 搜索引擎优化配置开关，取值有： on：开启 off：关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" } ] }, { "name": "ForceRedirect", "type": "object", "required": false, "description": "访问协议强制跳转配置", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "访问强制跳转配置开关，取值有： on：开启 off：关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" }, { "name": "RedirectType", "type": "string", "required": false, "description": "访问强制跳转类型 http：强制 http 跳转 https：强制 https 跳转 注意：此字段可能返回 null，表示取不到有效值。", "example": "http" }, { "name": "RedirectStatusCode", "type": "integer", "required": false, "description": "强制跳转时返回状态码 支持 301、302、307、308 注意：此字段可能返回 null，表示取不到有效值。", "example": "302" }, { "name": "CarryHeaders", "type": "string", "required": false, "description": "强制跳转时是否返回增加的头部。 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" } ] }, { "name": "Referer", "type": "object", "required": false, "description": "Referer 防盗链配置", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "referer 黑白名单配置开关，取值有： on：开启 off：关闭", "example": "off" }, { "name": "RefererRules", "type": "array", "required": false, "description": "referer 黑白名单配置规则 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "RuleType", "type": "string", "required": true, "description": "规则类型： all：所有文件生效 file：指定文件后缀生效 directory：指定路径生效 path：指定绝对路径生效", "example": "file" }, { "name": "RulePaths", "type": "array", "required": true, "description": "RuleType 对应类型下的匹配内容： all 时填充 * file 时填充后缀名，如 jpg、txt directory 时填充路径，如 /xxx/test/ path 时填充绝对路径，如 /xxx/test.html", "example": "jpg", "item_type": "string" }, { "name": "RefererType", "type": "string", "required": true, "description": "referer 配置类型 whitelist：白名单 blacklist：黑名单", "example": "whitelist" }, { "name": "Referers", "type": "array", "required": true, "description": "referer 内容列表", "example": "qq.com", "item_type": "string" }, { "name": "AllowEmpty", "type": "boolean", "required": true, "description": "是否允许空 referer 防盗链类型为白名单时，true表示允许空 referer，false表示不允许空 referer； 防盗链类型为黑名单时，true表示拒绝空referer，false表示不拒绝空referer；", "example": "true" } ] } ] }, { "name": "MaxAge", "type": "object", "required": false, "description": "浏览器缓存配置（功能灰度中，尚未全量）", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "浏览器缓存配置开关，取值有： on：开启 off：关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" }, { "name": "MaxAgeRules", "type": "array", "required": false, "description": "MaxAge 规则 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "MaxAgeType", "type": "string", "required": true, "description": "规则类型： all：所有文件生效 file：指定文件后缀生效 directory：指定路径生效 path：指定绝对路径生效 index: 指定主页生效", "example": "file" }, { "name": "MaxAgeContents", "type": "array", "required": true, "description": "MaxAgeType 对应类型下的匹配内容： all 时填充 * file 时填充后缀名，如 jpg、txt directory 时填充路径，如 /xxx/test/ path 时填充绝对路径，如 /xxx/test.html index 时填充 / 注意：all规则不可删除，默认遵循源站，可修改。", "example": "jpg", "item_type": "string" }, { "name": "MaxAgeTime", "type": "integer", "required": true, "description": "MaxAge 时间设置，单位秒 注意：时间为0，即不缓存。", "example": "3600" }, { "name": "FollowOrigin", "type": "string", "required": false, "description": "是否遵循源站，on或off，开启时忽略时间设置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "on" } ] }, { "name": "MaxAgeCodeRule", "type": "object", "required": false, "description": "MaxAge 状态码相关规则 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Action", "type": "string", "required": true, "description": "处理动作 clear：清除 cache-control 头部", "example": "clear" }, { "name": "StatusCodes", "type": "array", "required": true, "description": "指定HTTP状态码生效，当前仅支持填写\"400-599\"", "example": "[\"400-599\"]", "item_type": "string" } ] } ] }, { "name": "SpecificConfig", "type": "object", "required": false, "description": "地域属性特殊配置 适用于域名境内加速、境外加速配置不一致场景", "example": "无", "children": [ { "name": "Mainland", "type": "object", "required": false, "description": "国内特殊配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "null", "children": [ { "name": "Authentication", "type": "object", "required": false, "description": "时间戳防盗链配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "防盗链配置开关，取值有： on：开启 off：关闭 开启时必须且只配置一种模式，其余模式需要设置为 null", "example": "off" }, { "name": "AuthAlgorithm", "type": "string", "required": false, "description": "鉴权算法，取值有： md5：按MD5算法取hash值 sha256：按SHA-256算法取hash值 默认为 md5 注意：此字段可能返回 null，表示取不到有效值。", "example": "md5" }, { "name": "TypeA", "type": "object", "required": false, "description": "时间戳防盗链模式 A 配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "TypeB", "type": "object", "required": false, "description": "时间戳防盗链模式 B 配置（模式 B 后台升级中，暂时不支持配置） 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "TypeC", "type": "object", "required": false, "description": "时间戳防盗链模式 C 配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "TypeD", "type": "object", "required": false, "description": "时间戳防盗链模式 D 配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" } ] }, { "name": "BandwidthAlert", "type": "object", "required": false, "description": "带宽封顶配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "用量封顶配置开关，取值有： on：开启 off：关闭", "example": "off" }, { "name": "BpsThreshold", "type": "integer", "required": false, "description": "用量封顶阈值，带宽单位为bps，流量单位byte 注意：此字段可能返回 null，表示取不到有效值。", "example": "1000000" }, { "name": "CounterMeasure", "type": "string", "required": false, "description": "达到阈值后的操作 RETURN_404：全部请求返回 404 注意：此字段可能返回 null，表示取不到有效值。", "example": "RETURN_404" }, { "name": "LastTriggerTime", "type": "string", "required": false, "description": "境内区域上次触发用量封顶阈值的时间 注意：此字段可能返回 null，表示取不到有效值。", "example": "2023-06-28 12:00:00" }, { "name": "AlertSwitch", "type": "string", "required": false, "description": "用量封顶提醒配置开关，取值有： on：开启 off：关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" }, { "name": "AlertPercentage", "type": "integer", "required": false, "description": "用量封顶阈值提醒百分比 注意：此字段可能返回 null，表示取不到有效值。", "example": "80" }, { "name": "LastTriggerTimeOverseas", "type": "string", "required": false, "description": "海外区域上次触发用量封顶阈值的时间 注意：此字段可能返回 null，表示取不到有效值。", "example": "2023-06-28 12:00:00" }, { "name": "Metric", "type": "string", "required": false, "description": "用量阈值触发的维度 带宽：bandwidth 流量：flux 注意：此字段可能返回 null，表示取不到有效值。", "example": "bandwith" }, { "name": "StatisticItems", "type": "array", "required": false, "description": "累计用量配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" } ] }, { "name": "Cache", "type": "object", "required": false, "description": "缓存规则配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "SimpleCache", "type": "object", "required": false, "description": "基础缓存过期时间配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "AdvancedCache", "type": "object", "required": false, "description": "高级缓存过期时间配置（已弃用） 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "RuleCache", "type": "array", "required": false, "description": "高级路径缓存配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" } ] }, { "name": "CacheKey", "type": "object", "required": false, "description": "缓存相关配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "FullUrlCache", "type": "string", "required": false, "description": "是否开启全路径缓存 on：开启全路径缓存（即关闭参数忽略） off：关闭全路径缓存（即开启参数忽略）", "example": "off" }, { "name": "IgnoreCase", "type": "string", "required": false, "description": "是否忽略大小写缓存 on：开启 off：关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" }, { "name": "QueryString", "type": "object", "required": false, "description": "CacheKey中包含请求参数 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "Cookie", "type": "object", "required": false, "description": "CacheKey中包含Cookie 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "Header", "type": "object", "required": false, "description": "CacheKey中包含请求头部 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "CacheTag", "type": "object", "required": false, "description": "CacheKey中包含自定义字符串 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "Scheme", "type": "object", "required": false, "description": "CacheKey中包含请求协议 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "KeyRules", "type": "array", "required": false, "description": "分路径缓存键配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" } ] }, { "name": "Compression", "type": "object", "required": false, "description": "智能压缩配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "智能压缩配置开关，取值有： on：开启 off：关闭", "example": "on" }, { "name": "CompressionRules", "type": "array", "required": false, "description": "压缩规则数组 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" } ] }, { "name": "DownstreamCapping", "type": "object", "required": false, "description": "下载限速配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "下行速度配置开关，取值有： on：开启 off：关闭", "example": "off" }, { "name": "CappingRules", "type": "array", "required": false, "description": "下行限速规则 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" } ] }, { "name": "ErrorPage", "type": "object", "required": false, "description": "错误码重定向配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "状态码重定向配置开关，取值有： on：开启 off：关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" }, { "name": "PageRules", "type": "array", "required": false, "description": "状态码重定向规则配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" } ] }, { "name": "FollowRedirect", "type": "object", "required": false, "description": "301和302自动回源跟随配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "回源跟随配置开关，取值有： on：开启 off：关闭", "example": "off" }, { "name": "RedirectConfig", "type": "object", "required": false, "description": "自定义回源302 follow请求host配置，该功能为白名单功能，需要开启请联系腾讯云工程师。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" } ] }, { "name": "ForceRedirect", "type": "object", "required": false, "description": "访问协议强制跳转配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "访问强制跳转配置开关，取值有： on：开启 off：关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" }, { "name": "RedirectType", "type": "string", "required": false, "description": "访问强制跳转类型 http：强制 http 跳转 https：强制 https 跳转 注意：此字段可能返回 null，表示取不到有效值。", "example": "http" }, { "name": "RedirectStatusCode", "type": "integer", "required": false, "description": "强制跳转时返回状态码 支持 301、302、307、308 注意：此字段可能返回 null，表示取不到有效值。", "example": "302" }, { "name": "CarryHeaders", "type": "string", "required": false, "description": "强制跳转时是否返回增加的头部。 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" } ] }, { "name": "Https", "type": "object", "required": false, "description": "Https配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "https 配置开关，取值有： on：开启 off：关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "on" }, { "name": "Http2", "type": "string", "required": false, "description": "http2 配置开关 on：开启 off：关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "on" }, { "name": "OcspStapling", "type": "string", "required": false, "description": "OCSP 配置开关 on：开启 off：关闭 默认为关闭状态 注意：此字段可能返回 null，表示取不到有效值。", "example": "on" }, { "name": "VerifyClient", "type": "string", "required": false, "description": "客户端证书校验功能 on：开启 off：关闭 默认为关闭状态，开启时需要上传客户端证书信息，该配置项目前在灰度中，尚未全量 注意：此字段可能返回 null，表示取不到有效值。", "example": "on" }, { "name": "CertInfo", "type": "object", "required": false, "description": "服务端证书配置信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "ClientCertInfo", "type": "object", "required": false, "description": "客户端证书配置信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "Spdy", "type": "string", "required": false, "description": "Spdy 配置开关 on：开启 off：关闭 默认为关闭状态 注意：此字段可能返回 null，表示取不到有效值。", "example": "on" }, { "name": "SslStatus", "type": "string", "required": false, "description": "https 证书部署状态 closed：已关闭 deploying：部署中 deployed：部署成功 failed：部署失败 注意：此字段可能返回 null，表示取不到有效值。", "example": "closed" }, { "name": "Hsts", "type": "object", "required": false, "description": "Hsts配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "TlsVersion", "type": "array", "required": false, "description": "Tls版本设置，仅支持部分Advance域名，支持设置 TLSv1, TLSv1.1, TLSv1.2, TLSv1.3，修改时必须开启连续的版本 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"TLSv1\"]", "item_type": "string" } ] }, { "name": "IpFilter", "type": "object", "required": false, "description": "IP黑白名单配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "IP 黑白名单配置开关，取值有 on：开启 off：关闭", "example": "on" }, { "name": "FilterType", "type": "string", "required": false, "description": "IP 黑白名单类型 whitelist：白名单 blacklist：黑名单 注意：此字段可能返回 null，表示取不到有效值。", "example": "blacklist" }, { "name": "Filters", "type": "array", "required": false, "description": "IP 黑白名单列表 支持 X.X.X.X 格式IPV4地址 或X:X:X:X:X:X:X:X 格式IPV6地址， 或网段格式/X（IPV4:1≤X≤32；IPV6:1≤X≤128） 最多可填充 200 个白名单或 200 个黑名单； 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"1.1.1.1\"]", "item_type": "string" }, { "name": "FilterRules", "type": "array", "required": false, "description": "IP 黑白名单分路径配置。黑白名单 IP 总数不能超过 1000 个。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "ReturnCode", "type": "integer", "required": false, "description": "IP 黑白名单验证失败时返回的状态码。 注意： 请求拒绝时，平台默认响应514状态。 支持自定义为403，404，609状态码，空值时或自定义的不在范围内，均默认为514. 非514状态码将计入HTTPS计费统计，最终账单将按您的计费规则生成。 若您开启了自定义状态码，则默认您认同HTTPS计费规则。 注意：此字段可能返回 null，表示取不到有效值。", "example": "514" } ] }, { "name": "IpFreqLimit", "type": "object", "required": false, "description": "IP限频配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "IP 限频配置开关，取值有： on：开启 off：关闭", "example": "off" }, { "name": "Qps", "type": "integer", "required": false, "description": "设置每秒请求数限制 超出限制的请求会直接返回 514 注意：此字段可能返回 null，表示取不到有效值。", "example": "20" } ] }, { "name": "MaxAge", "type": "object", "required": false, "description": "浏览器缓存规则配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "浏览器缓存配置开关，取值有： on：开启 off：关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" }, { "name": "MaxAgeRules", "type": "array", "required": false, "description": "MaxAge 规则 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "MaxAgeCodeRule", "type": "object", "required": false, "description": "MaxAge 状态码相关规则 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" } ] }, { "name": "Origin", "type": "object", "required": false, "description": "源站配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Origins", "type": "array", "required": false, "description": "主源站列表 修改源站时，需要同时填充对应的 OriginType 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"1.1.1.1\"]", "item_type": "string" }, { "name": "OriginType", "type": "string", "required": false, "description": "主源站类型 当源站列表 Origins 不为空时必填 入参支持以下几种类型： domain：域名类型 domainv6：域名解析V6类型 cos：对象存储源站 third_party: 第三方存储源站 igtm: IGTM多活源 ip：IP 列表作为源站 ipv6：源站列表为一个单独的 IPv6 地址 ip_ipv6：源站列表为多个 IPv4 地址和IPv6 地址 ip_domain: 支持IP和域名形式源站混填（白名单功能） ip_domainv6：源站列表为多个 IPv4 地址以及域名解析v6地...", "example": "ip" }, { "name": "ServerName", "type": "string", "required": false, "description": "回主源站时 Host 头部 当源站类型为cos或者第三方存储加速时,ServerName字段必填 不填充则默认为加速域名 若接入的是泛域名，则回源 Host 默认为访问时的子域名 注意：此字段可能返回 null，表示取不到有效值。", "example": "www.test.com" }, { "name": "CosPrivateAccess", "type": "string", "required": false, "description": "OriginType 为对象存储（COS）时，可以指定是否允许访问私有 bucket 注意：需要先授权 CDN 访问该私有 Bucket 的权限后，才可开启此配置。取值范围: on/off 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" }, { "name": "OriginPullProtocol", "type": "string", "required": false, "description": "回源协议配置 http：强制 http 回源 follow：协议跟随回源 https：强制 https 回源 注意：此字段可能返回 null，表示取不到有效值。", "example": "http" }, { "name": "BackupOrigins", "type": "array", "required": false, "description": "备源站列表 修改备源站时，需要同时填充对应的 BackupOriginType 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"2.2.2.2\"]", "item_type": "string" }, { "name": "BackupOriginType", "type": "string", "required": false, "description": "备源站类型 备源站列表BackupOrigins 不为空时必填 支持以下类型： domain：域名类型 ip：IP 列表作为源站 以下备源源站类型尚未全量支持，需要申请试用： ipv6_domain: 源站列表为多个 IPv6 地址以及域名 ip_ipv6：源站列表为多个 IPv4 地址和IPv6 地址 ip_ipv6_domain：源站列表为多个 IPv4 地址IPv6 地址以及域名 注意：此字段可能返回 null，表示取不到有效值。", "example": "ip" }, { "name": "BackupServerName", "type": "string", "required": false, "description": "回备源站时 Host 头部，不填充则默认为主源站的 ServerName 注意：此字段可能返回 null，表示取不到有效值。", "example": "www.test2.com" }, { "name": "BasePath", "type": "string", "required": false, "description": "回源路径 注意：此字段可能返回 null，表示取不到有效值。", "example": "/data" }, { "name": "PathRules", "type": "array", "required": false, "description": "回源路径重写规则配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "PathBasedOrigin", "type": "array", "required": false, "description": "分路径回源配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "Sni", "type": "object", "required": false, "description": "HTTPS回源SNI配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "AdvanceHttps", "type": "object", "required": false, "description": "HTTPS回源高级配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "OriginCompany", "type": "string", "required": false, "description": "对象存储回源厂商 当源站类型为第三方存储源站(third_party)时必填 可选值包括以下: aws_s3: AWS S3 ali_oss: 阿里云 OSS hw_obs: 华为 OBS qiniu_kodo: 七牛云 kodo others: 其它厂商对象存储,仅支持兼容以AWS签名算法的对象存储，如腾讯云金融专区COS 注意：此字段可能返回 null，表示取不到有效值。", "example": "hw-oss" } ] }, { "name": "OriginPullOptimization", "type": "object", "required": false, "description": "跨国优化配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "跨国回源优化配置开关，取值有： on：开启 off：关闭", "example": "on" }, { "name": "OptimizationType", "type": "string", "required": false, "description": "跨国类型 OVToCN：境外回源境内 CNToOV：境内回源境外 注意：此字段可能返回 null，表示取不到有效值。", "example": "OVToCN" } ] }, { "name": "RangeOriginPull", "type": "object", "required": false, "description": "Range回源配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "分片回源配置开关，取值有： on：开启 off：关闭", "example": "on" }, { "name": "RangeRules", "type": "array", "required": false, "description": "分路径分片回源配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "[{\"Switch\":\"on\",\"RuleType\":\"file\",\"RulePaths\":[\"jpg\"]}]", "item_type": "string" } ] }, { "name": "Referer", "type": "object", "required": false, "description": "防盗链配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "referer 黑白名单配置开关，取值有： on：开启 off：关闭", "example": "off" }, { "name": "RefererRules", "type": "array", "required": false, "description": "referer 黑白名单配置规则 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" } ] }, { "name": "RequestHeader", "type": "object", "required": false, "description": "回源请求头部配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "自定义请求头配置开关，取值有： on：开启 off：关闭", "example": "off" }, { "name": "HeaderRules", "type": "array", "required": false, "description": "自定义请求头配置规则 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" } ] }, { "name": "ResponseHeader", "type": "object", "required": false, "description": "源站响应头部配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "自定义响应头配置开关，取值有： on：开启 off：关闭", "example": "off" }, { "name": "HeaderRules", "type": "array", "required": false, "description": "自定义响应头规则 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" } ] }, { "name": "ResponseHeaderCache", "type": "object", "required": false, "description": "遵循源站缓存头部配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "源站头部缓存配置开关，取值有： on：开启 off：关闭", "example": "off" } ] }, { "name": "Seo", "type": "object", "required": false, "description": "seo优化配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "SEO 搜索引擎优化配置开关，取值有： on：开启 off：关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" } ] }, { "name": "ServiceType", "type": "string", "required": false, "description": "域名业务类型，web，download，media分别表示静态加速，下载加速和流媒体加速。 注意：此字段可能返回 null，表示取不到有效值。", "example": "web" }, { "name": "StatusCodeCache", "type": "object", "required": false, "description": "状态码缓存配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "状态码缓存过期配置开关，取值有： on：开启 off：关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" }, { "name": "CacheRules", "type": "array", "required": false, "description": "状态码缓存过期规则明细 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" } ] }, { "name": "VideoSeek", "type": "object", "required": false, "description": "视频拖拽配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "视频拖拽配置开关，取值有： on：开启 off：关闭", "example": "off" } ] }, { "name": "AwsPrivateAccess", "type": "object", "required": false, "description": "回源S3私有鉴权。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "s3源站回源鉴权配置项开关，取值有： on：开启 off：关闭", "example": "on" }, { "name": "AccessKey", "type": "string", "required": false, "description": "访问ID。 注意：此字段可能返回 null，表示取不到有效值。", "example": "dfss12nk" }, { "name": "SecretKey", "type": "string", "required": false, "description": "密钥，字段为脱敏返回。 注意：此字段可能返回 null，表示取不到有效值。", "example": "wn***************mg" }, { "name": "Region", "type": "string", "required": false, "description": "地域 注意：此字段可能返回 null，表示取不到有效值。", "example": "gz" }, { "name": "Bucket", "type": "string", "required": false, "description": "Bucketname 注意：此字段可能返回 null，表示取不到有效值。", "example": "hw-oss" } ] }, { "name": "OssPrivateAccess", "type": "object", "required": false, "description": "回源OSS私有鉴权。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "oss回源鉴权配置开关，取值有： on：开启 off：关闭", "example": "on" }, { "name": "AccessKey", "type": "string", "required": false, "description": "访问ID。 注意：此字段可能返回 null，表示取不到有效值。", "example": "AKkjqrfjaoidn" }, { "name": "SecretKey", "type": "string", "required": false, "description": "密钥，字段为脱敏返回。 注意：此字段可能返回 null，表示取不到有效值。", "example": "wn***************mg\t" }, { "name": "Region", "type": "string", "required": false, "description": "地域 注意：此字段可能返回 null，表示取不到有效值。", "example": "gz" }, { "name": "Bucket", "type": "string", "required": false, "description": "Bucketname 注意：此字段可能返回 null，表示取不到有效值。", "example": "hw-oss" } ] }, { "name": "HwPrivateAccess", "type": "object", "required": false, "description": "华为云对象存储回源鉴权 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "华为云对象存储回源鉴权配置开关，取值有： on：开启 off：关闭", "example": "on" }, { "name": "AccessKey", "type": "string", "required": false, "description": "访问 ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "SYWKY0DAR8I5NXZO93YT" }, { "name": "SecretKey", "type": "string", "required": false, "description": "密钥，字段为脱敏返回。 注意：此字段可能返回 null，表示取不到有效值。", "example": "wn***************mg" }, { "name": "Bucket", "type": "string", "required": false, "description": "bucketname 注意：此字段可能返回 null，表示取不到有效值。", "example": "hw-1-163" } ] }, { "name": "QnPrivateAccess", "type": "object", "required": false, "description": "七牛云对象存储回源鉴权 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "七牛元对象存储回源鉴权配置开关，取值有： on：开启 off：关闭", "example": "on" }, { "name": "AccessKey", "type": "string", "required": false, "description": "访问 ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "ousbDM5xlzuAZJEhhwcLj8makXkYiaAvciZHqAQj" }, { "name": "SecretKey", "type": "string", "required": false, "description": "密钥，字段为脱敏返回。", "example": "wn***************mg" } ] } ] }, { "name": "Overseas", "type": "object", "required": false, "description": "海外特殊配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "null", "children": [ { "name": "Authentication", "type": "object", "required": false, "description": "时间戳防盗链配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "防盗链配置开关，取值有： on：开启 off：关闭 开启时必须且只配置一种模式，其余模式需要设置为 null", "example": "off" }, { "name": "AuthAlgorithm", "type": "string", "required": false, "description": "鉴权算法，取值有： md5：按MD5算法取hash值 sha256：按SHA-256算法取hash值 默认为 md5 注意：此字段可能返回 null，表示取不到有效值。", "example": "md5" }, { "name": "TypeA", "type": "object", "required": false, "description": "时间戳防盗链模式 A 配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "TypeB", "type": "object", "required": false, "description": "时间戳防盗链模式 B 配置（模式 B 后台升级中，暂时不支持配置） 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "TypeC", "type": "object", "required": false, "description": "时间戳防盗链模式 C 配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "TypeD", "type": "object", "required": false, "description": "时间戳防盗链模式 D 配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" } ] }, { "name": "BandwidthAlert", "type": "object", "required": false, "description": "带宽封顶配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "用量封顶配置开关，取值有： on：开启 off：关闭", "example": "off" }, { "name": "BpsThreshold", "type": "integer", "required": false, "description": "用量封顶阈值，带宽单位为bps，流量单位byte 注意：此字段可能返回 null，表示取不到有效值。", "example": "1000000" }, { "name": "CounterMeasure", "type": "string", "required": false, "description": "达到阈值后的操作 RETURN_404：全部请求返回 404 注意：此字段可能返回 null，表示取不到有效值。", "example": "RETURN_404" }, { "name": "LastTriggerTime", "type": "string", "required": false, "description": "境内区域上次触发用量封顶阈值的时间 注意：此字段可能返回 null，表示取不到有效值。", "example": "2023-06-28 12:00:00" }, { "name": "AlertSwitch", "type": "string", "required": false, "description": "用量封顶提醒配置开关，取值有： on：开启 off：关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" }, { "name": "AlertPercentage", "type": "integer", "required": false, "description": "用量封顶阈值提醒百分比 注意：此字段可能返回 null，表示取不到有效值。", "example": "80" }, { "name": "LastTriggerTimeOverseas", "type": "string", "required": false, "description": "海外区域上次触发用量封顶阈值的时间 注意：此字段可能返回 null，表示取不到有效值。", "example": "2023-06-28 12:00:00" }, { "name": "Metric", "type": "string", "required": false, "description": "用量阈值触发的维度 带宽：bandwidth 流量：flux 注意：此字段可能返回 null，表示取不到有效值。", "example": "bandwith" }, { "name": "StatisticItems", "type": "array", "required": false, "description": "累计用量配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" } ] }, { "name": "Cache", "type": "object", "required": false, "description": "缓存规则配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "SimpleCache", "type": "object", "required": false, "description": "基础缓存过期时间配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "AdvancedCache", "type": "object", "required": false, "description": "高级缓存过期时间配置（已弃用） 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "RuleCache", "type": "array", "required": false, "description": "高级路径缓存配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" } ] }, { "name": "CacheKey", "type": "object", "required": false, "description": "缓存相关配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "FullUrlCache", "type": "string", "required": false, "description": "是否开启全路径缓存 on：开启全路径缓存（即关闭参数忽略） off：关闭全路径缓存（即开启参数忽略）", "example": "off" }, { "name": "IgnoreCase", "type": "string", "required": false, "description": "是否忽略大小写缓存 on：开启 off：关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" }, { "name": "QueryString", "type": "object", "required": false, "description": "CacheKey中包含请求参数 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "Cookie", "type": "object", "required": false, "description": "CacheKey中包含Cookie 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "Header", "type": "object", "required": false, "description": "CacheKey中包含请求头部 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "CacheTag", "type": "object", "required": false, "description": "CacheKey中包含自定义字符串 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "Scheme", "type": "object", "required": false, "description": "CacheKey中包含请求协议 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "KeyRules", "type": "array", "required": false, "description": "分路径缓存键配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" } ] }, { "name": "Compression", "type": "object", "required": false, "description": "智能压缩配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "智能压缩配置开关，取值有： on：开启 off：关闭", "example": "on" }, { "name": "CompressionRules", "type": "array", "required": false, "description": "压缩规则数组 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" } ] }, { "name": "DownstreamCapping", "type": "object", "required": false, "description": "下载限速配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "下行速度配置开关，取值有： on：开启 off：关闭", "example": "off" }, { "name": "CappingRules", "type": "array", "required": false, "description": "下行限速规则 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" } ] }, { "name": "ErrorPage", "type": "object", "required": false, "description": "错误码重定向配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "状态码重定向配置开关，取值有： on：开启 off：关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" }, { "name": "PageRules", "type": "array", "required": false, "description": "状态码重定向规则配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" } ] }, { "name": "FollowRedirect", "type": "object", "required": false, "description": "301和302自动回源跟随配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "回源跟随配置开关，取值有： on：开启 off：关闭", "example": "off" }, { "name": "RedirectConfig", "type": "object", "required": false, "description": "自定义回源302 follow请求host配置，该功能为白名单功能，需要开启请联系腾讯云工程师。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" } ] }, { "name": "ForceRedirect", "type": "object", "required": false, "description": "访问协议强制跳转配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "访问强制跳转配置开关，取值有： on：开启 off：关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" }, { "name": "RedirectType", "type": "string", "required": false, "description": "访问强制跳转类型 http：强制 http 跳转 https：强制 https 跳转 注意：此字段可能返回 null，表示取不到有效值。", "example": "http" }, { "name": "RedirectStatusCode", "type": "integer", "required": false, "description": "强制跳转时返回状态码 支持 301、302、307、308 注意：此字段可能返回 null，表示取不到有效值。", "example": "302" }, { "name": "CarryHeaders", "type": "string", "required": false, "description": "强制跳转时是否返回增加的头部。 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" } ] }, { "name": "Https", "type": "object", "required": false, "description": "Https配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "https 配置开关，取值有： on：开启 off：关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "on" }, { "name": "Http2", "type": "string", "required": false, "description": "http2 配置开关 on：开启 off：关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "on" }, { "name": "OcspStapling", "type": "string", "required": false, "description": "OCSP 配置开关 on：开启 off：关闭 默认为关闭状态 注意：此字段可能返回 null，表示取不到有效值。", "example": "on" }, { "name": "VerifyClient", "type": "string", "required": false, "description": "客户端证书校验功能 on：开启 off：关闭 默认为关闭状态，开启时需要上传客户端证书信息，该配置项目前在灰度中，尚未全量 注意：此字段可能返回 null，表示取不到有效值。", "example": "on" }, { "name": "CertInfo", "type": "object", "required": false, "description": "服务端证书配置信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "ClientCertInfo", "type": "object", "required": false, "description": "客户端证书配置信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "Spdy", "type": "string", "required": false, "description": "Spdy 配置开关 on：开启 off：关闭 默认为关闭状态 注意：此字段可能返回 null，表示取不到有效值。", "example": "on" }, { "name": "SslStatus", "type": "string", "required": false, "description": "https 证书部署状态 closed：已关闭 deploying：部署中 deployed：部署成功 failed：部署失败 注意：此字段可能返回 null，表示取不到有效值。", "example": "closed" }, { "name": "Hsts", "type": "object", "required": false, "description": "Hsts配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "TlsVersion", "type": "array", "required": false, "description": "Tls版本设置，仅支持部分Advance域名，支持设置 TLSv1, TLSv1.1, TLSv1.2, TLSv1.3，修改时必须开启连续的版本 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"TLSv1\"]", "item_type": "string" } ] }, { "name": "IpFilter", "type": "object", "required": false, "description": "IP黑白名单配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "IP 黑白名单配置开关，取值有 on：开启 off：关闭", "example": "on" }, { "name": "FilterType", "type": "string", "required": false, "description": "IP 黑白名单类型 whitelist：白名单 blacklist：黑名单 注意：此字段可能返回 null，表示取不到有效值。", "example": "blacklist" }, { "name": "Filters", "type": "array", "required": false, "description": "IP 黑白名单列表 支持 X.X.X.X 格式IPV4地址 或X:X:X:X:X:X:X:X 格式IPV6地址， 或网段格式/X（IPV4:1≤X≤32；IPV6:1≤X≤128） 最多可填充 200 个白名单或 200 个黑名单； 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"1.1.1.1\"]", "item_type": "string" }, { "name": "FilterRules", "type": "array", "required": false, "description": "IP 黑白名单分路径配置。黑白名单 IP 总数不能超过 1000 个。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "ReturnCode", "type": "integer", "required": false, "description": "IP 黑白名单验证失败时返回的状态码。 注意： 请求拒绝时，平台默认响应514状态。 支持自定义为403，404，609状态码，空值时或自定义的不在范围内，均默认为514. 非514状态码将计入HTTPS计费统计，最终账单将按您的计费规则生成。 若您开启了自定义状态码，则默认您认同HTTPS计费规则。 注意：此字段可能返回 null，表示取不到有效值。", "example": "514" } ] }, { "name": "IpFreqLimit", "type": "object", "required": false, "description": "IP限频配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "IP 限频配置开关，取值有： on：开启 off：关闭", "example": "off" }, { "name": "Qps", "type": "integer", "required": false, "description": "设置每秒请求数限制 超出限制的请求会直接返回 514 注意：此字段可能返回 null，表示取不到有效值。", "example": "20" } ] }, { "name": "MaxAge", "type": "object", "required": false, "description": "浏览器缓存规则配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "浏览器缓存配置开关，取值有： on：开启 off：关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" }, { "name": "MaxAgeRules", "type": "array", "required": false, "description": "MaxAge 规则 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "MaxAgeCodeRule", "type": "object", "required": false, "description": "MaxAge 状态码相关规则 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" } ] }, { "name": "Origin", "type": "object", "required": false, "description": "源站配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Origins", "type": "array", "required": false, "description": "主源站列表 修改源站时，需要同时填充对应的 OriginType 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"1.1.1.1\"]", "item_type": "string" }, { "name": "OriginType", "type": "string", "required": false, "description": "主源站类型 当源站列表 Origins 不为空时必填 入参支持以下几种类型： domain：域名类型 domainv6：域名解析V6类型 cos：对象存储源站 third_party: 第三方存储源站 igtm: IGTM多活源 ip：IP 列表作为源站 ipv6：源站列表为一个单独的 IPv6 地址 ip_ipv6：源站列表为多个 IPv4 地址和IPv6 地址 ip_domain: 支持IP和域名形式源站混填（白名单功能） ip_domainv6：源站列表为多个 IPv4 地址以及域名解析v6地...", "example": "ip" }, { "name": "ServerName", "type": "string", "required": false, "description": "回主源站时 Host 头部 当源站类型为cos或者第三方存储加速时,ServerName字段必填 不填充则默认为加速域名 若接入的是泛域名，则回源 Host 默认为访问时的子域名 注意：此字段可能返回 null，表示取不到有效值。", "example": "www.test.com" }, { "name": "CosPrivateAccess", "type": "string", "required": false, "description": "OriginType 为对象存储（COS）时，可以指定是否允许访问私有 bucket 注意：需要先授权 CDN 访问该私有 Bucket 的权限后，才可开启此配置。取值范围: on/off 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" }, { "name": "OriginPullProtocol", "type": "string", "required": false, "description": "回源协议配置 http：强制 http 回源 follow：协议跟随回源 https：强制 https 回源 注意：此字段可能返回 null，表示取不到有效值。", "example": "http" }, { "name": "BackupOrigins", "type": "array", "required": false, "description": "备源站列表 修改备源站时，需要同时填充对应的 BackupOriginType 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"2.2.2.2\"]", "item_type": "string" }, { "name": "BackupOriginType", "type": "string", "required": false, "description": "备源站类型 备源站列表BackupOrigins 不为空时必填 支持以下类型： domain：域名类型 ip：IP 列表作为源站 以下备源源站类型尚未全量支持，需要申请试用： ipv6_domain: 源站列表为多个 IPv6 地址以及域名 ip_ipv6：源站列表为多个 IPv4 地址和IPv6 地址 ip_ipv6_domain：源站列表为多个 IPv4 地址IPv6 地址以及域名 注意：此字段可能返回 null，表示取不到有效值。", "example": "ip" }, { "name": "BackupServerName", "type": "string", "required": false, "description": "回备源站时 Host 头部，不填充则默认为主源站的 ServerName 注意：此字段可能返回 null，表示取不到有效值。", "example": "www.test2.com" }, { "name": "BasePath", "type": "string", "required": false, "description": "回源路径 注意：此字段可能返回 null，表示取不到有效值。", "example": "/data" }, { "name": "PathRules", "type": "array", "required": false, "description": "回源路径重写规则配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "PathBasedOrigin", "type": "array", "required": false, "description": "分路径回源配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "Sni", "type": "object", "required": false, "description": "HTTPS回源SNI配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "AdvanceHttps", "type": "object", "required": false, "description": "HTTPS回源高级配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "OriginCompany", "type": "string", "required": false, "description": "对象存储回源厂商 当源站类型为第三方存储源站(third_party)时必填 可选值包括以下: aws_s3: AWS S3 ali_oss: 阿里云 OSS hw_obs: 华为 OBS qiniu_kodo: 七牛云 kodo others: 其它厂商对象存储,仅支持兼容以AWS签名算法的对象存储，如腾讯云金融专区COS 注意：此字段可能返回 null，表示取不到有效值。", "example": "hw-oss" } ] }, { "name": "OriginPullOptimization", "type": "object", "required": false, "description": "跨国优化配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "跨国回源优化配置开关，取值有： on：开启 off：关闭", "example": "on" }, { "name": "OptimizationType", "type": "string", "required": false, "description": "跨国类型 OVToCN：境外回源境内 CNToOV：境内回源境外 注意：此字段可能返回 null，表示取不到有效值。", "example": "OVToCN" } ] }, { "name": "RangeOriginPull", "type": "object", "required": false, "description": "Range回源配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "分片回源配置开关，取值有： on：开启 off：关闭", "example": "on" }, { "name": "RangeRules", "type": "array", "required": false, "description": "分路径分片回源配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "[{\"Switch\":\"on\",\"RuleType\":\"file\",\"RulePaths\":[\"jpg\"]}]", "item_type": "string" } ] }, { "name": "Referer", "type": "object", "required": false, "description": "防盗链配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "referer 黑白名单配置开关，取值有： on：开启 off：关闭", "example": "off" }, { "name": "RefererRules", "type": "array", "required": false, "description": "referer 黑白名单配置规则 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" } ] }, { "name": "RequestHeader", "type": "object", "required": false, "description": "回源请求头部配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "自定义请求头配置开关，取值有： on：开启 off：关闭", "example": "off" }, { "name": "HeaderRules", "type": "array", "required": false, "description": "自定义请求头配置规则 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" } ] }, { "name": "ResponseHeader", "type": "object", "required": false, "description": "源站响应头部配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "自定义响应头配置开关，取值有： on：开启 off：关闭", "example": "off" }, { "name": "HeaderRules", "type": "array", "required": false, "description": "自定义响应头规则 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" } ] }, { "name": "ResponseHeaderCache", "type": "object", "required": false, "description": "遵循源站缓存头部配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "源站头部缓存配置开关，取值有： on：开启 off：关闭", "example": "off" } ] }, { "name": "Seo", "type": "object", "required": false, "description": "seo优化配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "SEO 搜索引擎优化配置开关，取值有： on：开启 off：关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" } ] }, { "name": "ServiceType", "type": "string", "required": false, "description": "域名业务类型，web，download，media分别表示静态加速，下载加速和流媒体加速。 注意：此字段可能返回 null，表示取不到有效值。", "example": "web" }, { "name": "StatusCodeCache", "type": "object", "required": false, "description": "状态码缓存配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "状态码缓存过期配置开关，取值有： on：开启 off：关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" }, { "name": "CacheRules", "type": "array", "required": false, "description": "状态码缓存过期规则明细 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" } ] }, { "name": "VideoSeek", "type": "object", "required": false, "description": "视频拖拽配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "视频拖拽配置开关，取值有： on：开启 off：关闭", "example": "off" } ] }, { "name": "AwsPrivateAccess", "type": "object", "required": false, "description": "回源S3私有鉴权。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "s3源站回源鉴权配置项开关，取值有： on：开启 off：关闭", "example": "on" }, { "name": "AccessKey", "type": "string", "required": false, "description": "访问ID。 注意：此字段可能返回 null，表示取不到有效值。", "example": "dfss12nk" }, { "name": "SecretKey", "type": "string", "required": false, "description": "密钥，字段为脱敏返回。 注意：此字段可能返回 null，表示取不到有效值。", "example": "wn***************mg" }, { "name": "Region", "type": "string", "required": false, "description": "地域 注意：此字段可能返回 null，表示取不到有效值。", "example": "gz" }, { "name": "Bucket", "type": "string", "required": false, "description": "Bucketname 注意：此字段可能返回 null，表示取不到有效值。", "example": "hw-oss" } ] }, { "name": "OssPrivateAccess", "type": "object", "required": false, "description": "回源OSS私有鉴权。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "oss回源鉴权配置开关，取值有： on：开启 off：关闭", "example": "on" }, { "name": "AccessKey", "type": "string", "required": false, "description": "访问ID。 注意：此字段可能返回 null，表示取不到有效值。", "example": "AKkjqrfjaoidn" }, { "name": "SecretKey", "type": "string", "required": false, "description": "密钥，字段为脱敏返回。 注意：此字段可能返回 null，表示取不到有效值。", "example": "wn***************mg\t" }, { "name": "Region", "type": "string", "required": false, "description": "地域 注意：此字段可能返回 null，表示取不到有效值。", "example": "gz" }, { "name": "Bucket", "type": "string", "required": false, "description": "Bucketname 注意：此字段可能返回 null，表示取不到有效值。", "example": "hw-oss" } ] }, { "name": "HwPrivateAccess", "type": "object", "required": false, "description": "华为云对象存储鉴权 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "华为云对象存储回源鉴权配置开关，取值有： on：开启 off：关闭", "example": "on" }, { "name": "AccessKey", "type": "string", "required": false, "description": "访问 ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "SYWKY0DAR8I5NXZO93YT" }, { "name": "SecretKey", "type": "string", "required": false, "description": "密钥，字段为脱敏返回。 注意：此字段可能返回 null，表示取不到有效值。", "example": "wn***************mg" }, { "name": "Bucket", "type": "string", "required": false, "description": "bucketname 注意：此字段可能返回 null，表示取不到有效值。", "example": "hw-1-163" } ] }, { "name": "QnPrivateAccess", "type": "object", "required": false, "description": "七牛云对象存储鉴权 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "七牛元对象存储回源鉴权配置开关，取值有： on：开启 off：关闭", "example": "on" }, { "name": "AccessKey", "type": "string", "required": false, "description": "访问 ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "ousbDM5xlzuAZJEhhwcLj8makXkYiaAvciZHqAQj" }, { "name": "SecretKey", "type": "string", "required": false, "description": "密钥，字段为脱敏返回。", "example": "wn***************mg" } ] } ] } ] }, { "name": "ServiceType", "type": "string", "required": false, "description": "域名业务类型 web：静态加速 download：下载加速 media：流媒体点播加速", "example": "web" }, { "name": "Area", "type": "string", "required": false, "description": "域名加速区域 mainland：中国境内加速 overseas：中国境外加速 global：全球加速 从mainland/overseas修改至global时，域名的配置将被同步至overseas/mainland。若域名含有后端特殊配置，此类配置的同步过程有一定延时，请耐心等待", "example": "mainland" }, { "name": "OriginPullTimeout", "type": "object", "required": false, "description": "回源超时配置", "example": "无", "children": [ { "name": "ConnectTimeout", "type": "integer", "required": true, "description": "回源建连超时时间，单位为秒，要求5~60之间 注意：此字段可能返回 null，表示取不到有效值。", "example": "5" }, { "name": "ReceiveTimeout", "type": "integer", "required": true, "description": "回源接收超时时间，单位为秒，要求10 ~ 300之间 注意：此字段可能返回 null，表示取不到有效值。", "example": "30" } ] }, { "name": "AwsPrivateAccess", "type": "object", "required": false, "description": "回源S3私有鉴权", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "s3源站回源鉴权配置项开关，取值有： on：开启 off：关闭", "example": "on" }, { "name": "AccessKey", "type": "string", "required": false, "description": "访问ID。 注意：此字段可能返回 null，表示取不到有效值。", "example": "dfss12nk" }, { "name": "SecretKey", "type": "string", "required": false, "description": "密钥，字段为脱敏返回。 注意：此字段可能返回 null，表示取不到有效值。", "example": "wn***************mg" }, { "name": "Region", "type": "string", "required": false, "description": "地域 注意：此字段可能返回 null，表示取不到有效值。", "example": "gz" }, { "name": "Bucket", "type": "string", "required": false, "description": "Bucketname 注意：此字段可能返回 null，表示取不到有效值。", "example": "hw-oss" } ] }, { "name": "UserAgentFilter", "type": "object", "required": false, "description": "UA黑白名单配置", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "UserAgent黑白名单配置开关，取值有： on：开启 off：关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" }, { "name": "FilterRules", "type": "array", "required": false, "description": "UA黑白名单生效规则列表，不能超过10条规则 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "RuleType", "type": "string", "required": true, "description": "访问路径生效类型 all: 所有访问路径生效 file: 根据文件后缀类型生效 directory: 根据目录生效 path: 根据完整访问路径生效 注意：此字段可能返回 null，表示取不到有效值。", "example": "file" }, { "name": "RulePaths", "type": "array", "required": true, "description": "访问路径生效内容 注意：此字段可能返回 null，表示取不到有效值。", "example": "jpg", "item_type": "string" }, { "name": "UserAgents", "type": "array", "required": true, "description": "UserAgent列表，UserAgent 个数不能超过 10个 注意：此字段可能返回 null，表示取不到有效值。", "example": "curl/7.68.0", "item_type": "string" }, { "name": "FilterType", "type": "string", "required": true, "description": "黑名单或白名单，blacklist或whitelist 注意：此字段可能返回 null，表示取不到有效值。", "example": "whitelist" } ] } ] }, { "name": "AccessControl", "type": "object", "required": false, "description": "访问控制", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "启用请求头部及请求url访问控制开关，取值有： on：开启 off：关闭", "example": "off" }, { "name": "AccessControlRules", "type": "array", "required": false, "description": "请求头部及请求url访问规则 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "RuleType", "type": "string", "required": true, "description": "requestHeader ：对请求头部进行访问控制 url ： 对访问url进行访问控制 注意：此字段可能返回 null，表示取不到有效值。", "example": "requestHeader" }, { "name": "RuleContent", "type": "string", "required": true, "description": "封禁内容 注意：此字段可能返回 null，表示取不到有效值。", "example": "example" }, { "name": "Regex", "type": "string", "required": true, "description": "on ：正则匹配 off ：字面匹配 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" }, { "name": "RuleHeader", "type": "string", "required": false, "description": "RuleType为requestHeader时必填，否则不需要填 注意：此字段可能返回 null，表示取不到有效值。", "example": "X-rule" } ] }, { "name": "ReturnCode", "type": "integer", "required": false, "description": "返回状态码 注意：此字段可能返回 null，表示取不到有效值。", "example": "403" } ] }, { "name": "UrlRedirect", "type": "object", "required": false, "description": "访问URL重写配置", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "访问URL重写配置开关，取值有： on：开启 off：关闭", "example": "off" }, { "name": "PathRules", "type": "array", "required": false, "description": "访问URL重写规则，当Switch为on时必填，规则数量最大为10个。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "RedirectStatusCode", "type": "integer", "required": true, "description": "重定向状态码，301 | 302", "example": "302" }, { "name": "Pattern", "type": "string", "required": true, "description": "待匹配的Url，仅支持Url路径，不支持参数。默认完全匹配，支持通配符 *，最多支持5个通配符，最大长度1024字符。", "example": "no" }, { "name": "RedirectUrl", "type": "string", "required": true, "description": "目标URL，必须以“/”开头，不包含参数部分。最大长度1024字符。可使用$1, $2, $3, $4, $5分别捕获匹配路径中的通配符号，最多支持10个捕获值。", "example": "no" }, { "name": "RedirectHost", "type": "string", "required": false, "description": "目标host，必须以http://或https://开头，并填写标准格式域名，如果不填写，默认为http:// + 当前域名 注意：此字段可能返回 null，表示取不到有效值。", "example": "no" }, { "name": "FullMatch", "type": "boolean", "required": false, "description": "指定是全路径配置还是任意匹配 注意：此字段可能返回 null，表示取不到有效值。", "example": "false" }, { "name": "Regex", "type": "boolean", "required": false, "description": "pattern是否支持正则 注意：此字段可能返回 null，表示取不到有效值。", "example": "false" } ] } ] }, { "name": "AccessPort", "type": "array", "required": false, "description": "访问端口配置", "example": "[80,8080]", "item_type": "integer" }, { "name": "AdvancedAuthentication", "type": "object", "required": false, "description": "时间戳防盗链高级版配置，白名单功能", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "防盗链配置开关，取值有： on：开启 off：关闭 开启时必须且只配置一种模式，其余模式需要设置为 null", "example": "off" }, { "name": "TypeA", "type": "object", "required": false, "description": "时间戳防盗链高级版模式A配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "SecretKey", "type": "string", "required": true, "description": "用于计算签名的密钥，只允许字母和数字，长度6-32字节。", "example": "SK-EXAMPLE" }, { "name": "SignParam", "type": "string", "required": true, "description": "uri串中签名的字段名，字母，数字或下划线构成，同时必须以字母开头。", "example": "h" }, { "name": "TimeParam", "type": "string", "required": true, "description": "uri串中时间的字段名，字母，数字或下划线构成，同时必须以字母开头。", "example": "e" }, { "name": "ExpireTime", "type": "integer", "required": true, "description": "过期时间，单位秒。", "example": "0" }, { "name": "ExpireTimeRequired", "type": "boolean", "required": true, "description": "是否必须提供过期时间参数。", "example": "false" }, { "name": "Format", "type": "string", "required": true, "description": "URL 组成格式，如：${private_key}${schema}${host}${full_uri}。", "example": "${private_key}${schema}${host}${full_uri}" }, { "name": "TimeFormat", "type": "string", "required": true, "description": "时间格式，dec，hex分别表示十进制，十六进制。", "example": "dec" }, { "name": "FailCode", "type": "integer", "required": true, "description": "鉴权失败时返回的状态码。", "example": "403" }, { "name": "ExpireCode", "type": "integer", "required": true, "description": "链接过期时返回的状态码。", "example": "403" }, { "name": "RulePaths", "type": "array", "required": true, "description": "需要鉴权的url路径列表。", "example": "/data", "item_type": "string" }, { "name": "Transformation", "type": "integer", "required": false, "description": "保留字段。", "example": "3" } ] }, { "name": "TypeB", "type": "object", "required": false, "description": "时间戳防盗链高级版模式B配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "KeyAlpha", "type": "string", "required": true, "description": "alpha键名。", "example": "k3#ALP_2024" }, { "name": "KeyBeta", "type": "string", "required": true, "description": "beta键名。", "example": "BET@Sec_88x" }, { "name": "KeyGamma", "type": "string", "required": true, "description": "gamma键名。", "example": "GAMMA_$afe!" }, { "name": "SignParam", "type": "string", "required": true, "description": "uri串中签名的字段名，字母，数字或下划线构成，同时必须以字母开头。", "example": "sign" }, { "name": "TimeParam", "type": "string", "required": true, "description": "uri串中时间的字段名，字母，数字或下划线构成，同时必须以字母开头。", "example": "t" }, { "name": "ExpireTime", "type": "integer", "required": true, "description": "过期时间，单位秒。", "example": "3600" }, { "name": "TimeFormat", "type": "string", "required": true, "description": "时间格式，dec，hex分别表示十进制，十六进制。", "example": "dec" }, { "name": "FailCode", "type": "integer", "required": true, "description": "鉴权失败时返回的状态码。", "example": "403" }, { "name": "ExpireCode", "type": "integer", "required": true, "description": "链接过期时返回的状态码。", "example": "410" }, { "name": "RulePaths", "type": "array", "required": true, "description": "需要鉴权的url路径列表。", "example": "/data", "item_type": "string" } ] }, { "name": "TypeC", "type": "object", "required": false, "description": "时间戳防盗链高级版模式C配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "AccessKey", "type": "string", "required": true, "description": "访问密钥。", "example": "AKIDz8dbsf3pJ9a1XqN" }, { "name": "SecretKey", "type": "string", "required": true, "description": "鉴权密钥。", "example": "S8fKj3#WpQ2mL9Zx!" } ] }, { "name": "TypeD", "type": "object", "required": false, "description": "时间戳防盗链高级版模式D配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "SecretKey", "type": "string", "required": true, "description": "用于计算签名的密钥，只允许字母和数字，长度6-32字节。", "example": "PrimeKey2024" }, { "name": "BackupSecretKey", "type": "string", "required": true, "description": "备份密钥，当使用SecretKey鉴权失败时会使用该密钥重新鉴权。", "example": "BakKey#5678" }, { "name": "SignParam", "type": "string", "required": true, "description": "uri串中签名的字段名，字母，数字或下划线构成，同时必须以字母开头。", "example": "signature" }, { "name": "TimeParam", "type": "string", "required": true, "description": "uri串中时间的字段名，字母，数字或下划线构成，同时必须以字母开头。", "example": "timestamp" }, { "name": "ExpireTime", "type": "integer", "required": true, "description": "过期时间，单位秒。", "example": "1800" }, { "name": "TimeFormat", "type": "string", "required": true, "description": "时间格式，dec，hex分别表示十进制，十六进制。", "example": "hex" } ] }, { "name": "TypeE", "type": "object", "required": false, "description": "时间戳防盗链高级版模式E配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "SecretKey", "type": "string", "required": true, "description": "用于计算签名的密钥，只允许字母和数字，长度6-32字节。 注意：此字段可能返回 null，表示取不到有效值。", "example": "E_Key9xYz3" }, { "name": "SignParam", "type": "string", "required": true, "description": "uri串中签名的字段名，字母，数字或下划线构成，同时必须以字母开头。 注意：此字段可能返回 null，表示取不到有效值。", "example": "v_sign" }, { "name": "AclSignParam", "type": "string", "required": true, "description": "uri串中Acl签名的字段名，字母，数字或下划线构成，同时必须以字母开头。 注意：此字段可能返回 null，表示取不到有效值。", "example": "acl_sign" }, { "name": "StartTimeParam", "type": "string", "required": true, "description": "uri串中开始时间字段名，字母，数字或下划线构成，同时必须以字母开头。 注意：此字段可能返回 null，表示取不到有效值。", "example": "st" }, { "name": "ExpireTimeParam", "type": "string", "required": true, "description": "uri串中过期时间字段名，字母，数字或下划线构成，同时必须以字母开头。 注意：此字段可能返回 null，表示取不到有效值。", "example": "et" }, { "name": "TimeFormat", "type": "string", "required": true, "description": "时间格式，dec 注意：此字段可能返回 null，表示取不到有效值。", "example": "dec" } ] }, { "name": "TypeF", "type": "object", "required": false, "description": "时间戳防盗链高级版模式F配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "SignParam", "type": "string", "required": true, "description": "uri串中签名的字段名，字母，数字或下划线构成，同时必须以字母开头。 注意：此字段可能返回 null，表示取不到有效值。", "example": "fsign" }, { "name": "TimeParam", "type": "string", "required": true, "description": "uri串中时间的字段名，字母，数字或下划线构成，同时必须以字母开头。 注意：此字段可能返回 null，表示取不到有效值。", "example": "ftime" }, { "name": "TransactionParam", "type": "string", "required": true, "description": "uri串中Transaction字段名，字母，数字或下划线构成，同时必须以字母开头。 注意：此字段可能返回 null，表示取不到有效值。", "example": "txid" }, { "name": "SecretKey", "type": "string", "required": true, "description": "用于计算签名的主密钥，只允许字母和数字，长度6-32字节。 注意：此字段可能返回 null，表示取不到有效值。", "example": "F_MainKey123" }, { "name": "BackupSecretKey", "type": "string", "required": false, "description": "用于计算签名的备选密钥，主密钥校验失败后再次尝试备选密钥，只允许字母和数字，长度6-32字节。 注意：此字段可能返回 null，表示取不到有效值。", "example": "F_BakKey456" } ] } ] }, { "name": "OriginAuthentication", "type": "object", "required": false, "description": "回源鉴权高级版配置，白名单功能", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "回源鉴权高级配置开关，取值有： on：开启 off：关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" }, { "name": "TypeA", "type": "object", "required": false, "description": "鉴权类型A配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "SecretKey", "type": "string", "required": true, "description": "用于计算签名的密钥，只允许字母和数字，长度6-32字节。 注意：此字段可能返回 null，表示取不到有效值。", "example": "AKIDz8dbsf3pJ9a1XqN" } ] } ] }, { "name": "Ipv6Access", "type": "object", "required": false, "description": "Ipv6 访问配置", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "域名开启ipv6访问配置开关，取值有： on：开启 off：关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" } ] }, { "name": "OfflineCache", "type": "object", "required": false, "description": "离线缓存", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "离线缓存配置开关，取值有： on：开启 off：关闭", "example": "off" } ] }, { "name": "OriginCombine", "type": "object", "required": false, "description": "合并回源", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "合并回源配置开关，取值有： on：开启 off：关闭", "example": "off" } ] }, { "name": "PostMaxSize", "type": "object", "required": false, "description": "POST请求传输配置", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "POST请求上传文件流式传输最大限制配置开关，取值有： on：开启，平台默认为32MB off：关闭", "example": "on/off" }, { "name": "MaxSize", "type": "integer", "required": false, "description": "最大限制，取值在1MB和200MB之间。", "example": "32" } ] }, { "name": "Quic", "type": "object", "required": false, "description": "Quic访问（收费服务，详见计费说明和产品文档）", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "Quic功能配置开关，取值有： on：开启 off：关闭", "example": "on/off" } ] }, { "name": "OssPrivateAccess", "type": "object", "required": false, "description": "回源OSS私有鉴权", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "oss回源鉴权配置开关，取值有： on：开启 off：关闭", "example": "on" }, { "name": "AccessKey", "type": "string", "required": false, "description": "访问ID。 注意：此字段可能返回 null，表示取不到有效值。", "example": "AKkjqrfjaoidn" }, { "name": "SecretKey", "type": "string", "required": false, "description": "密钥，字段为脱敏返回。 注意：此字段可能返回 null，表示取不到有效值。", "example": "wn***************mg\t" }, { "name": "Region", "type": "string", "required": false, "description": "地域 注意：此字段可能返回 null，表示取不到有效值。", "example": "gz" }, { "name": "Bucket", "type": "string", "required": false, "description": "Bucketname 注意：此字段可能返回 null，表示取不到有效值。", "example": "hw-oss" } ] }, { "name": "WebSocket", "type": "object", "required": false, "description": "WebSocket配置", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "WebSocket 超时配置开关，取值有： on：开启，可以调整超时时间 off：关闭，平台仍支持WebSocket连接，此时超时时间默认为15秒", "example": "off" }, { "name": "Timeout", "type": "integer", "required": false, "description": "设置超时时间，单位为秒，最大超时时间300秒。 注意：此字段可能返回 null，表示取不到有效值。", "example": "10" } ] }, { "name": "RemoteAuthentication", "type": "object", "required": false, "description": "远程鉴权配置", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "远程鉴权配置开关，取值有： on：开启 off：关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "on" }, { "name": "RemoteAuthenticationRules", "type": "array", "required": false, "description": "远程鉴权规则配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "\"RemoteAuthentication\":{\"RemoteAuthenticationRule\":[{\"Server\":\"h", "item_type": "object", "children": [ { "name": "Server", "type": "string", "required": true, "description": "远程鉴权Server。 默认值:和上层配置的\"Server\"一致；", "example": "http://auth.com" }, { "name": "AuthMethod", "type": "string", "required": true, "description": "请求远程鉴权服务器的http方法；取值范围[get,post,head,all]; all: 表示\"遵循终端用户请求方法\" 默认值: all", "example": "get" }, { "name": "RuleType", "type": "string", "required": true, "description": "规则类型： all：所有文件生效 file：指定文件后缀生效 directory：指定目录生效 path：指定文件绝对路径生效 默认值:all", "example": "file" }, { "name": "RulePaths", "type": "array", "required": true, "description": "对应类型下的匹配内容： all 时填充 * file 时填充后缀名，如 jpg、txt directory 时填充路径，如 /xxx/test path 时填充绝对路径，如 /xxx/test.html index 时填充 / 默认值:*", "example": "jpg", "item_type": "string" }, { "name": "AuthTimeout", "type": "integer", "required": true, "description": "请求远程鉴权服务器超时时间，单位毫秒； 取值范围：[1,30 000] 默认值:20000", "example": "1" }, { "name": "AuthTimeoutAction", "type": "string", "required": true, "description": "请求远程鉴权服务器超时后执行拦截或者放行； RETURN_200: 超时后放行； RETURN_403:超时拦截； 默认值:RETURN_200", "example": "RETURN_200" } ] }, { "name": "Server", "type": "string", "required": false, "description": "远程鉴权Server 注意：此字段可能返回 null，表示取不到有效值。", "example": "http://auth.com/a.php" } ] }, { "name": "ShareCname", "type": "object", "required": false, "description": "共享CNAME配置，白名单功能", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "ShareCname 配置开关, 取值有： on：开启，使用共享CNAME off：关闭，使用默认CNAME", "example": "off" }, { "name": "Cname", "type": "string", "required": false, "description": "设置共享CNAME. 注意：此字段可能返回 null，表示取不到有效值。", "example": "mycname-12345.shared.cdn.dnsv1.com" } ] }, { "name": "HwPrivateAccess", "type": "object", "required": false, "description": "华为云对象存储回源鉴权", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "华为云对象存储回源鉴权配置开关，取值有： on：开启 off：关闭", "example": "on" }, { "name": "AccessKey", "type": "string", "required": false, "description": "访问 ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "SYWKY0DAR8I5NXZO93YT" }, { "name": "SecretKey", "type": "string", "required": false, "description": "密钥，字段为脱敏返回。 注意：此字段可能返回 null，表示取不到有效值。", "example": "wn***************mg" }, { "name": "Bucket", "type": "string", "required": false, "description": "bucketname 注意：此字段可能返回 null，表示取不到有效值。", "example": "hw-1-163" } ] }, { "name": "QnPrivateAccess", "type": "object", "required": false, "description": "七牛云对象存储回源鉴权", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "七牛元对象存储回源鉴权配置开关，取值有： on：开启 off：关闭", "example": "on" }, { "name": "AccessKey", "type": "string", "required": false, "description": "访问 ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "ousbDM5xlzuAZJEhhwcLj8makXkYiaAvciZHqAQj" }, { "name": "SecretKey", "type": "string", "required": false, "description": "密钥，字段为脱敏返回。", "example": "wn***************mg" } ] }, { "name": "OthersPrivateAccess", "type": "object", "required": false, "description": "其他厂商对象存储回源鉴权", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "其他厂商对象存储回源鉴权配置开关，取值有： on：开启 off：关闭", "example": "on" }, { "name": "AccessKey", "type": "string", "required": false, "description": "访问ID。 注意：此字段可能返回 null，表示取不到有效值。", "example": "TXUIWY0BAR8I5NXZ693YU" }, { "name": "SecretKey", "type": "string", "required": false, "description": "密钥，字段位脱敏返回。 注意：此字段可能返回 null，表示取不到有效值。", "example": "wn***************mg" }, { "name": "Region", "type": "string", "required": false, "description": "地域。 注意：此字段可能返回 null，表示取不到有效值。", "example": "gz" }, { "name": "Bucket", "type": "string", "required": false, "description": "存储桶名称。 注意：此字段可能返回 null，表示取不到有效值。", "example": "bucket-name" } ] }, { "name": "HttpsBilling", "type": "object", "required": false, "description": "HTTPS服务（收费服务，详见计费说明和产品文档）", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "HTTPS服务配置开关，取值有： on：开启，缺省时默认开启，会产生计费 off：关闭，拦截https请求", "example": "on/off" } ] }, { "name": "ParamFilter", "type": "object", "required": false, "description": "参数黑名单", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "参数黑名单开关 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" }, { "name": "FilterRules", "type": "array", "required": false, "description": "参数黑名单规则 注意：此字段可能返回 null，表示取不到有效值。", "example": "[]", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "参数名 注意：此字段可能返回 null，表示取不到有效值。", "example": "exampleParam" }, { "name": "Values", "type": "array", "required": true, "description": "参数值数组, 小于10个 注意：此字段可能返回 null，表示取不到有效值。", "example": "['blacklistValue1', 'blacklistValue2']", "item_type": "string" }, { "name": "ReturnCode", "type": "string", "required": false, "description": "http 返回码 ( 暂仅支持403) 注意：此字段可能返回 null，表示取不到有效值。", "example": "403" } ] } ] }, { "name": "AutoGuard", "type": "object", "required": false, "description": "流量防盗刷配置", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "流量防盗刷配置开关，取值有： on：开启 off：关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" }, { "name": "FilterRules", "type": "array", "required": true, "description": "流量防盗刷配置规则 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "FilterType", "type": "string", "required": true, "description": "封禁类型 注意：此字段可能返回 null，表示取不到有效值。", "example": "forbidden" }, { "name": "RuleType", "type": "string", "required": true, "description": "封禁规则类型 注意：此字段可能返回 null，表示取不到有效值。", "example": "all" }, { "name": "RulePaths", "type": "array", "required": true, "description": "封禁规则路径 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"*\"]", "item_type": "string" } ] } ] }, { "name": "GeoBlocker", "type": "object", "required": false, "description": "区域访问控制配置", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "IP 黑白名单配置开关，取值有 on：开启 off：关闭", "example": "on" }, { "name": "BlockRules", "type": "array", "required": false, "description": "[ { \"BlockType\": \"whitelist\", \"RulePaths\": [ \"*\" ], \"RuleType\": \"all\", \"Districts\": [ \"CN-HK\" ] } ]", "example": "无", "item_type": "object", "children": [ { "name": "BlockType", "type": "string", "required": true, "description": "规则类型 whitelist: 白名单 blacklist: 黑名单", "example": "blacklist" }, { "name": "RulePaths", "type": "array", "required": true, "description": "生效规则", "example": "*", "item_type": "string" }, { "name": "RuleType", "type": "string", "required": true, "description": "生效类型 all: 全部 directory: 目录", "example": "all" }, { "name": "Districts", "type": "array", "required": true, "description": "生效区域，可选值有: CN-AH CN-BJ CN-CQ CN-FJ CN-GD CN-GS CN-GX CN-GZ CN-HA CN-HB CN-HE CN-HI CN-HK CN-HL CN-HN CN-JL CN-JS CN-JX CN-LN CN-MO CN-NM CN-NX CN-QH CN-SC CN-SD CN-SH CN-SN CN-SX CN-TJ CN-TW CN-XJ CN-XZ CN-YN CN-ZJ AF AX AL DZ AS AD AO AI AQ AG AR AM AW AU AT AZ BS BH BD BB BY BE BZ BJ BM BT BO BQ BA BW BV BR IO BN BG BF BI CV KH CM CA KY CF TD CL CN CX CC CO KM CG CD CK CR CI HR CU CW CY CZ DK DJ DM DO EC EG SV GQ ER EE SZ ET FK FO FJ FI FR GF PF TF GA GM GE DE GH GI GR GL GD ...", "example": "CN-GZ", "item_type": "string" } ] } ] } ], "required": [ "Domain" ] }, { "name": "UpdateImageConfig", "description": "UpdateImageConfig 用于更新控制台图片优化的相关配置，支持Webp、TPG、 Guetzli 和 Avif。", "status": "online", "parameters": [ { "name": "Domain", "type": "string", "required": true, "description": "域名", "example": "test.tencent.com" }, { "name": "WebpAdapter", "type": "object", "required": false, "description": "WebpAdapter配置项", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "图片优化-WebpAdapter配置开关，取值有： on：开启 off：关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" } ] }, { "name": "TpgAdapter", "type": "object", "required": false, "description": "TpgAdapter配置项", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "图片优化-TpgAdapter配置开关，取值有： on：开启 off：关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" } ] }, { "name": "GuetzliAdapter", "type": "object", "required": false, "description": "GuetzliAdapter配置项", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "图片优化-GuetzliAdapter配置开关，取值有： on：开启 off：关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" } ] }, { "name": "AvifAdapter", "type": "object", "required": false, "description": "AvifAdapter配置项", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "图片优化AvifAdapter配置项开关，取值有： on：开启 off：关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "on/off" }, { "name": "FallbackFormats", "type": "array", "required": false, "description": "当原图是 avif 且客户端 Accept 头包含 image/avif 时，直接返回原图。 当原图是 avif 且客户端 Accept 头不包含 image/avif 时但包含 image/webp，将 avif 转 webp 格式返回。如果 Accept 头不包含 image/webp, 则转 jpeg 返回。 可用的枚举值： - [] - [\"webp\"] - [\"jpeg\"] - [\"webp\", \"jpeg\"] \"webp\"：是否开启 avif 转 webp，\"jpeg\": 是否开启 avif 转 jpeg。如果 webp 和 jpeg 都开启的情况下，webp 必须在 jpeg 前面。 注意：此\ufffd...", "example": "[\"webp\", \"jpeg\"]", "item_type": "string" } ] } ], "required": [ "Domain" ] }, { "name": "UpdatePayType", "description": "本接口(UpdatePayType)用于修改账号计费类型，暂不支持月结用户或子账号修改。", "status": "online", "parameters": [ { "name": "Area", "type": "string", "required": true, "description": "计费区域，mainland或overseas。", "example": "mainland" }, { "name": "PayType", "type": "string", "required": true, "description": "计费类型，flux或bandwidth。", "example": "flux" } ], "required": [ "Area", "PayType" ] }, { "name": "VerifyDomainRecord", "description": "VerifyDomainRecord 用于验证域名解析值。 验证域名解析记录值前，您需要通过 [CreateVerifyRecord](https://cloud.tencent.com/document/product/228/48118) 生成校验解析值，验证通过后，24小时有效。 具体流程可参考：[使用API接口进行域名归属校验](https://cloud.tencent.com/document/product/228/61702#.E6.96.B9.E6.B3.95.E4.B8.89.EF.BC.9Aapi-.E6.8E.A5.E5.8F.A3.E6.93.8D.E4.BD.9C)", "status": "online", "parameters": [ { "name": "Domain", "type": "string", "required": true, "description": "域名", "example": "www.qq.com" }, { "name": "VerifyType", "type": "string", "required": false, "description": "验证方式 dns: DNS 解析验证（默认值） file: 文件验证", "example": "file" } ], "required": [ "Domain" ] } ] }