Compute
Elastic Cloud Server
Huawei Cloud Flexus
Bare Metal Server
Auto Scaling
Image Management Service
Dedicated Host
FunctionGraph
Cloud Phone Host
Huawei Cloud EulerOS
Networking
Virtual Private Cloud
Elastic IP
Elastic Load Balance
NAT Gateway
Direct Connect
Virtual Private Network
VPC Endpoint
Cloud Connect
Enterprise Router
Enterprise Switch
Global Accelerator
Management & Governance
Cloud Eye
Identity and Access Management
Cloud Trace Service
Resource Formation Service
Tag Management Service
Log Tank Service
Config
OneAccess
Resource Access Manager
Simple Message Notification
Application Performance Management
Application Operations Management
Organizations
Optimization Advisor
IAM Identity Center
Cloud Operations Center
Resource Governance Center
Migration
Server Migration Service
Object Storage Migration Service
Cloud Data Migration
Migration Center
Cloud Ecosystem
KooGallery
Partner Center
User Support
My Account
Billing Center
Cost Center
Resource Center
Enterprise Management
Service Tickets
HUAWEI CLOUD (International) FAQs
ICP Filing
Support Plans
My Credentials
Customer Operation Capabilities
Partner Support Plans
Professional Services
Analytics
MapReduce Service
Data Lake Insight
CloudTable Service
Cloud Search Service
Data Lake Visualization
Data Ingestion Service
GaussDB(DWS)
DataArts Studio
Data Lake Factory
DataArts Lake Formation
IoT
IoT Device Access
Others
Product Pricing Details
System Permissions
Console Quick Start
Common FAQs
Instructions for Associating with a HUAWEI CLOUD Partner
Message Center
Security & Compliance
Security Technologies and Applications
Web Application Firewall
Host Security Service
Cloud Firewall
SecMaster
Anti-DDoS Service
Data Encryption Workshop
Database Security Service
Cloud Bastion Host
Data Security Center
Cloud Certificate Manager
Edge Security
Managed Threat Detection
Blockchain
Blockchain Service
Web3 Node Engine Service
Media Services
Media Processing Center
Video On Demand
Live
SparkRTC
MetaStudio
Storage
Object Storage Service
Elastic Volume Service
Cloud Backup and Recovery
Storage Disaster Recovery Service
Scalable File Service Turbo
Scalable File Service
Volume Backup Service
Cloud Server Backup Service
Data Express Service
Dedicated Distributed Storage Service
Containers
Cloud Container Engine
SoftWare Repository for Container
Application Service Mesh
Ubiquitous Cloud Native Service
Cloud Container Instance
Databases
Relational Database Service
Document Database Service
Data Admin Service
Data Replication Service
GeminiDB
GaussDB
Distributed Database Middleware
Database and Application Migration UGO
TaurusDB
Middleware
Distributed Cache Service
API Gateway
Distributed Message Service for Kafka
Distributed Message Service for RabbitMQ
Distributed Message Service for RocketMQ
Cloud Service Engine
Multi-Site High Availability Service
EventGrid
Dedicated Cloud
Dedicated Computing Cluster
Business Applications
Workspace
ROMA Connect
Message & SMS
Domain Name Service
Edge Data Center Management
Meeting
AI
Face Recognition Service
Graph Engine Service
Content Moderation
Image Recognition
Optical Character Recognition
ModelArts
ImageSearch
Conversational Bot Service
Speech Interaction Service
Huawei HiLens
Video Intelligent Analysis Service
Developer Tools
SDK Developer Guide
API Request Signing Guide
Terraform
Koo Command Line Interface
Content Delivery & Edge Computing
Content Delivery Network
Intelligent EdgeFabric
CloudPond
Intelligent EdgeCloud
Solutions
SAP Cloud
High Performance Computing
Developer Services
ServiceStage
CodeArts
CodeArts PerfTest
CodeArts Req
CodeArts Pipeline
CodeArts Build
CodeArts Deploy
CodeArts Artifact
CodeArts TestPlan
CodeArts Check
CodeArts Repo
Cloud Application Engine
MacroVerse aPaaS
KooMessage
KooPhone
KooDrive

Proxy Cache

Updated on 2025-01-17 GMT+08:00

You can configure a response cache policy to cache responses returned by the backend service (server) in APIG. When a client sends the same request, APIG does not need to send the request to the backend service but directly returns the cached response. This effectively reduces the backend load and API invoking latency.

NOTICE:
  • When the response cache policy is used, backend responses are cached to APIG. However, APIG now does not support cache data encryption, which poses security risks to sensitive data in responses. Therefore, exercise caution when configuring the policy.
  • Policy parameters will be stored as plaintext. To prevent information leakage, do not contain sensitive information in these parameters.

The following figure shows the principle of the response cache policy.

Constraints

  • An API can be bound to only one response cache policy in an environment, but a response cache policy can be bound to multiple APIs.
  • The response cache policy supports only APIs that use the GET and HEAD methods.
  • Response bodies larger than 1 MB will not be cached.
  • The cache size for backend response is 128 MB.
  • APIG processes the cache according to the Cache-Control header in the backend response. If the backend does not return the Cache-Control header, the response is cached by default, and the ttl field configured in the policy is used as the cache expiration time.
  • By default, APIG does not process the Cache-Control header of the client. You can change this by configuring the client_cache_control in the policy.
  • Cache-Control extended cache instructions are not part of the core HTTP cache standard document and are not supported.
    Cache-control: immutable 
    Cache-control: stale-while-revalidate=<seconds> 
    Cache-control: stale-if-error=<seconds>
  • APIG can cache only the Content-Type, Content-Encoding, and Content-Language headers. If you want to cache more headers, add them to the Cached Backend Headers in the policy. However, the system response headers (such as x-apig-* and x-request-id) added by APIG cannot be added.
  • Policies are independent of APIs. A policy takes effect for an API only after they are bound to each other. When binding a policy to an API, you must specify an environment where the API has been published. The policy takes effect for the API only in the specified environment.
  • After you bind a policy to an API, unbind the policy from the API, or update the policy, you do not need to publish the API again.
  • Taking an API offline does not affect the policies bound to it. The policies are still bound to the API if the API is published again.
  • Policies that have been bound to APIs cannot be deleted.

Creating a Proxy Cache Policy

  1. Go to the APIG console.
  2. Select a dedicated gateway at the top of the navigation pane.
  1. In the navigation pane, choose API Management > API Policies.
  2. On the Policies tab, click Create Policy.
  3. On the Select Policy Type page, select Proxy Cache in the Plug-ins area.
  4. Set the policy information based on the following table.

    Table 1 Proxy cache parameters

    Parameter

    Description

    Name

    Enter a policy name. Using naming rules facilitates future search.

    It can contain 3 to 255 characters and must start with a letter. Only letters, digits, and underscores (_) are allowed.

    Type

    The value is fixed to Proxy Cache.

    Description

    Description about the plug-in. Enter 1 to 255 characters.

    Policy Content

    Content of the plug-in, which can be configured in a form or using a script.

    Proxy Cache Key

    The configuration is used to distinguish different caches.

    • system_params: default gateway parameters. For details about the parameters, see default gateway parameters
    • parameters: request query parameters.
    • headers: request headers

    HTTP Config

    The HTTP Status Code and Cache duration determine whether to cache data and how long the cache will be retained.

    If HTTP parameters are not configured, the default Status Code is 200. Range: 200–599. The default cache duration is 300. Range: 1–720,000.

    Cache Proxy Modes

    The gateway processes the cache through the Cache-Control request header in the client request. By default, the gateway rejects all client requests with the Cache-Control header.

    • all: All client requests with the Cache-Control header are allowed.
    • off: All client requests with the Cache-Control header are rejected.
    • apps: Clients whose app IDs (credential IDs) are in the datas list are allowed.

    Cached Backend Headers

    By default, only the Content-Type, Content-Encoding, and Content-Language headers can be cached. If you want to cache more headers, add them to the Cached Backend Headers in the policy. However, the system response headers (such as x-apig-* and x-request-id) added by APIG cannot be added.

  5. Click OK.

    To clone this policy, click Clone in the Operation column. The name of a cloned policy cannot be the same as that of any existing policy.

  6. After the policy is created, perform the operations described in Binding the Policy to APIs to apply the policy for the API.

Example Script

{
  "cache_key": {
    "system_params": [
      "$context.sourceIp",
      "$context.requestId"
    ],
    "parameters": [
      "demo_parameters"
    ],
    "headers": [
      "demo_header"
    ]
  },
  "cache_http_status_and_ttl": [
    {
      "http_status": [
        200
      ],
      "ttl": 300
    }
  ],
  "client_cache_control": {
    "mode": "apps",
    "datas": [
      "demo_app_id_1,demo_app_id_2"
    ]
  },
  "cacheable_headers": [
    "demo_cacheable_headers_1,demo_cacheable_headers_2"
  ]
}

Binding the Policy to APIs

  1. Click the policy name to go to the policy details page.
  2. Select an environment and click Select APIs.
  3. Select the API group, environment, and required APIs.

    APIs can be filtered by API name or tag. The tag is defined during API creation.

  4. Click OK.

    • If an API no longer needs this policy, click Unbind in the row that contains the API.
    • If there are multiple APIs that no longer need this policy, select these APIs, and click Unbind above the API list. You can unbind a policy from a maximum of 1000 APIs at a time.

We use cookies to improve our site and your experience. By continuing to browse our site you accept our cookie policy. Find out more

Feedback

Feedback

Feedback

0/500

Selected Content

Submit selected content with the feedback