Adds an HTTPS application configuration to a site.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| SiteId |
integer |
Yes |
The ID of the Site. You can get this ID by calling the ListSites API. |
123456**** |
| SiteVersion |
integer |
No |
The Site's configuration Version. For Sites with version management enabled, this parameter specifies the Version to which the configuration applies. The default is 0. |
1 |
| RuleName |
string |
No |
The name of the Rule. This parameter is optional when adding a Global Configuration. |
rule_example |
| RuleEnable |
string |
No |
Specifies whether to enable the rule. This parameter is optional when adding a Global Configuration. Valid values:
|
on |
| 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 Configuration. Supported use cases include:
|
(http.host eq \"video.example.com\") |
| HttpsForce |
string |
No |
Specifies whether to enable Force HTTPS. Disabled by default. Valid values:
|
on |
| HttpsForceCode |
string |
No |
The Redirection Status Code to use when Force HTTPS is enabled. Valid values:
|
301 |
| AltSvc |
string |
No |
Specifies whether to enable the Alt-Svc header. Disabled by default. Valid values:
|
on |
| AltSvcClear |
string |
No |
Specifies whether to include the
|
on |
| AltSvcPersist |
string |
No |
Specifies whether to include the
|
on |
| AltSvcMa |
string |
No |
The Max Age for the Alt-Svc header, in seconds. The default is 86400. |
86400 |
| Hsts |
string |
No |
Specifies whether to enable HTTP Strict Transport Security (HSTS). Disabled by default. Valid values:
|
on |
| HstsMaxAge |
string |
No |
The value of the |
3600 |
| HstsIncludeSubdomains |
string |
No |
Specifies whether to include the
|
on |
| HstsPreload |
string |
No |
Specifies whether to enable HSTS Preload by including the
|
on |
| Sequence |
integer |
No |
The execution order of the rule. A lower value indicates a higher priority. |
1 |
| HttpsSniVerify |
string |
No |
Specifies whether to enable Server Name Indication (SNI) verification. Disabled by default. Valid values:
|
on |
| HttpsNoSniDeny |
string |
No |
Specifies whether to reject TLS Handshake Requests that do not include an SNI. Disabled by default. Valid values:
|
on |
| HttpsSniWhitelist |
string |
No |
Specifies the allowlist of SNI values. Separate multiple values with a space. |
abc edf |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response data. |
||
| RequestId |
string |
The ID of the request. |
04F0F334-1335-436C-A1D7-6C044FE73368 |
| ConfigId |
integer |
The ID of the configuration. |
352816096987136 |
Examples
Success response
JSON format
{
"RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
"ConfigId": 352816096987136
}Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | MissingParameter | The specified ArgName is required for this function. | When configuring a specific function, the required parameter is missing. |
| 400 | CanNotSetSequence | Non-regular configuration, you cannot set Sequence parameters. | Sequence parameters is not allowed in global configuration. |
| 400 | CacheReserveSiteExceedLimit | The number of binding sites of the cache reserve instance exceeds the limit. The number of binding sites of a single cache reserve instance is limited. Please see the document for the limit. | The number of sites for which the cache reserve instance bindings exceeds the limit. |
| 400 | CompileRuleError | Rule compilation failed, please check the rule information passed in to ensure that the rule is written according to the syntax described in the document. | Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document. |
| 400 | SiteConfigLengthExceedLimit | The overall configuration size of the site exceeds the limit, and the total size of all functional configurations of the site cannot exceed 512K. | The size of the site configuration exceeds the limit, and the total size cannot exceed 512K. |
| 400 | ConfigConflicts | Configuration conflicts, usually when multiple configurations are configured under the same function of the same site, such as duplicate rule names between multiple configurations. | The parameter uniqueness check failed. Check for duplicate parameter values. |
| 400 | FunctionConflict | The feature configuration conflicts. Sites with version management enabled cannot configure this feature. | The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first. |
| 400 | RuleRegexQuotaCheckFailed | When configuring rules, rules with regular expressions are not allowed in this plan. Please check the relevant documentation of the plan or upgrade the plan. | The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan. |
| 400 | NestedRuleQuotaCheckFailed | The nesting level of rules allowed by the plan failed to be verified. Please modify the nesting level of rules or upgrade the plan. | The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan. |
| 400 | ArgQuotaCheckFailed | The passed-in parameter value failed to verify the validity of the plan. Please check the plan document to obtain the range of parameters that can be configured for the site plan. | The current plan does not support the configuration of restricted parameters, please check the input parameters. |
| 400 | FunctionQuotaCheckFailed | The quota verification for this function fails. It may be that the configuration of this function exceeds the limit of the site plan. Please check the plan introduction document corresponding to this site. | The current plan does not support the configuration of restricted functions, please check the plan related function description. |
| 400 | ConfExceedLimit | The number of function configurations exceeds the limit. Please check the interface document to see the number of configurations that can be supported by a single function. | The number of configuration items for the current function has exceeded the upper limit set by the system. |
| 400 | ServiceInvokeFailed | The call to the internal service failed. The engineer is resolving the problem. Please wait a moment before trying, or contact customer service for details. | Failed to call the service. Please try again later or contact customer service for details. |
| 400 | SpecifiedVersionReadOnly | The specified version number is read-only and cannot be modified. | The specified version number is read-only and cannot be modified. |
| 400 | VersionNotValid | The site does not have version management enabled, or the version number passed in does not exist. | The site does not have version management enabled, or the version number passed in does not exist. |
| 400 | InternalException | Failed to call the service. Try again later or contact technical support. | Failed to call the service. Try again later or contact technical support. |
| 400 | InvalidParameter.ArgName | Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation. | Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation. |
| 400 | InvalidParameter.ArgValue | Invalid parameter value. Check whether the value format and length meet the requirements. | Invalid parameter value. Check whether the value format and length meet the requirements. |
| 400 | InvalidParameter.Configs | Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements. | Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements. |
| 400 | InstanceNotExist | The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account. | The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account. |
| 400 | LockFailed | The system is handling requests you previously submitted. Try again later. | The system is handling requests you previously submitted. Try again later. |
| 400 | Instance.NotOnline | Your plan is unavailable due to an overdue payment. Complete the payment first. | Your plan is unavailable due to an overdue payment. Complete the payment first. |
| 400 | IllegalOperation.VersionManagement | The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again. | The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again. |
| 400 | QuotaCheckFailed.VersionManagement | Insufficient quota for version management. Contact technical support. | Insufficient quota for version management. Contact technical support. |
| 400 | FunctionArgError | Failed to check the configured function parameters. | Failed to check the configured function parameters |
| 404 | SiteNotFound | The website does not exist or does not belong to you. | The website does not exist or does not belong to you. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.