Modifies the basic HTTPS configuration of a website, including TLS versions, cipher suites, OCSP stapling, and HTTP/2 and HTTP/3 settings.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| SiteId |
integer |
Yes |
The site ID. You can call the ListSites operation to obtain the site ID. |
1231231221**** |
| ConfigId |
integer |
Yes |
The configuration ID. |
3528160969**** |
| RuleName |
string |
No |
The rule name. This parameter is not required when you add a global configuration. |
rule_example |
| RuleEnable |
string |
No |
Indicates whether the rule is enabled. This parameter is not required when you add a global configuration. Valid values:
|
on |
| Rule |
string |
No |
The conditional expression used to match incoming requests. This parameter is not required when you add a global configuration. Use cases:
|
(http.host eq \"video.example.com\") |
| Https |
string |
No |
Indicates whether HTTPS is enabled. Default value:
|
on |
| Tls10 |
string |
No |
Indicates whether TLS 1.0 is enabled. Default value:
|
on |
| Tls11 |
string |
No |
Indicates whether TLS 1.1 is enabled. Default value:
|
on |
| Tls12 |
string |
No |
Indicates whether TLS 1.2 is enabled. Default value:
|
on |
| Tls13 |
string |
No |
Indicates whether TLS 1.3 is enabled. Default value:
|
on |
| CiphersuiteGroup |
string |
No |
The cipher suite group. Default value:
|
all |
| Ciphersuite |
string |
No |
The custom cipher suite to use when |
TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256 |
| OcspStapling |
string |
No |
Indicates whether OCSP stapling is enabled. Default value:
|
on |
| Http2 |
string |
No |
Indicates whether HTTP/2 is enabled. Default value:
|
on |
| Http3 |
string |
No |
Indicates whether HTTP/3 is enabled. Default value:
|
on |
| Sequence |
integer |
No |
The rule execution order. A smaller value indicates a higher priority. |
1 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response data. |
||
| RequestId |
string |
The request ID. |
0AEDAF20-4DDF-4165-8750-47FF9C1929C9 |
Examples
Success response
JSON format
{
"RequestId": "0AEDAF20-4DDF-4165-8750-47FF9C1929C9"
}
Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 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 | 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 | 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 | 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 | 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 | 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 | InvalidConfigId | The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction. | The ConfigId does not exist. |
| 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 | QuotaCheckFailed.FunctionArg | The specified feature parameter is not allowed in your plan, or the feature parameter configurations have reached the upper limit in your plan. | The specified feature parameter is not allowed in your plan, or the feature parameter configurations have reached the upper limit in your plan. |
| 400 | QuotaCheckFailed.Function | The feature is unavailable in your plan. Upgrade the plan or contact your account manager to request the feature. | The feature is unavailable in your plan. Upgrade the plan or contact your account manager to request the feature. |
| 400 | MissingParameter | The specified ArgName is required for this function. | When configuring a specific function, the required parameter is missing. |
| 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.