CreateCacheRule_边缘安全加速_API文档-阿里云OpenAPI开发者门户

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息，用于RAM权限策略语句的Action元素中，为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置，使用方法可参考访问控制帮助文档。

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作

esa:CreateCacheRule	Create	Site acs:esa:{#regionId}:{#accountId}:site/{#SiteId}	无	无

请求参数

字段名称	字段详情
SiteIdinteger<int64>	站点 ID，可通过调用 ListSites 接口获取。注意该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。示例值:340035003106221参考取值来源: ListSites CreateSite
SiteVersioninteger<int32>	站点配置的版本号。开启了配置版本管理的站点，可以通过该参数指定配置生效的站点版本，默认为版本 0。示例值:1
RuleNamestring	规则名称。添加全局配置的时候不需要设置该参数。示例值:rule_example参考取值来源: GetCacheRule ListCacheRules CreateWaitingRoomRule
RuleEnablestring	规则开关。添加全局配置的时候不需要设置该参数。取值范围：展开详情示例值:on参考取值来源: GetCacheRule ListCacheRules CreateWaitingRoomRule
Rulestring	规则内容，使用条件表达式来匹配用户请求。添加全局配置的时候不需要设置该参数。存在两种使用场景：展开详情示例值:(http.host eq \"video.example.com\") 参考取值来源: GetWafRule ListWafRules CreateWafRule
BypassCachestring	设置绕过缓存模式。取值范围：展开详情示例值:cache_all参考取值来源: ListCacheRules GetCacheRule
BrowserCacheModestring	浏览器缓存模式。取值范围：展开详情示例值:follow_origin参考取值来源: GetCacheRule ListCacheRules
BrowserCacheTtlstring	浏览器缓存过期时间，单位是秒。示例值:300参考取值来源: ListCacheRules GetCacheRule
EdgeCacheModestring	节点缓存模式。取值范围：展开详情示例值:follow_origin参考取值来源: GetCacheRule ListCacheRules
EdgeCacheTtlstring	节点缓存过期时间，单位是秒。示例值:300参考取值来源: GetCacheRule ListCacheRules
EdgeStatusCodeCacheTtlstring	状态码缓存过期时间，单位是秒。示例值:300
SortQueryStringForCachestring	查询字符串排序，默认关闭。取值范围：展开详情示例值:on参考取值来源: ListCacheRules GetCacheRule
QueryStringModestring	在生成缓存键的时候，对查询字符串的处理模式。取值范围：展开详情示例值:reserve_all
QueryStringstring	需要保留或者删除的查询字符串，支持输入多个值，多个值之间用空格分隔。示例值:example
IncludeHeaderstring	生成缓存键的时候，加入指定的标头名称及其值，支持输入多个值，多个值之间用空格分隔。示例值:example
IncludeCookiestring	生成缓存键的时候，加入指定的 cookie 名称及其值，多个值用空格分隔。示例值:cookie_exapmle
CacheReserveEligibilitystring	缓存保持资格。用于控制用户请求在回源的时候是否绕过缓存保持节点。取值范围：展开详情示例值:bypass_cache_reserve参考取值来源: ListCacheRules GetCacheRule
CheckPresenceHeaderstring	生成缓存键的时候，检查 header 是否存在，如果存在，则在缓存键中加入 header 名称（header 名称不区分大小写）。支持输入多个 header 名称，多个值之间用空格分隔。示例值:headername
CheckPresenceCookiestring	生成缓存键的时候，检查 cookie 是否存在，如果存在，则在缓存键中加入 cookie 名称（cookie 名称不区分大小写）。支持输入多个 cookie 名称，多个值之间用空格分隔。示例值:cookiename
UserDeviceTypestring	生成缓存键的时候，加入客户端设备类型。取值范围：展开详情示例值:on
UserGeostring	生成缓存键的时候，加入客户端地理位置。取值范围：展开详情示例值:on
UserLanguagestring	生成缓存键的时候，加入客户端语言类型。取值范围：展开详情示例值:on
ServeStalestring	响应过期缓存。开启之后，在源服务器不可用的情况下，节点依然可以使用已缓存的过期文件响应用户请求。取值范围：展开详情示例值:on
AdditionalCacheablePortsstring	在指定端口上开启缓存功能。取值范围：8880、2052、2082、2086、2095、2053、2083、2087、2096 示例值:8880
CacheDeceptionArmorstring	缓存欺骗防御。用于防御 Web 缓存欺骗攻击，通过校验的缓存内容才会被缓存下来。取值范围：展开详情示例值:on参考取值来源: GetCacheRule ListCacheRules
Sequenceinteger<int32>	规则执行顺序，数值越小越优先执行。示例值:1

返回参数

字段名称	字段详情
RequestIdstring	请求 ID。示例值:04F0F334-1335-436C-A1D7-6C044FE73368
ConfigIdinteger<int64>	配置 ID。注意请注意，该值为 Long 类型，在某些语言中可能存在精度丢失的风险，请小心使用。示例值:352816096987136

返回示例

错误码

没有我想要的错误码, 点击反馈

全局错误码

HTTP 状态码	错误码	错误信息	操作

400	MissingParameter	The specified ArgName is required for this function.	诊断
400	CanNotSetSequence	Non-regular configuration, you cannot set Sequence parameters.	诊断
400	CacheReserveSiteExceedLimit	The number of binding sites of the cache reserve instance exceeds the limit. The number of binding sites of a single cache reserve instance is limited. Please see the document for the limit.	诊断
400	CompileRuleError	Rule compilation failed, please check the rule information passed in to ensure that the rule is written according to the syntax described in the document.	诊断
400	SiteConfigLengthExceedLimit	The overall configuration size of the site exceeds the limit, and the total size of all functional configurations of the site cannot exceed 512K.	诊断
400	ConfigConflicts	Configuration conflicts, usually when multiple configurations are configured under the same function of the same site, such as duplicate rule names between multiple configurations.	诊断
400	FunctionConflict	The feature configuration conflicts. Sites with version management enabled cannot configure this feature.	诊断
400	RuleRegexQuotaCheckFailed	When configuring rules, rules with regular expressions are not allowed in this plan. Please check the relevant documentation of the plan or upgrade the plan.	诊断
400	NestedRuleQuotaCheckFailed	The nesting level of rules allowed by the plan failed to be verified. Please modify the nesting level of rules or upgrade the plan.	诊断
400	ArgQuotaCheckFailed	The passed-in parameter value failed to verify the validity of the plan. Please check the plan document to obtain the range of parameters that can be configured for the site plan.	诊断
400	FunctionQuotaCheckFailed	The quota verification for this function fails. It may be that the configuration of this function exceeds the limit of the site plan. Please check the plan introduction document corresponding to this site.	诊断
400	ConfExceedLimit	The number of function configurations exceeds the limit. Please check the interface document to see the number of configurations that can be supported by a single function.	诊断
400	ServiceInvokeFailed	The call to the internal service failed. The engineer is resolving the problem. Please wait a moment before trying, or contact customer service for details.	诊断
400	SpecifiedVersionReadOnly	The specified version number is read-only and cannot be modified.	诊断
400	VersionNotValid	The site does not have version management enabled, or the version number passed in does not exist.	诊断
400	InternalException	Failed to call the service. Try again later or contact technical support.	诊断
400	InvalidParameter.ArgName	Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.	诊断
400	InvalidParameter.ArgValue	Invalid parameter value. Check whether the value format and length meet the requirements.	诊断
400	InvalidParameter.Configs	Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.	诊断
400	InstanceNotExist	The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.	诊断
400	LockFailed	The system is handling requests you previously submitted. Try again later.	诊断
400	Instance.NotOnline	Your plan is unavailable due to an overdue payment. Complete the payment first.	诊断
400	IllegalOperation.VersionManagement	The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.	诊断
400	QuotaCheckFailed.VersionManagement	Insufficient quota for version management. Contact technical support.	诊断
404	SiteNotFound	The website does not exist or does not belong to you.	诊断

变更历史

	变更时间	变更内容概要	操作
	2025-03-27	新增请求参数Sequence

CreateCacheRule_边缘安全加速_API文档

流控信息

授权信息

请求参数

返回参数

返回示例

错误码

变更历史

相关示例