Modifies the custom rule of the Static Page Caching policy for a website.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ModifyWebCacheCustomRule

The operation that you want to perform. Set the value to ModifyWebCacheCustomRule.

Domain String Yes www.aliyun.com

The domain name of the website.

Note A forwarding rule must be configured for the domain name, and the domain name must be associated with an instance that uses the enhanced function plan. You can call the DescribeDomains operation to query all domain names.
Rules String Yes [{"Name": "test","Uri": "/a","Mode": "standard","CacheTtl": 3600}]

Details about the custom rule. This parameter is a JSON string. The fields in the value are described as follows:

  • Name: the name of the rule. This field is required and must be of the STRING type.
  • Uri: the path to the cached page. This field is required and must be of the STRING type.
  • Mode: the cache mode. This field is required and must be of the STRING type. Valid values:
    • standard: the Standard mode
    • aggressive: the Enhanced mode
    • bypass: the No Cache mode
  • CacheTtl: the expiration time of the page cache. This field is required and must be of the INTEGER type. Unit: seconds.
RegionId String No cn-hangzhou

The region ID of the instance. Valid values:

  • cn-hangzhou: mainland China, which indicates an Anti-DDoS Pro instance
  • ap-southeast-1: outside mainland China, which indicates an Anti-DDoS Premium instance
ResourceGroupId String No default

The ID of the resource group to which the instance belongs in Resource Management. This parameter is empty by default, which indicates that the instance belongs to the default resource group.

Response parameters

Parameter Type Example Description
RequestId String 0bcf28g5-d57c-11e7-9bs0-d89d6717dxbc

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ModifyWebCacheCustomRule
&Domain=www.aliyun.com
&Rules=[{"Name": "test","Uri": "/a","Mode": "standard","CacheTtl": 3600}]
&<Common request parameters>

Sample success responses

XML format 

<ModifyWebCacheCustomRuleResponse>
      <RequestId>0bcf28g5-d57c-11e7-9bs0-d89d6717dxbc</RequestId>
</ModifyWebCacheCustomRuleResponse>

JSON format 

{
    "RequestId": "0bcf28g5-d57c-11e7-9bs0-d89d6717dxbc"
}

Error codes

For a list of error codes, visit the API Error Center.