All Products
Search

This Product

    Anti-DDoS:ModifyWebCacheCustomRule

    Document Center

    Anti-DDoS:ModifyWebCacheCustomRule

    Last Updated:Oct 23, 2024

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

    Debugging

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • The required resource types are displayed in bold characters.
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    yundun-ddoscoo:ModifyWebCacheCustomRuleupdate
    • All Resources
      *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    ResourceGroupIdstringNo

    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.

    		default
    DomainstringYes

    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.
    		www.aliyun.com
    RulesstringYes

    The details of the custom rule. This parameter is a JSON string. The string contains the following fields:

    • 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: uses the standard mode.
      • aggressive: uses the enhanced mode.
      • bypass: No data is cached.

    • CacheTtl: the expiration time of the page cache. This field is required and must be of the INTEGER type. Unit: seconds.

    		[{"Name": "test","Uri": "/a","Mode": "standard","CacheTtl": 3600}]

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The ID of the request.

    		0bcf28g5-d57c-11e7-9bs0-d89d6717dxbc

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    For a list of error codes, visit the Service error codes.