# Alibaba Cloud Edge Security Acceleration API

> Alibaba Cloud Edge Security Acceleration API on Apizie: 400 endpoints (Activates a client based on the certificate ID, Enables version management to allow a site to support multiple configuration versions and deployment…, Creates a user opportunity ticket, Applies for a free certificate, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/cloud:aliyun-esa/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-esa`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/esa
- Page: https://zieapi.vercel.app/api/cloud/aliyun-esa
- OpenAPI: https://zieapi.vercel.app/api/cloud/aliyun-esa/openapi.json

Alibaba Cloud OpenAPI for Edge Security Acceleration (esa, version 2024-09-10). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Activates a client based on the certificate ID
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/activate-client-certificate` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| SiteId | integer | yes | The site ID. You can call the https://help.aliyun.com/document_detail/2850189.html operation to obtain the site ID |
| Id | string | yes | The certificate ID. You can call the https://help.aliyun.com/document_detail/2852848.html operation to obtain the certificate ID |

### Enables version management to allow a site to support multiple configuration versions and deployment…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/activate-version-management` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| SiteId | integer | yes | The ID of the site. You can call the [ListSites](~~ListSites~~) operation to query the site ID |

### Creates a user opportunity ticket
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/add-user-business-form` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserName | string | yes | The username |
| PhoneNumber | string | yes | The phone number |
| Email | string | yes | The email address |
| Position | string | yes | The job title |
| Company | string | yes | The company |
| Website | string | no | The company website |
| Remark | string | no | Additional remarks |

### Applies for a free certificate
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/apply-certificate` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| SiteId | integer | yes | The site ID |
| Domains | string | yes | The list of domain names. Separate multiple domain names with commas |
| Type | string | no | The certificate type. Valid values: lets_encrypt: Let's Encrypt certificate digicert_single: DigiCert single-domain certificate… |
| AlgType | string | no | The algorithm type |

### Reapplies for a free certificate for a SaaS domain name. This operation is supported only when the current…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/apply-custom-hostname-certificate` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| HostnameId | integer | yes | The ID of the SaaS domain name. You can obtain the ID by calling the https://help.aliyun.com/document_detail/3018667.html operation |

### Adds multiple DNS records in batches and supports various record types
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/batch-create-records` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| SiteId | integer | yes | The ID of the site. You can obtain the site ID by calling the https://help.aliyun.com/document_detail/2850189.html operation |
| RecordList | string | yes | The list of DNS records to be created (JSON-encoded) |

### Creates multiple rules in a specified WAF phase in a single batch and configures shared settings for the rules
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/batch-create-waf-rules` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| SiteId | integer | yes | The site ID. You can obtain the site ID by calling the https://help.aliyun.com/document_detail/2850189.html operation |
| SiteVersion | integer | no | The version number of the site configuration. For sites with configuration version management enabled, you can use this parameter to… |
| Phase | string | no | The execution phase of the WAF rule. This batch operation only supports the following two phases. For other phases, use the single-item… |
| RulesetId | integer | no | The ID of the WAF ruleset. You can obtain the ruleset ID by calling the https://help.aliyun.com/document_detail/2878359.html operation |
| Shared | string | no | The shared configuration for multiple rules, which specifies the common attributes of the rules. Conditionally required: Although this… |
| Configs | string | no | The list of rule configurations, which specifies the detailed configuration of each rule. Required subfields for each phase (only… |

### Batch deletes key-value pairs from a specified KV namespace based on a specified list of key names
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/batch-delete-kv` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Namespace | string | yes | The name specified when calling https://help.aliyun.com/document_detail/2850317.html |
| Keys | string | yes | The list of key names to delete in batch. A maximum of 10,000 keys can be deleted (JSON-encoded) |

### Batch deletes key-value pairs from a specified KV namespace based on a list of key names. The maximum…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/batch-delete-kv-with-high-capacity` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Namespace | string | yes | The name specified when calling https://help.aliyun.com/document_detail/2850317.html |
| Url | string | yes | The download URL that stores the key-value pairs to be batch deleted, such as an OSS download URL with read permissions. When calling this… |

### Retrieves the matching items for expressions in batches
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/batch-get-expression-fields` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| SiteId | integer | no | The site ID |
| InstanceId | string | no | The instance ID of the plan |
| PlanNameEn | string | no | The English name of the plan |
| Kind | string | no | The expression type |
| Phase | string | no | The WAF phase |
| Expressions | string | no | The list of expressions (JSON-encoded) |

### Batch sets key-value pairs in a specified KV namespace based on a specified list of key names
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/batch-put-kv` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Namespace | string | yes | The name specified when you called https://help.aliyun.com/document_detail/2850317.html |
| KvList | string | yes | The list of key-value pairs to batch set. The total size cannot exceed 2 MB (2\1000\1000) (JSON-encoded) |

### Batch sets key-value pairs in a specified KV namespace based on a specified list of key names. The maximum…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/batch-put-kv-with-high-capacity` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Namespace | string | yes | The name specified when you called https://help.aliyun.com/document_detail/2850317.html |
| Url | string | yes | A publicly accessible HTTP(S) URL that points to a JSON file containing the key-value pairs to be batch set. The server actively downloads… |

### Modifies multiple rules in a specified WAF ruleset in batches. This operation allows you to update the…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/batch-update-waf-rules` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| SiteId | integer | yes | The site ID. You can call the https://help.aliyun.com/document_detail/2850189.html operation to query the site ID |
| SiteVersion | integer | no | The version number of the site configuration. For sites with configuration version management enabled, you can use this parameter to… |
| Phase | string | no | The execution phase of WAF rules. This batch operation supports only the following two phases. For other phases, use the `UpdateWafRule`… |
| RulesetId | integer | no | The ID of the WAF ruleset. You can call the https://help.aliyun.com/document_detail/2878359.html operation to query the ruleset ID |
| Shared | string | no | The shared configuration for multiple rules, which specifies the common attributes of multiple rules. Conditionally required: Although… |
| Configs | string | no | The list of rule configurations, which specifies the detailed configuration of each rule. Required sub-fields for each phase (applicable… |

### Blocks access to a specified URL
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/block-object` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| SiteId | integer | yes | The site ID, which can be obtained by calling the https://help.aliyun.com/document_detail/2850189.html operation |
| Type | string | yes | The type. Valid values: block: Block. unblock: Unblock |
| Content | string | yes | The content to block (JSON-encoded) |
| Maxage | integer | no | The effective period of the block, in seconds. Specify this parameter when the type is block |

### Validates whether a site is compatible with the target plan during plan migration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/check-site-features-match-plan` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| NewInstanceId | string | yes | The target instance ID |
| SiteId | integer | yes | The ID of the site. You can obtain the site ID by calling the [ListSites](~~ListSites~~) operation |

### Pre-validates whether a site name is available
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/check-site-name` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| SiteName | string | yes | The site name |

### Checks the project name of a real-time log task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/check-site-project-name` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ProjectName | string | yes | The name of the real-time log project. Allowed character set (hyphens only, no underscores), length limits, and naming convention examples… |
| SiteId | integer | no | The site ID. You can obtain the site ID by calling the https://help.aliyun.com/document_detail/2850189.html operation |

### Checks the name of a real-time log delivery task by account
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/check-user-project-name` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ProjectName | string | yes | The name of the real-time log delivery task |

### Clones a new site version based on a specified site version
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/clone-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| SiteId | integer | yes | The site ID. You can call the [ListSites](~~ListSites~~) operation to obtain the site ID |
| SiteVersion | integer | yes | The site version number to be cloned |

### Submits the staging (unstable) code of an Edge Routine and generates a production version. Prerequisite:…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/commit-routine-staging-code` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Name | string | yes | The name of the Edge Routine |
| CodeDescription | string | no | The description of the code version |
| DeployEnv | string | no | The deployment environment. The environment variable configuration of the specified environment is used. If you do not specify this… |

### Create a Site Cache Configuration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/create-cache-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| SiteId | integer | yes | The site ID. You can call the [ListSites](~~ListSites~~) operation to get this ID |
| SiteVersion | integer | no | The site configuration version. For sites with version management enabled, this parameter specifies the site version to which the… |
| RuleName | string | no | The rule name. This parameter is not required for a global configuration |
| RuleEnable | string | no | Specifies whether to enable the rule. This parameter is not required for a global configuration. Valid values: `on`: Enables the rule.… |
| Rule | string | no | The content of the rule, which is a conditional expression used to match user requests. This parameter is not required for a global… |
| BypassCache | string | no | The bypass cache mode. Valid values: `cache_all`: Caches all requests. `bypass_all`: Bypasses the cache for all requests |
| BrowserCacheMode | string | no | The browser cache mode. Valid values: `no_cache`: Disables browser caching. `follow_origin`: Follows the origin server cache policy.… |
| BrowserCacheTtl | string | no | The browser cache TTL, in seconds |
| EdgeCacheMode | string | no | The edge cache mode. Valid values: `follow_origin`: Follows the origin server cache policy if one exists; otherwise, uses the default… |
| EdgeCacheTtl | string | no | The edge cache TTL, in seconds |
| EdgeStatusCodeCacheTtl | string | no | The status code cache TTL, in seconds. You can set the cache TTL for a specific status code. For example, `404=10` caches responses with a… |
| SortQueryStringForCache | string | no | Specifies whether to sort query strings. This feature is disabled by default. Valid values: `on`: Enables sorting. `off`: Disables sorting |
| QueryStringMode | string | no | The mode for processing query strings when generating a cache key. Valid values: `ignore_all`: Ignores all query strings.… |
| QueryString | string | no | The query strings to include in or exclude from the cache key. Separate multiple query strings with spaces |
| IncludeHeader | string | no | The headers to include in the cache key. Both the header names (case-insensitive) and their values are included. Separate multiple header… |
| IncludeCookie | string | no | The cookies to include in the cache key. Both the cookie names (case-insensitive) and their values are included. Separate multiple cookie… |
| CacheReserveEligibility | string | no | Specifies whether requests bypass cache reservation nodes during an origin fetch. Valid values: `bypass_cache_reserve`: The request… |
| CheckPresenceHeader | string | no | Specifies the headers to check for presence when generating a cache key. If a specified header is present in the request, its name… |
| CheckPresenceCookie | string | no | Specifies the cookies to check for presence when generating a cache key. If a specified cookie is present in the request, its name… |
| UserDeviceType | string | no | Specifies whether to include the client device type in the cache key. Valid values: `on`: Includes the client device type. `off`: Does not… |
| UserGeo | string | no | Specifies whether to include the client's geographic location in the cache key. Valid values: `on`: Includes the geographic location.… |
| UserLanguage | string | no | Specifies whether to include the client's language in the cache key. Valid values: `on`: Includes the language. `off`: Does not include… |
| ServeStale | string | no | Specifies whether to serve stale content. If enabled, an edge node can serve stale (expired) content when the origin server is… |
| AdditionalCacheablePorts | string | no | Specifies additional ports on which caching is enabled. Valid values: 8880, 2052, 2082, 2086, 2095, 2053, 2083, 2087, and 2096. You can… |
| CacheDeceptionArmor | string | no | Specifies whether to enable cache deception defense. This feature helps defend against web cache deception attacks. When this feature is… |
| Sequence | integer | no | The execution order of the rule. A smaller number indicates a higher priority |
| PostCache | string | no | Specifies whether to enable POST request caching |
| PostBodySizeLimit | string | no | The size limit for the request body when using POST request caching, in KB. Supported values range from 1 to 8. If unspecified, the… |
| PostBodyCacheKey | string | no | Specifies how to process the request body when generating a cache key for POST requests. The following modes are supported: `md5`:… |

### Issues a client certificate by using the ESA certificate authority (CA)
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/create-client-certificate` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| SiteId | integer | yes | The site ID |
| CSR | string | no | The certificate signing request (CSR) content |
| PkeyType | string | no | The private key algorithm type. This parameter is required if CSR is not provided |
| ValidityDays | integer | yes | The validity period of the certificate. Unit: days |

### Creates a compression rule configuration for a site
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/create-compression-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| SiteId | integer | yes | The site ID, which can be obtained by calling the https://help.aliyun.com/document_detail/2850189.html operation |
| SiteVersion | integer | no | The version number of the site configuration. For sites with configuration version management enabled, you can use this parameter to… |
| RuleName | string | no | The rule name. You do not need to set this parameter when adding a global configuration |
| RuleEnable | string | no | The rule switch. You do not need to set this parameter when adding a global configuration. Valid values: on: Enabled. off: Disabled |
| Rule | string | no | The rule content, which uses a conditional expression to match user requests. You do not need to set this parameter when adding a global… |
| Gzip | string | no | Gzip compression. Valid values: on: Enabled. off: Disabled |
| Brotli | string | no | Brotli compression. Valid values: on: Enabled. off: Disabled |
| Zstd | string | no | Zstd compression. Valid values: on: Enabled. off: Disabled |
| Sequence | integer | no | The rule execution order. A smaller value indicates a higher priority |

### Creates a SaaS domain name under a site
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/create-custom-hostname` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Hostname | string | yes | The SaaS domain name |
| SiteId | integer | yes | The site ID, which can be obtained by calling the https://help.aliyun.com/document_detail/2850189.html operation |
| RecordId | integer | yes | The ID of the record to bind. You can obtain this value by calling the https://help.aliyun.com/document_detail/2850265.html operation |
| SslFlag | string | yes | Specifies whether to enable SSL. Valid values: on: Enable SSL. off: Disable SSL |
| CertType | string | no | The certificate type. This parameter is required when SslFlag is set to on. Valid values: free: free certificate. upload: uploaded… |
| Certificate | string | no | The certificate content. This parameter is required when CertType is set to upload |
| PrivateKey | string | no | The private key of the certificate. This parameter is required when CertType is set to upload |
| CasId | integer | no | The SSL Certificates Service certificate ID. This parameter is required when CertType is set to cas |
| CasRegion | string | no | The region of the SSL Certificates Service certificate. This parameter is required when CertType is set to cas. For Chinese site accounts,… |

### Creates a custom response code rule for a site
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/create-custom-response-code-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| SiteId | integer | yes | The site ID. You can call https://help.aliyun.com/document_detail/2850189.html to obtain the site ID |
| SiteVersion | integer | no | The version number of the site configuration. For sites with version management enabled, you can use this parameter to specify the site… |
| RuleName | string | no | The rule name. You do not need to set this parameter when adding a global configuration |
| RuleEnable | string | no | The rule switch. You do not need to set this parameter when adding a global configuration. Valid values: on: Enabled. off: Disabled |
| Rule | string | no | The rule content. Conditional expressions are used to match user requests. You do not need to set this parameter when adding a global… |
| Sequence | integer | no | The execution order of the rule. A smaller value indicates a higher priority |
| ReturnCode | string | yes | The response code |
| PageId | string | yes | The response page |

### Creates a user-level scenario-specific policy and executes the corresponding policy after the policy is…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/create-custom-scene-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Name | string | yes | The policy name |
| Template | string | yes | The name of the template. Valid values: promotion: Important Activity |
| StartTime | string | yes | The start time of the policy. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC |
| EndTime | string | yes | The end time of the policy. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC |
| Objects | string | no | The IDs of the websites to be associated. Separate multiple IDs with commas (,). [Deprecated] This parameter is deprecated. Use the… |
| SiteIds | string | no | The IDs of the websites to be associated. Separate multiple IDs with commas (,) |

### Creates an edge container application. You can deploy and release the application by version to containerize…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/create-edge-container-app` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Name | string | yes | The application name. The name must start with a lowercase letter and can contain lowercase letters, digits, and hyphens (-). The name… |
| ServicePort | integer | yes | The server port number. Only 80 and 443 are accepted |
| TargetPort | integer | yes | The backend port, which is also the service port of the application. Valid values: 1 to 65535 |
| Remarks | string | no | The remarks. If this parameter is not specified, the value is empty by default |
| HealthCheckType | string | no | The health check type, which includes Layer 4 and Layer 7 probing. If this parameter is not specified, the value is empty by default.… |
| HealthCheckHost | string | no | The domain name used for health checks. If this parameter is not specified, the value is empty by default |
| HealthCheckHttpCode | string | no | The HTTP status code that indicates the health check is Normal. Valid values: http_2xx (default). http_3xx |
| HealthCheckMethod | string | no | The health check method for HTTP-type listeners. Valid values: HEAD (default): Requests only the headers of the page. GET: Requests the… |
| HealthCheckURI | string | no | The URI used for health checks. The length is limited to 1 to 80 characters. Default value: "/" |
| HealthCheckPort | integer | no | The port used for health checks. Valid values: 1 to 65535. Default value: 80 |
| HealthCheckTimeout | integer | no | The amount of time to wait for a response from the health check. If the backend ECS instance does not respond correctly within the… |
| HealthCheckInterval | integer | no | The interval between health checks. Valid values: 1 to 50. Default value: 5. Unit: seconds |
| HealthCheckSuccTimes | integer | no | The number of consecutive successful health checks required. If an application is unhealthy, it is considered healthy again after the… |
| HealthCheckFailTimes | integer | no | The number of consecutive failed health checks required. If an application is healthy, it is considered unhealthy after the specified… |

### Creates an image secret for an edge container application
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/create-edge-container-app-image-secret` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| AppId | string | yes | The application ID. You can call the [ListEdgeContainerApps](~~ListEdgeContainerApps~~) operation to retrieve the application ID |
| Registry | string | yes | The address of the image registry |
| Username | string | yes | The username for the image registry |
| Password | string | yes | The password for the image registry |

### Creates an associated domain name for an edge container application. When a user sends a request from a…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/create-edge-container-app-record` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| AppId | string | yes | The application ID |
| SiteId | integer | no | The site ID. Although this parameter is marked as optional in the schema, it is required when you call this operation. If you do not… |
| RecordName | string | yes | The associated domain name |

### Creates an edge container application version. You can iteratively release applications by version. Note:…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/create-edge-container-app-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| AppId | string | yes | The application ID. You can call the [ListEdgeContainerApps](~~ListEdgeContainerApps~~) operation to obtain the application ID. 1) Your… |
| Name | string | yes | The version name. The name must be 6 to 128 characters in length |
| Remarks | string | no | The remarks |
| Containers | string | yes | The container group to be deployed for this version, including specific image information. The image information consists of the image… |

### Creates a site environment
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/create-environment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| SiteId | integer | yes | The site ID. You can call the [ListSites](~~ListSites~~) operation to obtain the site ID |
| EnvironmentName | string | yes | The environment name |
| Rule | string | yes | The environment rule |
| NextEnvironmentName | string | yes | The name of the environment with the next priority |

### Creates a configuration for modifying HTTP inbound request headers for a site
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/create-http-incoming-request-header-modification-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| SiteId | integer | yes | The site ID, which can be obtained by calling the https://help.aliyun.com/document_detail/2850189.html operation |
| SiteVersion | integer | no | The version number of the site configuration. For sites with configuration version management enabled, you can use this parameter to… |
| RuleName | string | no | The rule name. This parameter is not required when you add a global configuration |
| RuleEnable | string | no | The rule switch. This parameter is not required when you add a global configuration. Valid values: on: enabled. off: disabled |
| Rule | string | no | The rule content, which uses a conditional expression to match user requests. This parameter is not required when you add a global… |
| RequestHeaderModification | string | yes | The request header modifications. Three operations are supported: add, delete, and modify (JSON-encoded) |
| Sequence | integer | no | The rule execution order. A smaller value indicates a higher priority |

### Creates a configuration for modifying HTTP inbound response headers for a site
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/create-http-incoming-response-header-modification-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| SiteId | integer | yes | The site ID. You can call the https://help.aliyun.com/document_detail/2850189.html operation to obtain the site ID |
| SiteVersion | integer | no | The version number of the site configuration. For sites with version management enabled, you can use this parameter to specify the site… |
| RuleName | string | no | The rule name. You do not need to set this parameter when you add a global configuration |
| RuleEnable | string | no | The rule switch. You do not need to set this parameter when you add a global configuration. Valid values: on: enabled. off: disabled |
| Rule | string | no | The rule content, which uses a conditional expression to match user requests. You do not need to set this parameter when you add a global… |
| ResponseHeaderModification | string | yes | The response header modifications. Three operation types are supported: add, delete, and modify (JSON-encoded) |
| Sequence | integer | no | The rule execution order. A smaller value indicates a higher priority |

### Creates an HTTP request header modification configuration for a site
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/create-http-request-header-modification-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| SiteId | integer | yes | The site ID. You can call the [ListSites](~~ListSites~~) operation to obtain the site ID |
| SiteVersion | integer | no | The version number of the site configuration. For sites with configuration version management enabled, you can use this parameter to… |
| RuleName | string | no | The name of the rule. You do not need to specify this parameter when adding a global configuration |
| RuleEnable | string | no | Specifies whether to enable the rule. You do not need to specify this parameter when adding a global configuration. Valid values: on:… |
| Rule | string | no | The rule content. Uses a conditional expression to match user requests. You do not need to specify this parameter when adding a global… |
| RequestHeaderModification | string | yes | The request header modifications. Supports adding, deleting, and modifying headers (JSON-encoded) |
| Sequence | integer | no | The execution sequence of the rule. A smaller value indicates a higher priority |

### Creates an HTTP response header modification configuration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/create-http-response-header-modification-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| SiteId | integer | yes | The site ID. You can call the https://help.aliyun.com/document_detail/2850189.html operation to query the site ID |
| SiteVersion | integer | no | The version number of the site configuration. For sites with configuration version management enabled, you can use this parameter to… |
| RuleName | string | no | The rule name. This parameter is not required when you add a global configuration |
| RuleEnable | string | no | Specifies whether to enable the rule. This parameter is not required when you add a global configuration. Valid values: on: Enabled. off:… |
| Rule | string | no | The rule content, which uses a conditional expression to match user requests. This parameter is not required when you add a global… |
| ResponseHeaderModification | string | yes | The response header modifications. Add, delete, and modify operations are supported (JSON-encoded) |
| Sequence | integer | no | The execution sequence of the rule. A smaller value indicates a higher priority |

### Adds an HTTPS application configuration to a site
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/create-https-application-configuration` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| SiteId | integer | yes | The ID of the Site. You can get this ID by calling the [ListSites](~~ListSites~~) API |
| SiteVersion | integer | no | The Site's configuration Version. For Sites with version management enabled, this parameter specifies the Version to which the… |
| RuleName | string | no | The name of the Rule. This parameter is optional when adding a Global Configuration |
| RuleEnable | string | no | Specifies whether to enable the rule. This parameter is optional when adding a Global Configuration. Valid values: `on`: The rule is… |
| Rule | string | no | The content of the Rule, which is a Conditional Expression that matches user Requests. This parameter is optional when adding a Global… |
| HttpsForce | string | no | Specifies whether to enable Force HTTPS. Disabled by default. Valid values: `on`: Enabled. `off`: Disabled |
| HttpsForceCode | string | no | The Redirection Status Code to use when Force HTTPS is enabled. Valid values: `301` `302` `307` `308` |
| AltSvc | string | no | Specifies whether to enable the Alt-Svc header. Disabled by default. Valid values: `on`: Enabled. `off`: Disabled |
| AltSvcClear | string | no | Specifies whether to include the `clear` parameter in the Alt-Svc header. Disabled by default. Valid values: `on`: The parameter is… |
| AltSvcPersist | string | no | Specifies whether to include the `persist` parameter in the Alt-Svc header. Disabled by default. Valid values: `on`: The parameter is… |
| AltSvcMa | string | no | The Max Age for the Alt-Svc header, in seconds. The default is 86400 |
| Hsts | string | no | Specifies whether to enable HTTP Strict Transport Security (HSTS). Disabled by default. Valid values: `on`: Enabled. `off`: Disabled |
| HstsMaxAge | string | no | The value of the `max-age` directive for the HSTS header, in seconds |
| HstsIncludeSubdomains | string | no | Specifies whether to include the `includeSubDomains` directive in the HSTS header. Disabled by default. Valid values: `on`: The directive… |
| HstsPreload | string | no | Specifies whether to enable HSTS Preload by including the `preload` directive in the HSTS header. Disabled by default. Valid values: `on`:… |
| Sequence | integer | no | The execution order of the rule. A lower value indicates a higher priority |
| HttpsSniVerify | string | no | Specifies whether to enable Server Name Indication (SNI) verification. Disabled by default. Valid values: `on`: Enabled. `off`: Disabled |
| HttpsNoSniDeny | string | no | Specifies whether to reject TLS Handshake Requests that do not include an SNI. Disabled by default. Valid values: `on`: Rejects requests… |
| HttpsSniWhitelist | string | no | Specifies the allowlist of SNI values. Separate multiple values with a space |

### Create HTTPS basic configuration for a site
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/create-https-basic-configuration` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| SiteId | integer | yes | Site ID, which can be obtained by calling the [ListSites](~~ListSites~~) API |
| RuleName | string | no | Rule name. This parameter does not need to be set when adding a global configuration |
| RuleEnable | string | no | Rule switch. This parameter does not need to be set when adding a global configuration. Valid values: on: enabled. off: disabled |
| Rule | string | no | Rule content, using conditional expressions to match user requests. This parameter does not need to be set when adding a global… |
| Https | string | no | Whether to enable HTTPS. Enabled by default. Valid values: on: enabled. off: disabled |
| Tls10 | string | no | Whether to enable TLS 1.0. Disabled by default. Valid values: on: enabled. off: disabled |
| Tls11 | string | no | Whether to enable TLS 1.1. Enabled by default. Valid values: on: enabled. off: disabled |
| Tls12 | string | no | Whether to enable TLS 1.2. Enabled by default. Valid values: on: enabled. off: disabled |
| Tls13 | string | no | Whether to enable TLS 1.3. Enabled by default. Valid values: on: enabled. off: disabled |
| CiphersuiteGroup | string | no | Cipher suite group. All cipher suites are used by default. Valid values: all: all cipher suites. strict: strong cipher suites. custom:… |
| Ciphersuite | string | no | Custom cipher suite, specifying the specific encryption algorithms selected when CiphersuiteGroup is set to custom |
| OcspStapling | string | no | Whether to enable OCSP stapling. Disabled by default. Valid values: on: enabled. off: disabled |
| Http2 | string | no | Whether to enable HTTP/2. Enabled by default. Valid values: on: enabled. off: disabled |
| Http3 | string | no | Whether to enable HTTP/3. Enabled by default. Valid values: on: enabled. off: disabled |
| Sequence | integer | no | Rule execution order. A smaller value indicates a higher priority |

### Creates an image transformation configuration for a site
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/create-image-transform` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| SiteId | integer | yes | The site ID, which can be obtained by calling the https://help.aliyun.com/document_detail/2850189.html operation |
| SiteVersion | integer | no | The version number of the site configuration. For sites with configuration version management enabled, you can use this parameter to… |
| Enable | string | no | Specifies whether to enable image transformation. Valid values: on: Enabled. off: Disabled |
| RuleName | string | no | The rule name. This parameter is not required when you add a global configuration |
| RuleEnable | string | no | Specifies whether to enable the rule. This parameter is not required when you add a global configuration. Valid values: on: Enabled. off:… |
| Rule | string | no | The rule content, which uses a conditional expression to match user requests. This parameter is not required when you add a global… |
| Sequence | integer | no | The execution order of the rule. A smaller value indicates a higher priority |
| AutoWebp | string | no | Specifies whether to enable adaptive WebP. Valid values: on: Enabled. off: Disabled |
| AutoAvif | string | no | Specifies whether to enable adaptive AVIF. Valid values: on: Enabled. off: Disabled |

### Creates a key-value (KV) namespace under the current account
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/create-kv-namespace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Namespace | string | yes | The name of the KV namespace |
| Description | string | no | The description of the KV namespace |

### Creates a custom list. Custom lists are typically referenced by the rule matching engine for values used in…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/create-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Name | string | yes | The name of the custom list. Naming rules: Only letters, digits, and underscores are supported (`^\w{1,64}$`). The name must be 1 to 64… |
| Kind | string | no | The kind of the custom list. This parameter specifies the type of the custom list |
| Description | string | no | The description of the custom list. This parameter provides detailed information about the custom list |
| Items | string | no | The list items. This parameter provides the specific item data for the list (JSON-encoded) |

### Creates a load balancer instance that supports custom routing policies, session persistence, monitoring…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/create-load-balancer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Name | string | yes | The name of the load balancer. The name must be in a valid domain name format and must be a subdomain of the site |
| Enabled | string | no | Specifies whether the load balancer is enabled. Valid values: true: Enabled. false: Not enabled |
| SiteId | integer | yes | The site ID. You can call the [ListSites](~~ListSites~~) operation to obtain the site ID |
| AdaptiveRouting | string | no | The cross-origin address pool back-to-origin configuration (JSON-encoded) |
| DefaultPools | string | yes | The list of default address pool IDs (JSON-encoded) |
| FallbackPool | integer | yes | The fallback address pool ID. Traffic is directed to this pool when all other pools are unavailable |
| RandomSteering | string | no | The weighted round-robin configuration that controls the traffic distribution weight across different address pools (JSON-encoded) |
| Rules | string | no | The rule information (JSON-encoded) |
| SessionAffinity | string | no | The session persistence mode. Valid values: off: disabled. ip: IP-based session persistence. cookie: cookie-based session persistence.… |
| SteeringPolicy | string | yes | The load balancing policy. Valid values: geo: geo-based routing. random: weighted round-robin. order: primary/secondary mode |
| Description | string | no | The description of the load balancer for management and identification purposes |
| Ttl | integer | no | The TTL value, which specifies the time-to-live of the DNS record. Default value: 30 seconds. Valid values: 10 to 600 |
| Monitor | string | yes | The monitor configuration for health checks (JSON-encoded) |
| SubRegionPools | string | no | The address pools mapped to secondary regions. If multiple secondary regions share the same set of address pools, you can concatenate the… |
| RegionPools | string | no | The address pools mapped to primary regions |

### Creates a network optimization configuration for a site
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/create-network-optimization` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| SiteId | integer | yes | The site ID. You can obtain the site ID by calling the [ListSites](~~ListSites~~) operation |
| SiteVersion | integer | no | The version number of the site configuration. For sites with configuration version management enabled, you can use this parameter to… |
| RuleName | string | no | The name of the rule. You do not need to specify this parameter when you add a global configuration |
| RuleEnable | string | no | Specifies whether to enable the rule. You do not need to specify this parameter when you add a global configuration. Valid values: on:… |
| Rule | string | no | The content of the rule. It uses a conditional expression to match user requests. You do not need to specify this parameter when you add a… |
| SmartRouting | string | no | Specifies whether to enable the smart routing service. Default value: off. Valid values: on: Enabled. off: Disabled |
| Http2Origin | string | no | Specifies whether to enable HTTP/2 back-to-origin. Default value: off. Valid values: on: Enabled. off: Disabled |
| Websocket | string | no | Specifies whether to enable WebSocket. Default value: on. Valid values: on: Enabled. off: Disabled |
| Grpc | string | no | Specifies whether to enable gRPC. Default value: off. Valid values: on: Enabled. off: Disabled |
| UploadMaxFilesize | string | no | The maximum size of an uploaded file. Unit: MB. Valid values: 100 to 500 |
| Sequence | integer | no | The execution order of the rule. A smaller value indicates a higher priority |

### Creates an origin pool for a site. You can then use the origin pool with a Server Load Balancer or for…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/create-origin-pool` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Name | string | yes | The name of the origin pool. The name must be unique within a site |
| Enabled | string | no | Specifies whether the origin pool is enabled. `true`: enabled `false`: disabled |
| Origins | string | no | The list of origins to add to the origin pool. Use an array to specify multiple origins (JSON-encoded) |
| SiteId | integer | yes | The site ID. To obtain this ID, call the https://help.aliyun.com/document_detail/2850189.html operation |

### Enables origin protection
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/create-origin-protection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| SiteId | integer | yes | The site ID, which can be obtained by calling the https://help.aliyun.com/document_detail/2850189.html operation. The plan associated with… |
| AutoConfirmIPList | string | no | Specifies whether to automatically enable the latest back-to-origin IP addresses list. Valid values: off: Do not automatically enable. on:… |

### Create a Back-to-Origin Rule for a Site
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/create-origin-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| SiteId | integer | yes | The ID of the site. You can obtain this ID by calling the [ListSites](~~ListSites~~) operation |
| SiteVersion | integer | no | For sites with version management enabled, this specifies the version to which the configuration applies. The default value is 0 |
| RuleName | string | no | The rule name. Not required when creating a Global Configuration |
| RuleEnable | string | no | Specifies whether to enable the rule. Not required when creating a Global Configuration. Valid values: `on`: Enables the rule. `off`:… |
| Rule | string | no | The content of the rule, a Conditional Expression that matches user requests. Not required when creating a Global Configuration. There are… |
| OriginHost | string | no | The `Host` header to use in Origin requests |
| OriginScheme | string | no | The protocol for Origin requests. Valid values: `http`: Uses the HTTP protocol. `https`: Uses the HTTPS protocol. `follow`: Uses the same… |
| OriginSni | string | no | The Server Name Indication (SNI) to use in Origin requests |
| DnsRecord | string | no | Overrides the DNS Record for Origin requests |
| OriginHttpPort | string | no | The Origin Port to use for HTTP Origin requests |
| OriginHttpsPort | string | no | The Origin Port to use for HTTPS Origin requests |
| Range | string | no | Specifies whether to use range requests to download files from the Origin. Valid values: `on`: Enables range requests. `off`: Disables… |
| OriginMtls | string | no | Specifies whether to enable mutual Transport Layer Security (mTLS) for Origin connections. Valid values: `on`: Enables mTLS. `off`:… |
| OriginVerify | string | no | Specifies whether to enable Origin Certificate Verification. Valid values: `on`: Enables verification. `off`: Disables verification |
| RangeChunkSize | string | no | The size of each chunk for range requests. Valid values: `512KB` `1MB` `2MB` `4MB` |
| Sequence | integer | no | The priority of the rule. A smaller value indicates a higher priority |
| OriginReadTimeout | string | no | The Origin read timeout in seconds |
| Follow302Enable | string | no | Specifies whether to follow 302 redirects from the Origin. Valid values: `on`: Enables following redirects. `off`: Disables following… |
| Follow302MaxTries | string | no | The maximum number of 302 redirects to follow. Valid range: 1 to 5 |
| Follow302RetainArgs | string | no | Specifies whether to retain the original request parameters when following a 302 redirect. Valid values: `on`: Retains the request… |
| Follow302RetainHeader | string | no | Specifies whether to retain the original request header when following a 302 redirect. Valid values: `on`: Retains the request header.… |
| Follow302TargetHost | string | no | The Origin `Host` header to use after a 302 redirect |

### Creates a custom error response page. When a user request is blocked by Web Application Firewall (WAF),…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/create-page` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Name | string | yes | The name of the custom page. Naming suggestions: Use a short name that consists of letters, digits, and underscores, such as… |
| Description | string | no | The description of the page, used to identify the purpose of the page in the console list. Suggested content: Use the scenarios and… |
| ContentType | string | yes | The MIME type of the page content. This value is returned to the client as the HTTP `Content-Type` response header after a match. Common… |
| Content | string | no | The BASE64-encoded page content. The actual content format must match the value of `ContentType`. Encoding method: Encode the original… |
| SiteIds | string | no | The list of website IDs to associate with this custom page. You can obtain website IDs by calling the `ListSites` operation. If you pass… |

### Create a DNS record under a site
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/create-record` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| SiteId | integer | yes | The site ID, which can be obtained by calling the https://help.aliyun.com/document_detail/2850189.html API |
| RecordName | string | yes | The record name |
| Proxied | string | no | Specifies whether to enable proxy acceleration for the record. Only CNAME records or A/AAAA records (i.e., when the type parameter is set… |
| Type | string | yes | The DNS type of the record, such as A/AAAA, CNAME, TXT, etc |
| SourceType | string | no | The origin type of the CNAME record. This parameter is required when adding a CNAME record (i.e., when the type parameter is set to… |
| BizName | string | no | Used to tag the business scenario of the DNS record. This parameter is required when proxy acceleration is enabled for the DNS record… |
| Ttl | integer | yes | The time-to-live (TTL) of the record, in seconds. When set to 1, the TTL is automatic |
| Data | string | yes | The DNS information of the record. Different types of records require different content for this field. For more information, see… |
| Comment | string | no | The comment for the record, with a maximum length of 100 characters |
| AuthConf | string | no | The origin authentication information for the CNAME record (JSON-encoded) |
| HostPolicy | string | no | The origin host policy. This takes effect when the record type is CNAME. It specifies the host policy for back-to-origin requests. Two… |
| HttpPorts | string | no | Http端口 |
| HttpsPorts | string | no | Https端口 |

### Creates a redirect configuration for a site
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/create-redirect-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| SiteId | integer | yes | The ID of the site. You can call the https://help.aliyun.com/document_detail/2850189.html operation to obtain the site ID |
| SiteVersion | integer | no | The version number of the site configuration. For sites with configuration version management enabled, you can use this parameter to… |
| RuleName | string | no | The name of the rule. You do not need to set this parameter when adding a global configuration |
| RuleEnable | string | no | Specifies whether to enable the rule. You do not need to set this parameter when adding a global configuration. Valid values: on: Enabled.… |
| Rule | string | no | The rule content, which uses a conditional expression to match user requests. You do not need to set this parameter when adding a global… |
| Type | string | yes | The redirect type. Valid values: static: Static pattern. dynamic: Dynamic pattern |
| TargetUrl | string | yes | The destination URL after the redirect |
| StatusCode | string | yes | The HTTP status code used by the node to respond to the client with the redirect URL. Valid values: 301 302 303 307 308 |
| ReserveQueryString | string | yes | Specifies whether to retain the query string. Valid values: on: Enabled. off: Disabled |
| Sequence | integer | no | The execution sequence of the rule. A smaller value indicates a higher priority |

### Create a rewrite URL rule configuration for a site
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/create-rewrite-url-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| SiteId | integer | yes | The site ID, which can be obtained by calling the [ListSites](~~ListSites~~) operation |
| SiteVersion | integer | no | The version number of the site configuration. For sites with configuration version management enabled, you can use this parameter to… |
| Rule | string | no | The rule content, which uses conditional expressions to match user requests. This parameter does not need to be set when adding global… |
| RuleName | string | no | The rule name. This parameter does not need to be set when adding global configurations |
| RuleEnable | string | no | The rule switch. This parameter does not need to be set when adding global configurations. Valid values: on: enabled. off: disabled |
| RewriteUriType | string | no | The URI rewrite type. Valid values: static: static mode. dynamic: dynamic mode |
| Uri | string | no | The destination URI after rewriting |
| RewriteQueryStringType | string | no | The query string rewrite type. Valid values: static: static mode. dynamic: dynamic mode |
| QueryString | string | no | The query string after rewriting |
| Sequence | integer | no | The rule execution order. A smaller value indicates a higher priority |

### Creates an Edge Routine
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/create-routine` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Name | string | yes | The name of the Edge Routine. The name must be unique within the same account |
| Description | string | no | The description of the Edge Routine |
| HasAssets | string | no | Specifies whether the Edge Routine contains asset files |

### Creates an ER build task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/create-routine-build` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RoutineName | string | yes | The ER name |
| Branch | string | no | The name of the branch to build. This parameter is not required in upload mode but is required in git mode |
| ArtifactUrl | string | no | The OSS object URL. This parameter is required in upload mode but is not required in git mode |

### Creates an Edge Routine (ER) build configuration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/create-routine-build-configuration` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RootDirectory | string | no | The root directory |
| BuildBranches | string | no | The branches that trigger a build. Set this parameter to * for all branches. To specify multiple branches, separate branch names with commas |
| AssetsDirectory | string | no | The static resource directory |
| NodeVersion | string | yes | The Node.js version. Valid values: `22.x`, `20.x`, `18.x`, `16.x`, `14.x`, `12.x` |
| RoutineName | string | yes | The ER name |
| GitPlatform | string | no | The Git platform. Valid values: github, gitee, and upload |
| Repository | string | no | The repository name |
| EnvironmentVariables | string | no | The environment variables (JSON-encoded) |
| RoutineEntry | string | no | The ER entry file path |
| IsPrivate | string | no | Specifies whether the repository is private. Valid values: true: The repository is private. false: The repository is not private |
| BuildCommand | string | no | The build command |
| ProductionBranch | string | no | The production branch name |
| GitAccountId | integer | no | The Git account ID |
| TemplateName | string | no | The build template name |
| InstallCommand | string | no | The install command |

### Deploys code versions of an Edge Routine to a specified environment by percentage for a canary release
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/create-routine-code-deployment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Name | string | yes | The name of the Edge Routine |
| Env | string | yes | The environment name. Valid values: `staging`: the staging environment. `production`: the production environment |
| Strategy | string | yes | The deployment strategy. Valid values: `percentage`: percentage mode |
| CodeVersions | string | yes | The list of code version configurations for the percentage-based canary release. You can specify up to two code versions, and the sum of… |

### Adds an associated site record for an Edge Routine function. This creates a new record under the site to…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/create-routine-related-record` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Name | string | yes | The name of the Edge Routine function |
| SiteId | integer | yes | The site ID |
| RecordName | string | yes | The record name |

### Creates an Edge Routine route configuration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/create-routine-route` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| SiteId | integer | yes | The site ID, which can be obtained by calling the https://help.aliyun.com/document_detail/2850189.html operation |
| RouteName | string | yes | The route name |
| RouteEnable | string | yes | The route switch. Valid values: on: enabled off: disabled |
| Rule | string | yes | The rule content |
| RoutineName | string | yes | The Edge Routine name |
| Bypass | string | no | The bypass mode. Valid values: on: enabled off: disabled |
| Sequence | integer | no | The rule execution order |
| Fallback | string | no | The back-to-origin on exception switch. When enabled, if the function encounters an exception such as CPU usage exceeding the limit, the… |
| Timeout | string | no | The Edge Routine timeout period. Valid values: 5 to 60. Unit: seconds |

### Creates execution plans for batch scheduled prefetch tasks
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/create-scheduled-preload-executions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Id | string | no | The prefetch task ID, generated by calling the https://help.aliyun.com/document_detail/2850459.html operation |
| Executions | string | yes | The list of execution plans to be added for the scheduled prefetch task (JSON-encoded) |

### Creates a scheduled prefetch task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/create-scheduled-preload-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| InsertWay | string | yes | The upload method for the prefetch file. Text box and OSS uploads are supported |
| Name | string | yes | The name of the scheduled prefetch task |
| OssUrl | string | no | The OSS file for the scheduled prefetch task. Enter the URL of the OSS file. Note: The OSS file must contain the URLs that you want to… |
| SiteId | integer | yes | The site ID. You can obtain the site ID by calling the https://help.aliyun.com/document_detail/2850189.html operation |
| UrlList | string | no | The list of URLs to be prefetched. This parameter is used when you upload the prefetch file by using a text box |

### Creates a site
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/create-site` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| SiteName | string | yes | The name of the site |
| Coverage | string | yes | The acceleration region. Valid values: domestic: the Chinese mainland global: global overseas: global (excluding the Chinese mainland) |
| AccessType | string | yes | The access type of the site. Valid values: NS: hosted NS access CNAME: CNAME access |
| InstanceId | string | yes | The instance ID. You can call the https://help.aliyun.com/document_detail/2852398.html operation to obtain the instance ID. You must… |
| ResourceGroupId | string | no | The resource group ID. If you do not specify this parameter, the system automatically uses the ID of the default resource group |
| ResourceOwner | integer | no | The UID of the owner of the site plan associated with the site. By default, you do not need to specify this parameter. You only need to… |

### Adds the configuration of custom request header, response header, and cookie fields that are used to capture…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/create-site-custom-log` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| SiteId | integer | no | The website ID, which can be obtained by calling the https://help.aliyun.com/document_detail/2850189.html operation |
| RequestHeaders | string | no | The request header fields (JSON-encoded) |
| ResponseHeaders | string | no | The response header fields (JSON-encoded) |
| Cookies | string | no | The cookie fields (JSON-encoded) |

### Creates a real-time log delivery task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/create-site-delivery-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| BusinessType | string | yes | The business type. Valid values: dcdn_log_access_l1 (default): access logs. dcdn_log_er: Edge Routine function logs. dcdn_log_waf:… |
| SiteId | integer | yes | The site ID, which can be obtained by calling the https://help.aliyun.com/document_detail/2850189.html operation |
| DataCenter | string | no | The data center. Valid values: cn: the Chinese mainland. oversea: outside the Chinese mainland |
| TaskName | string | yes | The task name |
| FieldName | string | yes | The selected log fields, separated by commas (,). The field names must come from the FieldName values returned by the… |
| DeliveryType | string | yes | The delivery type. Valid values: sls: Simple Log Service. http: HTTP service. aws3: Amazon S3 service. oss: Object Storage Service (OSS).… |
| DiscardRate | number | no | The discard rate. Default value: 0 |
| S3Delivery | string | no | The S3 or S3-compatible delivery configuration parameters (JSON-encoded) |
| OssDelivery | string | no | The OSS delivery configuration (JSON-encoded) |
| HttpDelivery | string | no | The HTTP delivery configuration parameters (JSON-encoded) |
| KafkaDelivery | string | no | The Kafka delivery configuration parameters (JSON-encoded) |
| SlsDelivery | string | no | The Simple Log Service (SLS) delivery configuration (JSON-encoded) |
| FilterVer | string | no | The filter rule version. For backward compatibility with legacy filter rules, the default value is v1. Newly created tasks use v2 |

### Creates a slider CAPTCHA page
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/create-slider-captcha-page` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Name | string | yes | The name of the custom slider page |
| Configs | string | no | The predefined configurations for the custom slider page (JSON-encoded) |
| ForceLanguage | string | no | The forced language |
| CustomContent | string | no | The custom slider configurations. The value is a JSON string |
| SiteIds | string | no | The list of bound site IDs (JSON-encoded) |

### Creates a Layer 4 acceleration application
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/create-transport-layer-application` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| SiteId | integer | yes | The site ID. You can call the [ListSites](~~ListSites~~) operation to obtain the site ID. The site must be activated |
| RecordName | string | yes | The domain name of the Layer 4 application |
| Rules | string | yes | The list of forwarding rules (JSON-encoded) |
| IpAccessRule | string | no | The IP access rule switch. When enabled, IP access rules in WAF take effect for the Layer 4 application. Valid values: on: enabled. off:… |
| Ipv6 | string | no | Specifies whether to enable IPv6. This feature is disabled by default. Valid values: on: enabled. off: disabled |
| CrossBorderOptimization | string | no | Specifies whether to enable network access optimization for the Chinese mainland. This feature is disabled by default. Valid values: on:… |
| StaticIp | string | no | Specifies whether to enable static IP. This feature is disabled by default. Valid values: on: enabled. off: disabled |
| KeepAliveProtection | string | no | Specifies whether to enable keep-alive protection. This feature is disabled by default. Valid values: on: enabled. off: disabled |

### Creates a web monitoring configuration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/create-url-observation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| SiteId | integer | yes | The site ID. You can call the [ListSites](~~ListSites~~) operation to obtain the site ID |
| Url | string | yes | The URL of the web page to monitor. If the site name is example.com, set Url to example.com/test or site DNS record name/path |
| SdkType | string | yes | The SDK integration method. Valid values: automatic: automatic integration. manual: manual integration |

### Creates a custom log delivery task to deliver logs to destinations such as SLS, HTTP, OSS, S3, or Kafka
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/create-user-delivery-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| BusinessType | string | yes | The real-time log type. Valid values: dcdn_log_er_pod: edge container logs. dcdn_log_dns: edge DNS logs |
| DataCenter | string | no | The data center. Valid values: cn: the Chinese mainland. sg: global (excluding the Chinese mainland) |
| TaskName | string | yes | The task name |
| FieldName | string | yes | The fields to deliver, separated by commas (,) |
| DeliveryType | string | yes | The delivery type. Valid values: sls: Alibaba Cloud Simple Log Service. http: HTTP service. aws3: Amazon S3 service. oss: Alibaba Cloud… |
| DiscardRate | number | no | The discard rate. Default value: 0 |
| S3Delivery | string | no | The S3 or S3-compatible delivery configuration parameters (JSON-encoded) |
| OssDelivery | string | no | The OSS delivery configuration parameters (JSON-encoded) |
| HttpDelivery | string | no | The HTTP delivery configuration parameters (JSON-encoded) |
| KafkaDelivery | string | no | The Kafka delivery configuration parameters (JSON-encoded) |
| SlsDelivery | string | no | The SLS delivery configuration (JSON-encoded) |
| Details | string | no | The list of Edge Routine (ER) pods to configure |
| FilterVer | string | no | The version of the filter rule. This parameter is used for backward compatibility with legacy filter rules. The default value is v1. New… |

### Creates an instance-level Web Application Firewall (WAF) ruleset that supports multiple types of protection…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/create-user-waf-ruleset` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| InstanceId | string | yes | The instance ID |
| Phase | string | yes | The phase to which the WAF ruleset belongs. Valid values: http_whitelist: whitelist rules http_custom: custom rules http_managed: managed… |
| Name | string | yes | The name of the WAF ruleset. Naming suggestion: Use a combination of letters, digits, and underscores for easy reference. The specific… |
| Description | string | no | The description of the WAF ruleset |
| Status | string | yes | The status of the WAF ruleset. Valid values: on: Enabled. The rules in the ruleset participate in matching and blocking. off: Disabled.… |
| Expression | string | yes | The match expression of the WAF ruleset. Rules in this ruleset are evaluated only when a request matches this expression. Examples:… |
| Shared | string | no | The shared fields across multiple rules in this ruleset, such as a unified Action or Name prefix. The field structure is subject to the… |
| Rules | string | no | The list of rule configurations in the WAF ruleset. Each element corresponds to a rule. The field structure of each rule is subject to the… |

### Create a site video processing configuration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/create-video-processing` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| SiteId | integer | yes | The site ID. You can call the https://help.aliyun.com/document_detail/2850189.html operation to obtain the site ID |
| SiteVersion | integer | no | The version number of the site configuration. For sites with configuration version management enabled, you can use this parameter to… |
| RuleName | string | no | The rule name. You do not need to set this parameter when adding a global configuration |
| RuleEnable | string | no | The rule switch. You do not need to set this parameter when adding a global configuration. Valid values: on: enabled. off: disabled |
| Rule | string | no | The rule content, which uses conditional expressions to match user requests. You do not need to set this parameter when adding a global… |
| Sequence | integer | no | The rule execution order. A smaller value indicates a higher priority |
| VideoSeekEnable | string | no | The video seek (drag-and-play) switch. Valid values: on: enabled. off: disabled |
| FlvVideoSeekMode | string | no | The FLV seek mode. Valid values: by_byte: seek by byte. by_time: seek by time |
| Mp4SeekStart | string | no | The custom MP4 start parameter |
| Mp4SeekEnd | string | no | The custom MP4 end parameter |
| FlvSeekStart | string | no | The custom FLV start parameter |
| FlvSeekEnd | string | no | The custom FLV end parameter |

### Creates a rule in Web Application Firewall (WAF). You can use this operation to refine firewall behavior and…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/create-waf-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| SiteId | integer | yes | The site ID. You can call the https://help.aliyun.com/document_detail/2850189.html operation to obtain the site ID |
| SiteVersion | integer | no | The version number of the site configuration. For sites with version management enabled, you can use this parameter to specify the site… |
| Phase | string | yes | The WAF rule execution phase. This single-creation operation supports the following phases (it does not support `http_anti_scan` or… |
| RulesetId | integer | no | The ID of the WAF ruleset. You can call the https://help.aliyun.com/document_detail/2878359.html operation to obtain the ruleset ID |
| Config | string | no | The specific configuration of the WAF rule (`WafRuleConfig` data structure). The required fields vary depending on the Phase value:… |

### Creates a WAF ruleset
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/create-waf-ruleset` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| SiteId | integer | yes | The site ID. To get this ID, call the https://help.aliyun.com/document_detail/2850189.html operation |
| SiteVersion | integer | no | The site configuration version. This parameter applies only if versioning is enabled for the site. The default is 0 |
| Phase | string | yes | The WAF rule execution phase. Valid values: http_whitelist http_custom http_managed http_anti_scan http_ratelimit ip_access_rule http_bot… |
| Name | string | no | The name of the WAF ruleset |

### Creates a waiting room for a site
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/create-waiting-room` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| SiteId | integer | yes | The site ID. You can obtain the site ID by calling the https://help.aliyun.com/document_detail/2850189.html operation |
| Enable | string | yes | Specifies whether to enable the waiting room. Valid values: on: Enabled. off: Disabled |
| Name | string | yes | The name of the waiting room |
| QueueAllEnable | string | no | Specifies whether to queue all requests. Valid values: on: Enabled. off: Disabled |
| HostNameAndPath | string | yes | The hostnames and paths (JSON-encoded) |
| CookieName | string | yes | The custom cookie name |
| TotalActiveUsers | string | yes | The total number of active users |
| NewUsersPerMinute | string | yes | The number of new users per minute |
| SessionDuration | string | yes | The session duration in minutes |
| DisableSessionRenewalEnable | string | no | Specifies whether to disable session renewal. Valid values: on: Enabled. off: Disabled |
| QueuingMethod | string | yes | The queuing method. Valid values: random: Random. fifo: First-in, first-out (FIFO). passthrough: Passthrough. reject-all: Reject all |
| QueuingStatusCode | string | yes | The HTTP status code of the waiting room. Valid values: 200 202 429 |
| JsonResponseEnable | string | no | Specifies whether to enable JSON responses. If enabled, JSON data is returned when the Accept request header contains "application/json".… |
| Description | string | no | The description of the waiting room |
| WaitingRoomType | string | yes | The type of the waiting room. Valid values: default: Default. custom: Custom |
| CustomPageHtml | string | no | The custom HTML content of the waiting room page. This parameter is required when the waiting room type is set to custom. The content must… |
| Language | string | no | The language of the waiting room page. This parameter is required when the waiting room type is set to default. Valid values: enus:… |

### Creates a waiting room event and allows you to configure the queuing method and type
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/create-waiting-room-event` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| SiteId | integer | yes | The ID of the site. You can obtain the site ID by calling the https://help.aliyun.com/document_detail/2850189.html operation |
| WaitingRoomId | string | no | The ID of the waiting room. You can obtain the waiting room ID by calling the https://help.aliyun.com/document_detail/2850279.html… |
| Enable | string | yes | Specifies whether to enable the waiting room. Valid values: on: Enabled. off: Disabled |
| Name | string | yes | The name of the waiting room event |
| TotalActiveUsers | string | yes | The total number of active users |
| NewUsersPerMinute | string | yes | The number of new users per minute |
| SessionDuration | string | yes | The session duration in minutes |
| DisableSessionRenewalEnable | string | no | Specifies whether to disable session renewal. Valid values: on: Disables session renewal. off: Enables session renewal |
| QueuingMethod | string | yes | The queuing method. Valid values: random: Random. fifo: First-in, first-out (FIFO). passthrough: Passthrough. reject-all: Reject all |
| QueuingStatusCode | string | yes | The HTTP status code of the waiting room. Valid values: 200 202 429 |
| JsonResponseEnable | string | no | Specifies whether to enable JSON responses. If this feature is enabled and the Accept request header contains "application/json", JSON… |
| Description | string | no | The description of the waiting room |
| WaitingRoomType | string | yes | The type of the waiting room. Valid values: default: Default type. custom: Custom type |
| CustomPageHtml | string | no | The custom content of the waiting room page. This parameter is required when the waiting room type is set to custom. The content must use… |
| StartTime | string | yes | The start timestamp of the event. Example: 1705044735 |
| EndTime | string | yes | The end timestamp of the event. Example: 1705044735 |
| PreQueueEnable | string | no | Specifies whether to enable pre-queuing. Valid values: on: Enabled. off: Disabled |
| PreQueueStartTime | string | no | The start timestamp of pre-queuing. The time must be at least 5 minutes earlier than the event start timestamp. Example: 1705044735 |
| RandomPreQueueEnable | string | no | Specifies whether to enable random pre-queuing. Valid values: on: Enabled. off: Disabled |
| Language | string | no | The language of the waiting room page. This parameter is required when the waiting room type is set to default. Valid values: enus:… |

### Creates a waiting room bypass rule
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/create-waiting-room-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| SiteId | integer | yes | The site ID. You can obtain the site ID by calling the https://help.aliyun.com/document_detail/2850189.html operation |
| WaitingRoomId | string | yes | The ID of the waiting room to bypass |
| RuleName | string | yes | The rule name. You do not need to specify this parameter when you add a global configuration |
| RuleEnable | string | yes | The rule switch. You do not need to specify this parameter when you add a global configuration. Valid values: on: Enabled. off: Disabled |
| Rule | string | yes | The rule content. It uses a conditional expression to match user requests. You do not need to specify this parameter when you add a global… |

### Disables the version management feature for a site
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/deactivate-version-management` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| SiteId | integer | yes | The site ID. You can call the [ListSites](~~ListSites~~) operation to obtain the site ID |

### Delete Cache Configuration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/delete-cache-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| SiteId | integer | yes | Site ID, which can be obtained by calling the [ListSites](~~ListSites~~) interface |
| ConfigId | integer | yes | ConfigId of the configuration, which can be obtained by calling the https://help.aliyun.com/document_detail/2866985.html interface |

### Deletes a certificate for a website
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/delete-certificate` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| SiteId | integer | yes | The website ID, which can be obtained by calling the [ListSites](~~ListSites~~) operation |
| Id | string | yes | The certificate ID |

### Deletes a client CA certificate
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/delete-client-ca-certificate` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| SiteId | integer | yes | The website ID |
| Id | string | yes | The certificate ID |

### Deletes a revoked client certificate
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/delete-client-certificate` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| SiteId | integer | yes | The website ID |
| Id | string | yes | The certificate ID |

### Deletes the compression rule configuration for a site
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/delete-compression-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| SiteId | integer | yes | The ID of the site. You can call the https://help.aliyun.com/document_detail/2850189.html operation to query the site ID |
| ConfigId | integer | yes | The ID of the configuration. You can call the https://help.aliyun.com/document_detail/2867498.html operation to query the configuration ID |

### Deletes a custom domain name from a Software as a Service (SaaS) site based on its HostnameId
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/delete-custom-hostname` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| HostnameId | integer | yes | The ID of the custom hostname. To obtain this ID, call the https://help.aliyun.com/document_detail/3018667.html operation |

### Deletes a custom response code configuration for a site
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/delete-custom-response-code-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| SiteId | integer | yes | The site ID. Obtain this by calling ListSites |
| ConfigId | integer | yes | The configuration ID |

### Deletes a scenario-specific custom policy
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/delete-custom-scene-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| PolicyId | integer | yes | The policy ID, which can be obtained by calling the https://help.aliyun.com/document_detail/2850508.html operation |

### Deletes an edge container application that is no longer needed by application ID
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/delete-edge-container-app` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| AppId | string | no | The application ID. You can call the [ListEdgeContainerApps](~~ListEdgeContainerApps~~) operation to obtain the application ID. AppId is… |

### Deletes the image secret for an edge containerized application
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/delete-edge-container-app-image-secret` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| AppId | string | yes | The application ID. Call the [ListEdgeContainerApps](~~ListEdgeContainerApps~~) operation to obtain the application ID |
| Name | string | yes | The name of the image secret |

### Deletes an associated domain name from an edge container application. After deletion, the edge container…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/delete-edge-container-app-record` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| AppId | string | yes | The application ID |
| SiteId | integer | no | The site ID. This parameter is required. If it is not specified, the service returns InternalError(400). Call ListSites to obtain a valid… |
| RecordName | string | yes | The associated domain name |

### Deletes a version of a containerized application
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/delete-edge-container-app-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| AppId | string | yes | The application ID, which can be obtained by calling the [ListEdgeContainerApps](~~ListEdgeContainerApps~~) operation |
| VersionId | string | yes | The ID of the version that you want to delete. To obtain the version ID, call the… |

### Deletes a site environment. The default environment cannot be deleted
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/delete-environment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| SiteId | integer | yes | The site ID. You can call the [ListSites](~~ListSites~~) operation to obtain the site ID |
| EnvironmentName | string | yes | The environment name |

### Deletes the rules issued by deep learning and protection
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/delete-http-ddo-sintelligent-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| SiteId | integer | yes | The site ID. You can call the [ListSites](~~ListSites~~) operation to obtain the site ID |
| RecordName | string | yes | The name of the record |
| RuleId | integer | yes | The ID of the rule |

### Deletes the configuration of modifying incoming HTTP request headers for a website
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/delete-http-incoming-request-header-modification-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| SiteId | integer | yes | The website ID, which can be obtained by calling the https://help.aliyun.com/document_detail/2850189.html operation |
| ConfigId | integer | yes | The configuration ID. You can call the ListHttpIncomingRequestHeaderModificationRules operation to query the ID |

### Deletes the configuration of modifying HTTP response headers for a website
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/delete-http-incoming-response-header-modification-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| SiteId | integer | yes | The website ID, which can be obtained by calling the https://help.aliyun.com/document_detail/2850189.html operation |
| ConfigId | integer | yes | The configuration ID. You can call the ListHttpIncomingResponseHeaderModificationRules operation to query the ID |

### Deletes the configuration of modifying HTTP request headers for a website
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/delete-http-request-header-modification-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| SiteId | integer | yes | The website ID, which can be obtained by calling the [ListSites](~~ListSites~~) operation |
| ConfigId | integer | yes | The configuration ID, which can be obtained by calling the… |

### Deletes the configuration of modifying HTTP response headers for a website
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/delete-http-response-header-modification-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| SiteId | integer | yes | The website ID, which can be obtained by calling the https://help.aliyun.com/document_detail/2850189.html operation |
| ConfigId | integer | yes | The configuration ID, which can be obtained by calling the… |

### Delete HTTPS Application Configuration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/delete-https-application-configuration` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| SiteId | integer | yes | Site ID, which can be obtained by calling the [ListSites](~~ListSites~~) interface |
| ConfigId | integer | yes | ConfigId of the configuration, which can be obtained by calling the https://help.aliyun.com/document_detail/2869087.html interface |

### Delete HTTPS Basic Configuration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/delete-https-basic-configuration` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| SiteId | integer | yes | Site ID, which can be obtained by calling the [ListSites](~~ListSites~~) interface |
| ConfigId | integer | yes | ConfigId of the configuration, which can be obtained by calling the [ListHttpsBasicConfigurations](~~ListHttpsBasicConfigurations~~)… |

### Delete Site Image Transformation Configuration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/delete-image-transform` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| SiteId | integer | yes | Site ID, which can be obtained by calling the https://help.aliyun.com/document_detail/2850189.html interface |
| ConfigId | integer | yes | Configuration ID. It can be obtained by calling the https://help.aliyun.com/document_detail/2869056.html interface |

### Deletes a Keyless server configuration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/delete-keyless-server` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| SiteId | integer | yes | The site ID. You can call the https://help.aliyun.com/document_detail/2850189.html operation to query the site ID |
| Id | string | yes | The Keyless server ID |

### Deletes a specific key-value pair from a KV namespace
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/delete-kv` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Namespace | string | yes | The name specified when calling https://help.aliyun.com/document_detail/2850317.html |
| Key | string | yes | The name of the key to delete |

### Deletes a single KV namespace owned by the account
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/delete-kv-namespace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Namespace | string | yes | The name specified when calling https://help.aliyun.com/document_detail/2850317.html |

### Deletes a custom list that is no longer needed
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/delete-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Id | integer | yes | The ID of the custom list, which can be obtained by calling the https://help.aliyun.com/document_detail/2850217.html operation |

### Delete Load Balancer
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/delete-load-balancer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Id | integer | yes | The ID of the load balancer, used to uniquely identify the load balancer to be queried. This ID is returned directly upon creation of the… |
| SiteId | integer | yes | The ID of the site, which can be obtained by calling the [ListSites](~~ListSites~~) interface |

### Delete Network Optimization Configuration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/delete-network-optimization` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| SiteId | integer | yes | Site ID, which can be obtained by calling the [ListSites](~~ListSites~~) interface |
| ConfigId | integer | yes | ConfigId of the configuration, which can be obtained by calling the ListNetworkOptimizations |

### Deletes an origin CA certificate
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/delete-origin-ca-certificate` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| SiteId | integer | yes | The site ID |
| Id | string | yes | The certificate ID |

### Deletes an origin client certificate for a specific site
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/delete-origin-client-certificate` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| SiteId | integer | yes | The ID of the site |
| Id | string | yes | The ID of the certificate |

### Delete Origin Address Pool
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/delete-origin-pool` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Id | integer | yes | The ID of the origin address pool, which can be obtained by calling the https://help.aliyun.com/document_detail/2863947.html API |
| SiteId | integer | yes | The site ID, which can be obtained by calling the [ListSites](~~ListSites~~) API |

### Disable origin protection
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/delete-origin-protection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| SiteId | integer | yes | The site ID. For more information, see the https://help.aliyun.com/document_detail/2850189.html API |

### Deletes the back-to-origin rule configuration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/delete-origin-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| SiteId | integer | yes | The site ID. You can call the [ListSites](~~ListSites~~) operation to obtain the site ID |
| ConfigId | integer | yes | The configuration ID. You can call the [ListOriginRules](~~ListOriginRules~~) operation to obtain the configuration ID |

### Deletes a custom error page that is no longer needed
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/delete-page` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Id | integer | yes | The ID of the custom error page, which can be obtained by calling the https://help.aliyun.com/document_detail/2850223.html operation |

### Deletes a DNS record based on its RecordId
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/delete-record` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RecordId | integer | yes | The ID of the DNS record. You can get this ID by calling the https://help.aliyun.com/document_detail/2850265.html operation |

### Deletes the redirect configuration for a site
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/delete-redirect-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| SiteId | integer | yes | The ID of the site. You can call the https://help.aliyun.com/document_detail/2850189.html operation to obtain the ID |
| ConfigId | integer | yes | The ID of the configuration. You can call the [ListRedirectRules](~~ListRedirectRules~~) operation to obtain the ID |

### Deletes the URL rewrite configuration for a site
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/delete-rewrite-url-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| SiteId | integer | yes | The ID of the site. You can call the https://help.aliyun.com/document_detail/2850189.html operation to obtain the site ID |
| ConfigId | integer | yes | The configuration ID. You can call the https://help.aliyun.com/document_detail/2867480.html operation to obtain the configuration ID |

### Deletes an Edge Routine
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/delete-routine` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Name | string | yes | The name of the Edge Routine |

### Deletes the ER build configuration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/delete-routine-build-configuration` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RoutineName | string | yes | The ER name |

### Deletes a code version of a routine
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/delete-routine-code-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Name | string | yes | The routine name |
| CodeVersion | string | yes | The code version |

### Deletes environment variables of a Routine
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/delete-routine-environment-variables` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Name | string | yes | The name of the Routine function |
| Env | string | yes | The environment name. Valid values: `staging`: staging environment `production`: production environment |
| EnvironmentVariableKeys | string | yes | The list of environment variable keys to delete (JSON-encoded) |

### Deletes an association record of an Edge Routine
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/delete-routine-related-record` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Name | string | yes | The name of the Edge Routine |
| RecordId | integer | yes | The record ID |
| RecordName | string | yes | The record name |
| SiteId | integer | yes | The site ID |

### Deletes the route configuration of an edge function
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/delete-routine-route` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| SiteId | integer | yes | The website ID, which can be obtained by calling the https://help.aliyun.com/document_detail/2850189.html operation |
| ConfigId | integer | yes | The ID of the configuration. You can call the https://help.aliyun.com/document_detail/2879631.html operation to obtain the ID |

### Deletes a single scheduled prefetch plan by prefetch plan ID
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/delete-scheduled-preload-execution` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Id | string | yes | The prefetch plan ID |

### Deletes a specified scheduled prefetch task by task ID
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/delete-scheduled-preload-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Id | string | yes | The ID of the scheduled prefetch task |

### Deletes a site by site ID
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/delete-site` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| SiteId | integer | yes | The ID of the site to delete. Call the https://help.aliyun.com/document_detail/2850189.html operation to obtain site IDs |

### Deletes an ongoing log delivery task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/delete-site-delivery-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| SiteId | integer | yes | The ID of the site. You can obtain the ID by calling the https://help.aliyun.com/document_detail/2850189.html operation |
| TaskName | string | yes | The name of the task |

### Deletes a site-level origin client certificate
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/delete-site-origin-client-certificate` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| SiteId | integer | yes | The site ID |
| Id | string | yes | The certificate ID |

### Deletes the slider CAPTCHA page
`POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/delete-slider-captcha-page` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Id | integer | yes | The ID of the custom slider CAPTCHA page |

…and 280 more. See the OpenAPI spec.

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:aliyun-esa/activate-client-certificate" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud Edge Security Acceleration API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:aliyun-esa/activate-client-certificate with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud Edge Security Acceleration API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud Edge Security Acceleration itself also needs your own key from aliyuncs.com.

### Can AI agents use the Alibaba Cloud Edge Security Acceleration API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-esa.

### What is the status of the Alibaba Cloud Edge Security Acceleration API?
Needs your own provider key (bring your own key)